RunSessionResponse

Response message for SessionService.RunSession.

JSON representation 
{
  "outputs": [
    {
      object (SessionOutput)
    }
  ]
}
Fields
outputs[]

object (SessionOutput)

Outputs for the session.

SessionOutput

Output for the session.

JSON representation 
{
  "turnIndex": integer,
  "turnCompleted": boolean,
  "diagnosticInfo": {
    object (SessionOutput.DiagnosticInfo)
  },
  "context": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ],

  // Union field output_type can be only one of the following:
  "text": string,
  "audio": string,
  "toolCalls": {
    object (ToolCalls)
  },
  "citations": {
    object (Citations)
  },
  "googleSearchSuggestions": {
    object (GoogleSearchSuggestions)
  },
  "endSession": {
    object (EndSession)
  },
  "payload": {
    object
  }
  // End of list of possible types for union field output_type.
}
Fields
turnIndex

integer

Indicates the sequential order of conversation turn to which this output belongs to, starting from 1.
turnCompleted

boolean

If true, the CES agent has detected the end of the current conversation turn and will provide no further output for this turn.
diagnosticInfo

object (SessionOutput.DiagnosticInfo)

Optional. Diagnostic information contains execution details during the processing of the input. Only populated in the last SessionOutput (with turnCompleted=true) for each turn.
context[]

object

Context messages for external supervision guardrails.

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.
Union field output_type. The type of the output. output_type can be only one of the following:
text

string

Output text from the CES agent.
audio

string (bytes format)

Output audio from the CES agent.

A base64-encoded string.
toolCalls

object (ToolCalls)

Request for the client to execute the tools.
citations

object (Citations)

Citations that provide the source information for the agent's generated text.
googleSearchSuggestions

object (GoogleSearchSuggestions)

The suggestions returned from Google Search as a result of invoking the GoogleSearchTool.
endSession

object (EndSession)

Indicates the session has ended.
payload

object (Struct format)

Custom payload with structured output from the CES agent.

ToolCalls

Request for the client to execute the tools and return the execution results before continuing the session.

JSON representation 
{
  "toolCalls": [
    {
      object (ToolCall)
    }
  ]
}
Fields
toolCalls[]

object (ToolCall)

Optional. The list of tool calls to execute.

EndSession

Indicates the session has terminated, due to either successful completion (e.g. user says "Good bye!" ) or an agent escalation.

The agent will not process any further inputs after session is terminated and the client should half-close and disconnect after receiving all remaining responses from the agent.

JSON representation 
{
  "metadata": {
    object
  }
}
Fields
metadata

object (Struct format)

Optional. Provides additional information about the end session signal, such as the reason for ending the session.

SessionOutput.DiagnosticInfo

Contains execution details during the processing.

JSON representation 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "rootSpan": {
    object (Span)
  }
}
Fields
messages[]

object (Message)

List of the messages that happened during the processing.
rootSpan

object (Span)

A trace of the entire request processing, represented as a root span. This span can contain nested child spans for specific operations.