Class: Google::Apis::CesV1::SessionConfig

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/ces_v1/classes.rb,
lib/google/apis/ces_v1/representations.rb,
lib/google/apis/ces_v1/representations.rb

Overview

The configuration for the session.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SessionConfig

Returns a new instance of SessionConfig.



5870
5871
5872
 
# File 'lib/google/apis/ces_v1/classes.rb', line 5870

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#deployment ⇒ String

Optional. The deployment of the app to use for the session. Format: projects/ project/locations/location/apps/app/deployments/deployment` Corresponds to the JSON propertydeployment`

Returns:

  • (String) 


5807
5808
5809
 
# File 'lib/google/apis/ces_v1/classes.rb', line 5807

def deployment
  @deployment
end

#enable_text_streaming ⇒ Boolean Also known as: enable_text_streaming?

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. Corresponds to the JSON property enableTextStreaming

Returns:

  • (Boolean) 


5815
5816
5817
 
# File 'lib/google/apis/ces_v1/classes.rb', line 5815

def enable_text_streaming
  @enable_text_streaming
end

#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` Corresponds to the JSON propertyentryAgent`

Returns:

  • (String) 


5823
5824
5825
 
# File 'lib/google/apis/ces_v1/classes.rb', line 5823

def entry_agent
  @entry_agent
end

#historical_contexts ⇒ Array<Google::Apis::CesV1::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. Corresponds to the JSON property historicalContexts

Returns:



5832
5833
5834
 
# File 'lib/google/apis/ces_v1/classes.rb', line 5832

def historical_contexts
  @historical_contexts
end

#input_audio_config ⇒ Google::Apis::CesV1::InputAudioConfig

InputAudioConfig configures how the CES agent should interpret the incoming audio data. Corresponds to the JSON property inputAudioConfig

Returns:



5838
5839
5840
 
# File 'lib/google/apis/ces_v1/classes.rb', line 5838

def input_audio_config
  @input_audio_config
end

#output_audio_config ⇒ Google::Apis::CesV1::OutputAudioConfig

OutputAudioConfig configures how the CES agent should synthesize outgoing audio responses. Corresponds to the JSON property outputAudioConfig

Returns:



5844
5845
5846
 
# File 'lib/google/apis/ces_v1/classes.rb', line 5844

def output_audio_config
  @output_audio_config
end

#remote_dialogflow_query_parameters ⇒ Google::Apis::CesV1::SessionConfigRemoteDialogflowQueryParameters

QueryParameters to send to the remote Dialogflow agent when the session control is transferred to the remote agent. Corresponds to the JSON property remoteDialogflowQueryParameters

Returns:



5853
5854
5855
 
# File 'lib/google/apis/ces_v1/classes.rb', line 5853

def remote_dialogflow_query_parameters
  @remote_dialogflow_query_parameters
end

#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". Corresponds to the JSON property timeZone

Returns:

  • (String) 


5861
5862
5863
 
# File 'lib/google/apis/ces_v1/classes.rb', line 5861

def time_zone
  @time_zone
end

#use_tool_fakes ⇒ Boolean Also known as: use_tool_fakes?

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. Corresponds to the JSON property useToolFakes

Returns:

  • (Boolean) 


5867
5868
5869
 
# File 'lib/google/apis/ces_v1/classes.rb', line 5867

def use_tool_fakes
  @use_tool_fakes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
 
# File 'lib/google/apis/ces_v1/classes.rb', line 5875

def update!(**args)
  @deployment = args[:deployment] if args.key?(:deployment)
  @enable_text_streaming = args[:enable_text_streaming] if args.key?(:enable_text_streaming)
  @entry_agent = args[:entry_agent] if args.key?(:entry_agent)
  @historical_contexts = args[:historical_contexts] if args.key?(:historical_contexts)
  @input_audio_config = args[:input_audio_config] if args.key?(:input_audio_config)
  @output_audio_config = args[:output_audio_config] if args.key?(:output_audio_config)
  @remote_dialogflow_query_parameters = args[:remote_dialogflow_query_parameters] if args.key?(:remote_dialogflow_query_parameters)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
  @use_tool_fakes = args[:use_tool_fakes] if args.key?(:use_tool_fakes)
end