Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::QueryResult (v0.18.0)

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

Represents the result of a conversational query.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#current_page

def current_page() -> ::Google::Cloud::Dialogflow::CX::V3::Page
Returns

#current_page=

def current_page=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Page
Parameter
Returns

#diagnostic_info

def diagnostic_info() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) —

    The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure.

    One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results:

    • The list is empty if no intent was matched to end-user input.
    • Only intents that are referenced in the currently active flow are included.
    • The matched intent is included.
    • Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of scope, are included.
    • Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score.

#diagnostic_info=

def diagnostic_info=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) —

    The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure.

    One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results:

    • The list is empty if no intent was matched to end-user input.
    • Only intents that are referenced in the currently active flow are included.
    • The matched intent is included.
    • Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of scope, are included.
    • Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score.
Returns
  • (::Google::Protobuf::Struct) —

    The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure.

    One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results:

    • The list is empty if no intent was matched to end-user input.
    • Only intents that are referenced in the currently active flow are included.
    • The matched intent is included.
    • Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of scope, are included.
    • Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score.

#dtmf

def dtmf() -> ::Google::Cloud::Dialogflow::CX::V3::DtmfInput
Returns

#dtmf=

def dtmf=(value) -> ::Google::Cloud::Dialogflow::CX::V3::DtmfInput
Parameter
Returns

#intent

def intent() -> ::Google::Cloud::Dialogflow::CX::V3::Intent
Returns

#intent=

def intent=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Intent
Parameter
Returns

#intent_detection_confidence

def intent_detection_confidence() -> ::Float
Returns
  • (::Float) — The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. This field is deprecated, please use QueryResult.match instead.

#intent_detection_confidence=

def intent_detection_confidence=(value) -> ::Float
Parameter
  • value (::Float) — The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. This field is deprecated, please use QueryResult.match instead.
Returns
  • (::Float) — The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. This field is deprecated, please use QueryResult.match instead.

#language_code

def language_code() -> ::String
Returns
  • (::String) — The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes.

#language_code=

def language_code=(value) -> ::String
Parameter
  • value (::String) — The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes.
Returns
  • (::String) — The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes.

#match

def match() -> ::Google::Cloud::Dialogflow::CX::V3::Match
Returns

#match=

def match=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Match
Parameter
Returns

#parameters

def parameters() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) —

    The collected [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].

    Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

    • MapKey type: string
    • MapKey value: parameter name
    • MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
    • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

#parameters=

def parameters=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) —

    The collected [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].

    Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

    • MapKey type: string
    • MapKey value: parameter name
    • MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
    • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
Returns
  • (::Google::Protobuf::Struct) —

    The collected [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].

    Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

    • MapKey type: string
    • MapKey value: parameter name
    • MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
    • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

#response_messages

def response_messages() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>
Returns

#response_messages=

def response_messages=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>
Parameter
Returns

#sentiment_analysis_result

def sentiment_analysis_result() -> ::Google::Cloud::Dialogflow::CX::V3::SentimentAnalysisResult
Returns

#sentiment_analysis_result=

def sentiment_analysis_result=(value) -> ::Google::Cloud::Dialogflow::CX::V3::SentimentAnalysisResult
Parameter
Returns

#text

def text() -> ::String
Returns
  • (::String) — If natural language text was provided as input, this field will contain a copy of the text.

#text=

def text=(value) -> ::String
Parameter
  • value (::String) — If natural language text was provided as input, this field will contain a copy of the text.
Returns
  • (::String) — If natural language text was provided as input, this field will contain a copy of the text.

#transcript

def transcript() -> ::String
Returns
  • (::String) — If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.

#transcript=

def transcript=(value) -> ::String
Parameter
  • value (::String) — If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.
Returns
  • (::String) — If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.

#trigger_event

def trigger_event() -> ::String
Returns
  • (::String) — If an event was provided as input, this field will contain the name of the event.

#trigger_event=

def trigger_event=(value) -> ::String
Parameter
  • value (::String) — If an event was provided as input, this field will contain the name of the event.
Returns
  • (::String) — If an event was provided as input, this field will contain the name of the event.

#trigger_intent

def trigger_intent() -> ::String
Returns
  • (::String) — If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

#trigger_intent=

def trigger_intent=(value) -> ::String
Parameter
  • value (::String) — If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.
Returns
  • (::String) — If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

#webhook_payloads

def webhook_payloads() -> ::Array<::Google::Protobuf::Struct>
Returns

#webhook_payloads=

def webhook_payloads=(value) -> ::Array<::Google::Protobuf::Struct>
Parameter
Returns

#webhook_statuses

def webhook_statuses() -> ::Array<::Google::Rpc::Status>
Returns

#webhook_statuses=

def webhook_statuses=(value) -> ::Array<::Google::Rpc::Status>
Parameter
  • value (::Array<::Google::Rpc::Status>) — The list of webhook call status in the order of call sequence.
Returns