Class: Google::Cloud::Dialogflow::V2::QueryResult

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

Overview

Represents the result of conversational query or event processing.

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ ::String

Returns The action name from the matched intent.

Returns:

  • (::String) —

    The action name from the matched intent.



313
314
315
316
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 313

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

#all_required_params_present ⇒ ::Boolean

Returns This field is set to:

  • false if the matched intent has required parameters and not all of the required parameter values have been collected.
  • true if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters.

Returns:

  • (::Boolean) —

    This field is set to:

    • false if the matched intent has required parameters and not all of the required parameter values have been collected.
    • true if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters.


313
314
315
316
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 313

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

#cancels_slot_filling ⇒ ::Boolean

Returns Indicates whether the conversational query triggers a cancellation for slot filling. For more information, see the cancel slot filling documentation.

Returns:

  • (::Boolean) —

    Indicates whether the conversational query triggers a cancellation for slot filling. For more information, see the cancel slot filling documentation.



313
314
315
316
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 313

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

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

Returns Free-form diagnostic information for the associated detect intent request. The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain:

  • webhook call latency
  • webhook errors.

Returns:

  • (::Google::Protobuf::Struct) —

    Free-form diagnostic information for the associated detect intent request. The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain:

    • webhook call latency
    • webhook errors


313
314
315
316
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 313

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

#fulfillment_messages ⇒ ::Array<::Google::Cloud::Dialogflow::V2::Intent::Message>

Returns The collection of rich messages to present to the user.

Returns:



313
314
315
316
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 313

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

#fulfillment_text ⇒ ::String

Returns The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, fulfillment_messages should be preferred.

Returns:

  • (::String) —

    The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, fulfillment_messages should be preferred.



313
314
315
316
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 313

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

#intent ⇒ ::Google::Cloud::Dialogflow::V2::Intent

Returns The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: name, display_name, end_interaction and is_fallback.

Returns:

  • (::Google::Cloud::Dialogflow::V2::Intent) —

    The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: name, display_name, end_interaction and is_fallback.



313
314
315
316
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 313

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. If there are multiple knowledge_answers messages, this value is set to the greatest knowledgeAnswers.match_confidence value in the list.

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. If there are multiple knowledge_answers messages, this value is set to the greatest knowledgeAnswers.match_confidence value in the list.



313
314
315
316
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 313

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.



313
314
315
316
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 313

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

#output_contexts ⇒ ::Array<::Google::Cloud::Dialogflow::V2::Context>

Returns The collection of output contexts. If applicable, output_contexts.parameters contains entries with name <parameter name>.original containing the original parameter values before the query.

Returns:

  • (::Array<::Google::Cloud::Dialogflow::V2::Context>) —

    The collection of output contexts. If applicable, output_contexts.parameters contains entries with name <parameter name>.original containing the original parameter values before the query.



313
314
315
316
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 313

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

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

Returns The collection of extracted 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 collection of extracted 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.


313
314
315
316
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 313

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

#query_text ⇒ ::String

Returns The original conversational query text:

  • If natural language text was provided as input, query_text contains a copy of the input.
  • If natural language speech audio was provided as input, query_text contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked.
  • If automatic spell correction is enabled, query_text will contain the corrected user input.

Returns:

  • (::String) —

    The original conversational query text:

    • If natural language text was provided as input, query_text contains a copy of the input.
    • If natural language speech audio was provided as input, query_text contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked.
    • If automatic spell correction is enabled, query_text will contain the corrected user input.


313
314
315
316
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 313

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

#sentiment_analysis_result ⇒ ::Google::Cloud::Dialogflow::V2::SentimentAnalysisResult

Returns The sentiment analysis result, which depends on the sentiment_analysis_request_config specified in the request.

Returns:



313
314
315
316
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 313

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

#speech_recognition_confidence ⇒ ::Float

Returns The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set.

This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult.

Returns:

  • (::Float) —

    The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set.

    This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult.



313
314
315
316
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 313

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

#webhook_payload ⇒ ::Google::Protobuf::Struct

Returns If the query was fulfilled by a webhook call, this field is set to the value of the payload field returned in the webhook response.

Returns:

  • (::Google::Protobuf::Struct) —

    If the query was fulfilled by a webhook call, this field is set to the value of the payload field returned in the webhook response.



313
314
315
316
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 313

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

#webhook_source ⇒ ::String

Returns If the query was fulfilled by a webhook call, this field is set to the value of the source field returned in the webhook response.

Returns:

  • (::String) —

    If the query was fulfilled by a webhook call, this field is set to the value of the source field returned in the webhook response.



313
314
315
316
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 313

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