Reference documentation and code samples for the Google Cloud Ces V1 Client class SessionConfig.
The configuration for the session.
Generated from protobuf message google.cloud.ces.v1.SessionConfig
Namespace
Google \ Cloud \ Ces \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ session
string
Required. The unique identifier of the session. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
↳ input_audio_config
↳ output_audio_config
↳ historical_contexts
array< Message
>
Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
↳ entry_agent
string
Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent
of the app. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
↳ deployment
string
Optional. The deployment of the app to use for the session. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
↳ time_zone
string
Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings. The format is the IANA Time Zone Database time zone, e.g. "America/Los_Angeles".
↳ use_tool_fakes
bool
Optional. Whether to use tool fakes for the session. If this field is set, the agent will attempt use tool fakes instead of calling the real tools.
↳ remote_dialogflow_query_parameters
SessionConfig\RemoteDialogflowQueryParameters
Optional. QueryParameters to send to the remote Dialogflow agent when the session control is transferred to the remote agent.
↳ enable_text_streaming
bool
Optional. Whether to enable streaming text outputs from the model. By default, text outputs from the model are collected before sending to the client. NOTE: This is only supported for text (non-voice) sessions via StreamRunSession or BidiRunSession .
getSession
Required. The unique identifier of the session.
Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
string
setSession
Required. The unique identifier of the session.
Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
var
string
$this
getInputAudioConfig
Optional. Configuration for processing the input audio.
hasInputAudioConfig
clearInputAudioConfig
setInputAudioConfig
Optional. Configuration for processing the input audio.
$this
getOutputAudioConfig
Optional. Configuration for generating the output audio.
hasOutputAudioConfig
clearOutputAudioConfig
setOutputAudioConfig
Optional. Configuration for generating the output audio.
$this
getHistoricalContexts
Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
setHistoricalContexts
Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state.
$this
getEntryAgent
Optional. The entry agent to handle the session. If not specified, the
session will be handled by the root
agent
of the app. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
string
setEntryAgent
Optional. The entry agent to handle the session. If not specified, the
session will be handled by the root
agent
of the app. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
var
string
$this
getDeployment
Optional. The deployment of the app to use for the session.
Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
string
setDeployment
Optional. The deployment of the app to use for the session.
Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
var
string
$this
getTimeZone
Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings.
The format is the IANA Time Zone Database time zone, e.g. "America/Los_Angeles".
string
setTimeZone
Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings.
The format is the IANA Time Zone Database time zone, e.g. "America/Los_Angeles".
var
string
$this
getUseToolFakes
Optional. Whether to use tool fakes for the session.
If this field is set, the agent will attempt use tool fakes instead of calling the real tools.
bool
setUseToolFakes
Optional. Whether to use tool fakes for the session.
If this field is set, the agent will attempt use tool fakes instead of calling the real tools.
var
bool
$this
getRemoteDialogflowQueryParameters
Optional.
QueryParameters to send to the remote Dialogflow agent when the session control is transferred to the remote agent.
hasRemoteDialogflowQueryParameters
clearRemoteDialogflowQueryParameters
setRemoteDialogflowQueryParameters
Optional.
QueryParameters to send to the remote Dialogflow agent when the session control is transferred to the remote agent.
$this
getEnableTextStreaming
Optional. Whether to enable streaming text outputs from the model.
By default, text outputs from the model are collected before sending to the client. NOTE: This is only supported for text (non-voice) sessions via StreamRunSession or BidiRunSession .
bool
setEnableTextStreaming
Optional. Whether to enable streaming text outputs from the model.
By default, text outputs from the model are collected before sending to the client. NOTE: This is only supported for text (non-voice) sessions via StreamRunSession or BidiRunSession .
var
bool
$this
