Google Cloud Dialogflow v2 API - Class QueryResult (4.24.0) 

public sealed class QueryResult : IMessage<QueryResult>, IEquatable<QueryResult>, IDeepCloneable<QueryResult>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Dialogflow v2 API class QueryResult.

Represents the result of conversational query or event processing.

Inheritance

object > QueryResult

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

QueryResult()

public QueryResult()

QueryResult(QueryResult)

public QueryResult(QueryResult other)
Parameter
Name Description
other QueryResult

Properties

Action

public string Action { get; set; }

The action name from the matched intent.

Property Value
Type Description
string

AllRequiredParamsPresent

public bool AllRequiredParamsPresent { get; set; }

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.
Property Value
Type Description
bool

CancelsSlotFilling

public bool CancelsSlotFilling { get; set; }

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

Property Value
Type Description
bool

DiagnosticInfo

public Struct DiagnosticInfo { get; set; }

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
Property Value
Type Description
Struct

FulfillmentMessages

public RepeatedField<Intent.Types.Message> FulfillmentMessages { get; }

The collection of rich messages to present to the user.

Property Value
Type Description
RepeatedFieldIntentTypesMessage

FulfillmentText

public string FulfillmentText { get; set; }

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

Property Value
Type Description
string

Intent

public Intent Intent { get; set; }

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.

Property Value
Type Description
Intent

IntentDetectionConfidence

public float IntentDetectionConfidence { get; set; }

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.

Property Value
Type Description
float

LanguageCode

public string LanguageCode { get; set; }

The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes.

Property Value
Type Description
string

OutputContexts

public RepeatedField<Context> OutputContexts { get; }

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.

Property Value
Type Description
RepeatedFieldContext

Parameters

public Struct Parameters { get; set; }

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.
Property Value
Type Description
Struct

QueryText

public string QueryText { get; set; }

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.
Property Value
Type Description
string

SentimentAnalysisResult

public SentimentAnalysisResult SentimentAnalysisResult { get; set; }

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

Property Value
Type Description
SentimentAnalysisResult

SpeechRecognitionConfidence

public float SpeechRecognitionConfidence { get; set; }

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.

Property Value
Type Description
float

WebhookPayload

public Struct WebhookPayload { get; set; }

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.

Property Value
Type Description
Struct

WebhookSource

public string WebhookSource { get; set; }

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.

Property Value
Type Description
string