Class QueryResult (1.12.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

NameDescription
text str
If [natural language text][google.cloud.dialogflow.cx.v3beta1.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/
transcript str
If [natural language speech audio][google.cloud.dialogflow.cx.v3beta1.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_v3beta1.types.DtmfInput
If a `DTMF][DTMFInput]` 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.v3beta1.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 Sequence[google.cloud.dialogflowcx_v3beta1.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_statuses Sequence[google.rpc.status_pb2.Status]
The list of webhook call status in the order of call sequence.
webhook_payloads Sequence[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_v3beta1.types.Page
The current Page. Some, not all fields are filled in this message, including but not limited to ``name`` and ``display_name``.
intent google.cloud.dialogflowcx_v3beta1.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_v3beta1.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
sentiment_analysis_result google.cloud.dialogflowcx_v3beta1.types.SentimentAnalysisResult
The sentiment analyss result, which depends on [``analyze_query_text_sentiment``] [google.cloud.dialogflow.cx.v3beta1.QueryParameters.analyze_query_text_sentiment], specified in the request.

Inheritance

builtins.object > proto.message.Message > QueryResult