Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse (v0.23.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse.

The message returned from the DetectIntent method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#allow_cancellation

def allow_cancellation() -> ::Boolean
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.

#allow_cancellation=

def allow_cancellation=(value) -> ::Boolean
Parameter
  • value (::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.
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.

#output_audio

def output_audio() -> ::String
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.

#output_audio=

def output_audio=(value) -> ::String
Parameter
  • value (::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.

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.

#output_audio_config

def output_audio_config() -> ::Google::Cloud::Dialogflow::CX::V3::OutputAudioConfig
Returns

#output_audio_config=

def output_audio_config=(value) -> ::Google::Cloud::Dialogflow::CX::V3::OutputAudioConfig
Parameter
Returns

#query_result

def query_result() -> ::Google::Cloud::Dialogflow::CX::V3::QueryResult
Returns

#query_result=

def query_result=(value) -> ::Google::Cloud::Dialogflow::CX::V3::QueryResult
Parameter
Returns

#response_id

def response_id() -> ::String
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.

#response_id=

def response_id=(value) -> ::String
Parameter
  • value (::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.
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.

#response_type

def response_type() -> ::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse::ResponseType
Returns

#response_type=

def response_type=(value) -> ::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse::ResponseType
Parameter
Returns