Reference documentation and code samples for the Google Cloud Ces V1 Client class SessionOutput.
Output for the session.
Generated from protobuf message google.cloud.ces.v1.SessionOutput
Namespace
Google \ Cloud \ Ces \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ text
string
Output text from the CES agent.
↳ audio
string
Output audio from the CES agent.
↳ tool_calls
↳ citations
↳ google_search_suggestions
GoogleSearchSuggestions
The suggestions returned from Google Search as a result of invoking the GoogleSearchTool .
↳ end_session
↳ payload
↳ turn_index
int
Indicates the sequential order of conversation turn to which this output belongs to, starting from 1.
↳ turn_completed
bool
If true, the CES agent has detected the end of the current conversation turn and will provide no further output for this turn.
↳ diagnostic_info
SessionOutput\DiagnosticInfo
Optional. Diagnostic information contains execution details during the processing of the input. Only populated in the last SessionOutput (with turn_completed=true
) for each turn.
getText
Output text from the CES agent.
string
hasText
setText
Output text from the CES agent.
var
string
$this
getAudio
Output audio from the CES agent.
string
hasAudio
setAudio
Output audio from the CES agent.
var
string
$this
getToolCalls
Request for the client to execute the tools.
hasToolCalls
setToolCalls
Request for the client to execute the tools.
$this
getCitations
Citations that provide the source information for the agent's generated text.
hasCitations
setCitations
Citations that provide the source information for the agent's generated text.
$this
getGoogleSearchSuggestions
The suggestions returned from Google Search as a result of invoking the GoogleSearchTool .
hasGoogleSearchSuggestions
setGoogleSearchSuggestions
The suggestions returned from Google Search as a result of invoking the GoogleSearchTool .
$this
getEndSession
Indicates the session has ended.
hasEndSession
setEndSession
Indicates the session has ended.
$this
getPayload
Custom payload with structured output from the CES agent.
hasPayload
setPayload
Custom payload with structured output from the CES agent.
$this
getTurnIndex
Indicates the sequential order of conversation turn to which this output belongs to, starting from 1.
int
setTurnIndex
Indicates the sequential order of conversation turn to which this output belongs to, starting from 1.
var
int
$this
getTurnCompleted
If true, the CES agent has detected the end of the current conversation turn and will provide no further output for this turn.
bool
setTurnCompleted
If true, the CES agent has detected the end of the current conversation turn and will provide no further output for this turn.
var
bool
$this
getDiagnosticInfo
Optional. Diagnostic information contains execution details during the
processing of the input. Only populated in the last SessionOutput (with turn_completed=true
) for each turn.
hasDiagnosticInfo
clearDiagnosticInfo
setDiagnosticInfo
Optional. Diagnostic information contains execution details during the
processing of the input. Only populated in the last SessionOutput (with turn_completed=true
) for each turn.
$this
getOutputType
string
