Class: Google::Cloud::Dialogflow::CX::V3::QueryResult

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

Represents the result of a conversational query.

Instance Attribute Summary collapse

Instance Attribute Details

#current_page ⇒ ::Google::Cloud::Dialogflow::CX::V3::Page

Returns The current Page. Some, not all fields are filled in this message, including but not limited to name and display_name.

Returns:



681
682
683
684
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 681

class QueryResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#diagnostic_info ⇒ ::Google::Protobuf::Struct

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


681
682
683
684
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 681

class QueryResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#dtmf ⇒ ::Google::Cloud::Dialogflow::CX::V3::DtmfInput

Returns If a DTMF was provided as input, this field will contain a copy of the DtmfInput.

Returns:



681
682
683
684
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 681

class QueryResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#intent ⇒ ::Google::Cloud::Dialogflow::CX::V3::Intent

Returns The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: name and display_name. This field is deprecated, please use QueryResult.match instead.

Returns:



681
682
683
684
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 681

class QueryResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#intent_detection_confidence ⇒ ::Float

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



681
682
683
684
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 681

class QueryResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#language_code ⇒ ::String

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



681
682
683
684
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 681

class QueryResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#match ⇒ ::Google::Cloud::Dialogflow::CX::V3::Match

Returns Intent match result, could be an intent or an event.

Returns:



681
682
683
684
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 681

class QueryResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parameters ⇒ ::Google::Protobuf::Struct

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


681
682
683
684
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 681

class QueryResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#response_messages ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>

Returns The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic.

Returns:



681
682
683
684
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 681

class QueryResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#sentiment_analysis_result ⇒ ::Google::Cloud::Dialogflow::CX::V3::SentimentAnalysisResult

Returns The sentiment analyss result, which depends on [analyze_query_text_sentiment] [google.cloud.dialogflow.cx.v3.QueryParameters.analyze_query_text_sentiment], specified in the request.

Returns:



681
682
683
684
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 681

class QueryResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#text ⇒ ::String

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



681
682
683
684
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 681

class QueryResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#transcript ⇒ ::String

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



681
682
683
684
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 681

class QueryResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#trigger_event ⇒ ::String

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



681
682
683
684
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 681

class QueryResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#trigger_intent ⇒ ::String

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



681
682
683
684
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 681

class QueryResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#webhook_payloads ⇒ ::Array<::Google::Protobuf::Struct>

Returns The list of webhook payload in WebhookResponse.payload, in the order of call sequence. If some webhook call fails or doesn't return any payload, an empty Struct would be used instead.

Returns:



681
682
683
684
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 681

class QueryResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#webhook_statuses ⇒ ::Array<::Google::Rpc::Status>

Returns The list of webhook call status in the order of call sequence.

Returns:



681
682
683
684
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 681

class QueryResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end