Google Cloud Ces V1 Client - Class SessionConfig (0.1.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
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	InputAudioConfig Optional. Configuration for processing the input audio.
↳ output_audio_config	OutputAudioConfig Optional. Configuration for generating the output audio.
↳ 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}/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".
↳ 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.

getSession

Required. The unique identifier of the session.

Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}

Returns
Type	Description
string

setSession

Required. The unique identifier of the session.

Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getInputAudioConfig

Optional. Configuration for processing the input audio.

Returns
Type	Description
InputAudioConfig|null

hasInputAudioConfig

clearInputAudioConfig

setInputAudioConfig

Optional. Configuration for processing the input audio.

Parameter
Name	Description
var	InputAudioConfig

Returns
Type	Description
$this

getOutputAudioConfig

Optional. Configuration for generating the output audio.

Returns
Type	Description
OutputAudioConfig|null

hasOutputAudioConfig

clearOutputAudioConfig

setOutputAudioConfig

Optional. Configuration for generating the output audio.

Parameter
Name	Description
var	OutputAudioConfig

Returns
Type	Description
$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.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

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.

Parameter
Name	Description
var	array<Message>

Returns
Type	Description
$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}/agents/{agent}

Returns
Type	Description
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}/agents/{agent}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDeployment

Optional. The deployment of the app to use for the session.

Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

Returns
Type	Description
string

setDeployment

Optional. The deployment of the app to use for the session.

Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

Parameter
Name	Description
var	string

Returns
Type	Description
$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".

Returns
Type	Description
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".

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getRemoteDialogflowQueryParameters

Optional.

QueryParameters to send to the remote Dialogflow agent when the session control is transferred to the remote agent.

Returns
Type	Description
SessionConfig\RemoteDialogflowQueryParameters|null

hasRemoteDialogflowQueryParameters

clearRemoteDialogflowQueryParameters

setRemoteDialogflowQueryParameters

Optional.

QueryParameters to send to the remote Dialogflow agent when the session control is transferred to the remote agent.

Parameter
Name	Description
var	SessionConfig\RemoteDialogflowQueryParameters

Returns
Type	Description
$this