Finish Session

Mark a session as finished (closed) so it becomes eligible for evaluation

Overview

The finish() method marks a session as finished when its conversation is over. Finishing sets the session status to COMPLETED and closes it.

Finishing also makes the session eligible for evaluation right away. A Monitor scores only closed sessions, so an explicit finish gets the session picked up on the next scan instead of waiting for the product’s inactivity auto-close window.

Parameters

session_id · string · required

The ID of the session to finish.

stopping_reason · string

Free-text reason the conversation ended (for example GOAL_ACHIEVED). When omitted, the default FINISHED is sent, because the API requires a non-empty stopping reason.

Returns

Returns the finished Session object, with status COMPLETED.

Example

# Call finish when the conversation is over. This closes the session (status COMPLETED)
# and makes it eligible for monitor evaluation on the next scan.
galtea.sessions.finish(session_id=session.id, stopping_reason="GOAL_ACHIEVED")

To send the default stopping reason, omit the argument:

# Omit stopping_reason to send the default reason ("FINISHED"). The API requires a
# non-empty reason, so the SDK substitutes this token for you.
galtea.sessions.finish(session_id=session.id)

Notes

Only call finish() when the conversation is truly over. A finished session is closed, so a later attempt to append a trace follows the product’s closed-session policy. By default the trace is kept and the session reopens for a fresh score; the policy can also be set to drop the trace silently, or to reject it with an error. See Session.

To mark a session as failed instead of completed, use Update Session with status="FAILED" (for example galtea.sessions.update(session_id=..., status="FAILED", error="...")). Setting error alone records the message but leaves the session open.

Related Methods

• Create Session - Create a new session
• Update Session - Update a session’s fields
• Get Session - Retrieve a session
• List Sessions - List all sessions