Class: Google::Apis::CesV1::SessionInput

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

Input for the session.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SessionInput

Returns a new instance of SessionInput.



6514
6515
6516
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6514

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

Instance Attribute Details

#audio ⇒ String

Optional. Audio data from the end user. Corresponds to the JSON property audio NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


6464
6465
6466
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6464

def audio
  @audio
end

#blob ⇒ Google::Apis::CesV1::Blob

Represents a blob input or output in the conversation. Corresponds to the JSON property blob

Returns:



6469
6470
6471
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6469

def blob
  @blob
end

#dtmf ⇒ String

Optional. DTMF digits from the end user. Corresponds to the JSON property dtmf

Returns:

  • (String) 


6474
6475
6476
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6474

def dtmf
  @dtmf
end

#event ⇒ Google::Apis::CesV1::Event

Event input. Corresponds to the JSON property event

Returns:



6479
6480
6481
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6479

def event
  @event
end

#image ⇒ Google::Apis::CesV1::Image

Represents an image input or output in the conversation. Corresponds to the JSON property image

Returns:



6484
6485
6486
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6484

def image
  @image
end

#text ⇒ String

Optional. Text data from the end user. Corresponds to the JSON property text

Returns:

  • (String) 


6489
6490
6491
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6489

def text
  @text
end

#tool_responses ⇒ Google::Apis::CesV1::ToolResponses

Execution results for the requested tool calls from the client. Corresponds to the JSON property toolResponses

Returns:



6494
6495
6496
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6494

def tool_responses
  @tool_responses
end

#variables ⇒ Hash<String,Object>

Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent. Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters. Corresponds to the JSON property variables

Returns:

  • (Hash<String,Object>) 


6501
6502
6503
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6501

def variables
  @variables
end

#will_continue ⇒ Boolean Also known as: will_continue?

Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When set to true, the agent defers processing until it receives a subsequent message where will_continue is false, or until the system detects an endpoint in the audio input. NOTE: This field does not apply to audio and DTMF inputs, as they are always processed automatically based on the endpointing signal. Corresponds to the JSON property willContinue

Returns:

  • (Boolean) 


6511
6512
6513
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6511

def will_continue
  @will_continue
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
 
# File 'lib/google/apis/ces_v1/classes.rb', line 6519

def update!(**args)
  @audio = args[:audio] if args.key?(:audio)
  @blob = args[:blob] if args.key?(:blob)
  @dtmf = args[:dtmf] if args.key?(:dtmf)
  @event = args[:event] if args.key?(:event)
  @image = args[:image] if args.key?(:image)
  @text = args[:text] if args.key?(:text)
  @tool_responses = args[:tool_responses] if args.key?(:tool_responses)
  @variables = args[:variables] if args.key?(:variables)
  @will_continue = args[:will_continue] if args.key?(:will_continue)
end