Gemini Enterprise for Customer Experience V1BETA API - Class Google::Cloud::Ces::V1beta::SessionConfig (v1.3.0)

Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1BETA API class Google::Cloud::Ces::V1beta::SessionConfig.

The configuration for the session.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#deployment

def deployment() -> ::String
Returns
  • (::String) — Optional. The deployment of the app to use for the session. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

#deployment=

def deployment=(value) -> ::String
Parameter
  • value (::String) — Optional. The deployment of the app to use for the session. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
Returns
  • (::String) — Optional. The deployment of the app to use for the session. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

#enable_text_streaming

def enable_text_streaming() -> ::Boolean
Returns
  • (::Boolean) — 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.

#enable_text_streaming=

def enable_text_streaming=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

Returns
  • (::Boolean) — 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.

#entry_agent

def entry_agent() -> ::String
Returns
  • (::String) — 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}

#entry_agent=

def entry_agent=(value) -> ::String
Parameter
  • value (::String) — 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}
Returns
  • (::String) — 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}

#exclude_diagnostic_info

def exclude_diagnostic_info() -> ::Boolean
Returns
  • (::Boolean) — Optional. Whether to exclude diagnostic info from the session output.

#exclude_diagnostic_info=

def exclude_diagnostic_info=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether to exclude diagnostic info from the session output.
Returns
  • (::Boolean) — Optional. Whether to exclude diagnostic info from the session output.

#historical_contexts

def historical_contexts() -> ::Array<::Google::Cloud::Ces::V1beta::Message>
Returns
  • (::Array<::Google::Cloud::Ces::V1beta::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.

#historical_contexts=

def historical_contexts=(value) -> ::Array<::Google::Cloud::Ces::V1beta::Message>
Parameter
  • value (::Array<::Google::Cloud::Ces::V1beta::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.
Returns
  • (::Array<::Google::Cloud::Ces::V1beta::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.

#include_llm_thought_summary

def include_llm_thought_summary() -> ::Boolean
Returns
  • (::Boolean) — Optional. Whether to include LLM thought summaries in the session outputs.

#include_llm_thought_summary=

def include_llm_thought_summary=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether to include LLM thought summaries in the session outputs.
Returns
  • (::Boolean) — Optional. Whether to include LLM thought summaries in the session outputs.

#include_progress_update

def include_progress_update() -> ::Boolean
Returns
  • (::Boolean) — Optional. Whether to include intermediate processing update to the client. If enabled, the update will be sent back in SessionOutput.progress.

#include_progress_update=

def include_progress_update=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether to include intermediate processing update to the client. If enabled, the update will be sent back in SessionOutput.progress.
Returns
  • (::Boolean) — Optional. Whether to include intermediate processing update to the client. If enabled, the update will be sent back in SessionOutput.progress.

#input_audio_config

def input_audio_config() -> ::Google::Cloud::Ces::V1beta::InputAudioConfig
Returns

#input_audio_config=

def input_audio_config=(value) -> ::Google::Cloud::Ces::V1beta::InputAudioConfig
Parameter
Returns

#output_audio_config

def output_audio_config() -> ::Google::Cloud::Ces::V1beta::OutputAudioConfig
Returns

#output_audio_config=

def output_audio_config=(value) -> ::Google::Cloud::Ces::V1beta::OutputAudioConfig
Parameter
Returns

#remote_dialogflow_query_parameters

def remote_dialogflow_query_parameters() -> ::Google::Cloud::Ces::V1beta::SessionConfig::RemoteDialogflowQueryParameters
Returns

#remote_dialogflow_query_parameters=

def remote_dialogflow_query_parameters=(value) -> ::Google::Cloud::Ces::V1beta::SessionConfig::RemoteDialogflowQueryParameters
Parameter
Returns

#session

def session() -> ::String
Returns
  • (::String) — Required. The unique identifier of the session. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}

#session=

def session=(value) -> ::String
Parameter
  • value (::String) — Required. The unique identifier of the session. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
Returns
  • (::String) — Required. The unique identifier of the session. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}

#time_zone

def time_zone() -> ::String
Returns
  • (::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".

#time_zone=

def time_zone=(value) -> ::String
Parameter
  • value (::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".

Returns
  • (::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

def use_tool_fakes() -> ::Boolean
Returns
  • (::Boolean) — 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.

#use_tool_fakes=

def use_tool_fakes=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.