Class: Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/cx/v3/session.rb

Overview

The message returned from the DetectIntent method.

Defined Under Namespace

Modules: ResponseType

Instance Attribute Summary collapse

Instance Attribute Details

#allow_cancellation ⇒ ::Boolean

Returns 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.

Returns:

  • (::Boolean) —

    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.



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 156

class DetectIntentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents different DetectIntentResponse types.
  module ResponseType
    # Not specified. This should never happen.
    RESPONSE_TYPE_UNSPECIFIED = 0

    # Partial response. e.g. Aggregated responses in a Fulfillment that enables
    # `return_partial_response` can be returned as partial response.
    # WARNING: partial response is not eligible for barge-in.
    PARTIAL = 1

    # Final response.
    FINAL = 2
  end
end

#output_audio ⇒ ::String

Returns 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.

Returns:

  • (::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.



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 156

class DetectIntentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents different DetectIntentResponse types.
  module ResponseType
    # Not specified. This should never happen.
    RESPONSE_TYPE_UNSPECIFIED = 0

    # Partial response. e.g. Aggregated responses in a Fulfillment that enables
    # `return_partial_response` can be returned as partial response.
    # WARNING: partial response is not eligible for barge-in.
    PARTIAL = 1

    # Final response.
    FINAL = 2
  end
end

#output_audio_config ⇒ ::Google::Cloud::Dialogflow::CX::V3::OutputAudioConfig

Returns The config used by the speech synthesizer to generate the output audio.

Returns:



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 156

class DetectIntentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents different DetectIntentResponse types.
  module ResponseType
    # Not specified. This should never happen.
    RESPONSE_TYPE_UNSPECIFIED = 0

    # Partial response. e.g. Aggregated responses in a Fulfillment that enables
    # `return_partial_response` can be returned as partial response.
    # WARNING: partial response is not eligible for barge-in.
    PARTIAL = 1

    # Final response.
    FINAL = 2
  end
end

#query_result ⇒ ::Google::Cloud::Dialogflow::CX::V3::QueryResult

Returns The result of the conversational query.

Returns:



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 156

class DetectIntentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents different DetectIntentResponse types.
  module ResponseType
    # Not specified. This should never happen.
    RESPONSE_TYPE_UNSPECIFIED = 0

    # Partial response. e.g. Aggregated responses in a Fulfillment that enables
    # `return_partial_response` can be returned as partial response.
    # WARNING: partial response is not eligible for barge-in.
    PARTIAL = 1

    # Final response.
    FINAL = 2
  end
end

#response_id ⇒ ::String

Returns 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.

Returns:

  • (::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.



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 156

class DetectIntentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents different DetectIntentResponse types.
  module ResponseType
    # Not specified. This should never happen.
    RESPONSE_TYPE_UNSPECIFIED = 0

    # Partial response. e.g. Aggregated responses in a Fulfillment that enables
    # `return_partial_response` can be returned as partial response.
    # WARNING: partial response is not eligible for barge-in.
    PARTIAL = 1

    # Final response.
    FINAL = 2
  end
end

#response_type ⇒ ::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse::ResponseType

Returns Response type.

Returns:



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 156

class DetectIntentResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents different DetectIntentResponse types.
  module ResponseType
    # Not specified. This should never happen.
    RESPONSE_TYPE_UNSPECIFIED = 0

    # Partial response. e.g. Aggregated responses in a Fulfillment that enables
    # `return_partial_response` can be returned as partial response.
    # WARNING: partial response is not eligible for barge-in.
    PARTIAL = 1

    # Final response.
    FINAL = 2
  end
end