Class QueryResult (1.37.0)

Version latest

• 1.37.0 (latest)
• 1.36.0
• 1.35.0
• 1.34.1
• 1.33.0
• 1.32.1
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.1
• 1.16.0
• 1.15.0
• 1.14.1
• 1.13.5
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.1
• 1.0.0
• 0.8.2
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.0
• 0.2.0
• 0.1.1

QueryResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents the result of a conversational query.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
text	str If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was provided as input, this field will contain a copy of the text. This field is a member of oneof_ query.
trigger_intent	str If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/. This field is a member of oneof_ query.
transcript	str If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio. This field is a member of oneof_ query.
trigger_event	str If an event was provided as input, this field will contain the name of the event. This field is a member of oneof_ query.
dtmf	google.cloud.dialogflowcx_v3.types.DtmfInput If a DTMF was provided as input, this field will contain a copy of the DtmfInput. This field is a member of oneof_ query.
language_code	str The language that was triggered during intent detection. See `Language Support
parameters	google.protobuf.struct_pb2.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	MutableSequence[google.cloud.dialogflowcx_v3.types.ResponseMessage] 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.
webhook_ids	MutableSequence[str] The list of webhook ids in the order of call sequence.
webhook_display_names	MutableSequence[str] The list of webhook display names in the order of call sequence.
webhook_latencies	MutableSequence[google.protobuf.duration_pb2.Duration] The list of webhook latencies in the order of call sequence.
webhook_tags	MutableSequence[str] The list of webhook tags in the order of call sequence.
webhook_statuses	MutableSequence[google.rpc.status_pb2.Status] The list of webhook call status in the order of call sequence.
webhook_payloads	MutableSequence[google.protobuf.struct_pb2.Struct] 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.
current_page	google.cloud.dialogflowcx_v3.types.Page The current Page. Some, not all fields are filled in this message, including but not limited to name and display_name.
current_flow	google.cloud.dialogflowcx_v3.types.Flow The current Flow. Some, not all fields are filled in this message, including but not limited to name and display_name.
intent	google.cloud.dialogflowcx_v3.types.Intent 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.
intent_detection_confidence	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.
match	google.cloud.dialogflowcx_v3.types.Match Intent match result, could be an intent or an event.
diagnostic_info	google.protobuf.struct_pb2.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.
sentiment_analysis_result	google.cloud.dialogflowcx_v3.types.SentimentAnalysisResult 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.
advanced_settings	google.cloud.dialogflowcx_v3.types.AdvancedSettings Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding.
allow_answer_feedback	bool Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.
data_store_connection_signals	google.cloud.dialogflowcx_v3.types.DataStoreConnectionSignals Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate_data_store_connection_signals is set to true in the request.