Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentResponse

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

Overview

The message returned from the DetectIntent method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1DetectIntentResponse

Returns a new instance of GoogleCloudDialogflowV2beta1DetectIntentResponse



2015
2016
2017
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2015

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

Instance Attribute Details

#alternative_query_results ⇒ Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1QueryResult>

If Knowledge Connectors are enabled, there could be more than one result returned for a given query or event, and this field will contain all results except for the top one, which is captured in query_result. The alternative results are ordered by decreasing QueryResult.intent_detection_confidence. If Knowledge Connectors are disabled, this field will be empty until multiple responses for regular intents are supported, at which point those additional results will be surfaced here. Corresponds to the JSON property alternativeQueryResults

Returns:



1943
1944
1945
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1943

def alternative_query_results
  @alternative_query_results
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.fulfillment_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. Corresponds to the JSON property outputAudio NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


1954
1955
1956
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1954

def output_audio
  @output_audio
end

#output_audio_config ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1OutputAudioConfig

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

Returns:



1959
1960
1961
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1959

def output_audio_config
  @output_audio_config
end

#query_result ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1QueryResult

Represents the result of conversational query or event processing. Corresponds to the JSON property queryResult

Returns:



1964
1965
1966
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1964

def query_result
  @query_result
end

#response_id ⇒ String

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) 


1970
1971
1972
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1970

def response_id
  @response_id
end

#webhook_status ⇒ Google::Apis::DialogflowV2beta1::GoogleRpcStatus

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. The error model is designed to be:

  • Simple to use and understand for most users
  • Flexible enough to meet unexpected needs # Overview The Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions. # Language mapping The Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include:
  • Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
  • Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
  • Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
  • Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
  • Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. Corresponds to the JSON property webhookStatus

Returns:



2013
2014
2015
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2013

def webhook_status
  @webhook_status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2020
2021
2022
2023
2024
2025
2026
2027
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2020

def update!(**args)
  @alternative_query_results = args[:alternative_query_results] if args.key?(:alternative_query_results)
  @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)
  @webhook_status = args[:webhook_status] if args.key?(:webhook_status)
end