Class SessionConfig
The configuration for the session.
Implements
Inherited Members
Namespace: Google.Apis.CustomerEngagementSuite.v1beta.Data
Assembly: Google.Apis.CustomerEngagementSuite.v1beta.dll
Syntax
public class SessionConfig : IDirectResponseSchema
Properties
Deployment
Optional. The deployment of the app to use for the session. Format:
projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
Declaration
[JsonProperty("deployment")]
public virtual string Deployment { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
EnableTextStreaming
Optional. Whether to stream text output from the model to the client incrementally as it is generated.
Defaults to false. * When disabled, the model's text output is buffered, and each text output sent to the
client is a complete sentence. Clients can render each text output on a new line. * When enabled, each text
output may contain only part of a sentence. Clients should concatenate consecutive text outputs to render
the complete response. NOTE: This is only supported for text (non-voice) sessions using StreamRunSession or
BidiRunSession.
Declaration
[JsonProperty("enableTextStreaming")]
public virtual bool? EnableTextStreaming { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |
EntryAgent
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}
Declaration
[JsonProperty("entryAgent")]
public virtual string EntryAgent { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
ExcludeDiagnosticInfo
Optional. Whether to exclude diagnostic info from the session output.
Declaration
[JsonProperty("excludeDiagnosticInfo")]
public virtual bool? ExcludeDiagnosticInfo { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |
HistoricalContexts
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.
Declaration
[JsonProperty("historicalContexts")]
public virtual IList<Message> HistoricalContexts { get; set; }
Property Value
| Type | Description |
|---|---|
| IList<Message> |
IncludeLlmThoughtSummary
Optional. Whether to include LLM thought summaries in the session outputs.
Declaration
[JsonProperty("includeLlmThoughtSummary")]
public virtual bool? IncludeLlmThoughtSummary { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |
IncludeProgressUpdate
Optional. Whether to include intermediate processing update to the client. If enabled, the update will be sent back in SessionOutput.progress.
Declaration
[JsonProperty("includeProgressUpdate")]
public virtual bool? IncludeProgressUpdate { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |
InputAudioConfig
Optional. Configuration for processing the input audio.
Declaration
[JsonProperty("inputAudioConfig")]
public virtual InputAudioConfig InputAudioConfig { get; set; }
Property Value
| Type | Description |
|---|---|
| InputAudioConfig |
OutputAudioConfig
Optional. Configuration for generating the output audio.
Declaration
[JsonProperty("outputAudioConfig")]
public virtual OutputAudioConfig OutputAudioConfig { get; set; }
Property Value
| Type | Description |
|---|---|
| OutputAudioConfig |
RemoteDialogflowQueryParameters
Optional. QueryParameters to send to the remote Dialogflow agent when the session control is transferred to the remote agent.
Declaration
[JsonProperty("remoteDialogflowQueryParameters")]
public virtual SessionConfigRemoteDialogflowQueryParameters RemoteDialogflowQueryParameters { get; set; }
Property Value
| Type | Description |
|---|---|
| SessionConfigRemoteDialogflowQueryParameters |
TimeZone
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".
Declaration
[JsonProperty("timeZone")]
public virtual string TimeZone { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
UseToolFakes
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.
Declaration
[JsonProperty("useToolFakes")]
public virtual bool? UseToolFakes { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |