Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse

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

Overview

The message returned from the DetectIntent method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3DetectIntentResponse

Returns a new instance of GoogleCloudDialogflowCxV3DetectIntentResponse.



1834
1835
1836
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1834

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

Instance Attribute Details

#allow_cancellation ⇒ Boolean Also known as: allow_cancellation?

Indicates whether the partial response can be cancelled when a later response arrives. e.g. if the agent specified some music as partial response, it can be cancelled. Corresponds to the JSON property allowCancellation

Returns:

  • (Boolean) 


1797
1798
1799
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1797

def allow_cancellation
  @allow_cancellation
end

#output_audio ⇒ String

The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the query_result.response_messages field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content. Corresponds to the JSON property outputAudio NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


1811
1812
1813
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1811

def output_audio
  @output_audio
end

#output_audio_config ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3OutputAudioConfig

Instructs the speech synthesizer how to generate the output audio content. Corresponds to the JSON property outputAudioConfig

Returns:



1816
1817
1818
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1816

def output_audio_config
  @output_audio_config
end

#query_result ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3QueryResult

Represents the result of a conversational query. Corresponds to the JSON property queryResult

Returns:



1821
1822
1823
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1821

def query_result
  @query_result
end

#response_id ⇒ String

Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. Corresponds to the JSON property responseId

Returns:

  • (String) 


1827
1828
1829
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1827

def response_id
  @response_id
end

#response_type ⇒ String

Response type. Corresponds to the JSON property responseType

Returns:

  • (String) 


1832
1833
1834
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1832

def response_type
  @response_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1839
1840
1841
1842
1843
1844
1845
1846
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1839

def update!(**args)
  @allow_cancellation = args[:allow_cancellation] if args.key?(:allow_cancellation)
  @output_audio = args[:output_audio] if args.key?(:output_audio)
  @output_audio_config = args[:output_audio_config] if args.key?(:output_audio_config)
  @query_result = args[:query_result] if args.key?(:query_result)
  @response_id = args[:response_id] if args.key?(:response_id)
  @response_type = args[:response_type] if args.key?(:response_type)
end