Gemini Enterprise for Customer Experience v1beta API - Class SessionConfig (1.0.0-beta10) 

public sealed class SessionConfig : IMessage<SessionConfig>, IEquatable<SessionConfig>, IDeepCloneable<SessionConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Gemini Enterprise for Customer Experience v1beta API class SessionConfig.

The configuration for the session.

Inheritance

object > SessionConfig

Namespace

Google.Cloud.Ces.V1Beta

Assembly

Google.Cloud.Ces.V1Beta.dll

Constructors

SessionConfig()

public SessionConfig()

SessionConfig(SessionConfig)

public SessionConfig(SessionConfig other)
Parameter
Name Description
other SessionConfig

Properties

Deployment

public string Deployment { get; set; }

Optional. The deployment of the app to use for the session. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

Property Value
Type Description
string

EnableTextStreaming

public bool EnableTextStreaming { get; set; }

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][google.cloud.ces.v1beta.SessionService.StreamRunSession] or [BidiRunSession][google.cloud.ces.v1beta.SessionService.BidiRunSession].

Property Value
Type Description
bool

EntryAgent

public string EntryAgent { get; set; }

Optional. The entry agent to handle the session. If not specified, the session will be handled by the [root agent][google.cloud.ces.v1beta.App.root_agent] of the app. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

Property Value
Type Description
string

EntryAgentAsAgentName

public AgentName EntryAgentAsAgentName { get; set; }

AgentName-typed view over the EntryAgent resource name property.

Property Value
Type Description
AgentName

ExcludeDiagnosticInfo

public bool ExcludeDiagnosticInfo { get; set; }

Optional. Whether to exclude diagnostic info from the session output.

Property Value
Type Description
bool

HistoricalContexts

public RepeatedField<Message> HistoricalContexts { get; }

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.

Property Value
Type Description
RepeatedFieldMessage

IncludeLlmThoughtSummary

public bool IncludeLlmThoughtSummary { get; set; }

Optional. Whether to include LLM thought summaries in the session outputs.

Property Value
Type Description
bool

IncludeProgressUpdate

public bool IncludeProgressUpdate { get; set; }

Optional. Whether to include intermediate processing update to the client. If enabled, the update will be sent back in [SessionOutput.progress][google.cloud.ces.v1beta.SessionOutput.progress].

Property Value
Type Description
bool

InputAudioConfig

public InputAudioConfig InputAudioConfig { get; set; }

Optional. Configuration for processing the input audio.

Property Value
Type Description
InputAudioConfig

OutputAudioConfig

public OutputAudioConfig OutputAudioConfig { get; set; }

Optional. Configuration for generating the output audio.

Property Value
Type Description
OutputAudioConfig

RemoteDialogflowQueryParameters

public SessionConfig.Types.RemoteDialogflowQueryParameters RemoteDialogflowQueryParameters { get; set; }

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

Property Value
Type Description
SessionConfigTypesRemoteDialogflowQueryParameters

Session

public string Session { get; set; }

Required. The unique identifier of the session. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}

Property Value
Type Description
string

SessionAsSessionName

public SessionName SessionAsSessionName { get; set; }

SessionName-typed view over the Session resource name property.

Property Value
Type Description
SessionName

TimeZone

public string TimeZone { get; set; }

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".

Property Value
Type Description
string

UseToolFakes

public bool UseToolFakes { get; set; }

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.

Property Value
Type Description
bool