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.



970
971
972
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 970

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) 


933
934
935
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 933

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) 


947
948
949
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 947

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:



952
953
954
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 952

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:



957
958
959
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 957

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) 


963
964
965
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 963

def response_id
  @response_id
end

#response_type ⇒ String

Response type. Corresponds to the JSON property responseType

Returns:

  • (String) 


968
969
970
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 968

def response_type
  @response_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



975
976
977
978
979
980
981
982
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 975

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