public interface QueryResultOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
Page |
getCurrentPage()
The current [Page][google.cloud.dialogflow.cx.v3.Page].
|
PageOrBuilder |
getCurrentPageOrBuilder()
The current [Page][google.cloud.dialogflow.cx.v3.Page].
|
com.google.protobuf.Struct |
getDiagnosticInfo()
The free-form diagnostic info.
|
com.google.protobuf.StructOrBuilder |
getDiagnosticInfoOrBuilder()
The free-form diagnostic info.
|
DtmfInput |
getDtmf()
If a [DTMF][DTMFInput] was provided as input, this field will contain
a copy of the [DTMFInput][].
|
DtmfInputOrBuilder |
getDtmfOrBuilder()
If a [DTMF][DTMFInput] was provided as input, this field will contain
a copy of the [DTMFInput][].
|
Intent |
getIntent()
Deprecated.
google.cloud.dialogflow.cx.v3.QueryResult.intent is deprecated. See
google/cloud/dialogflow/cx/v3/session.proto;l=604
|
float |
getIntentDetectionConfidence()
Deprecated.
google.cloud.dialogflow.cx.v3.QueryResult.intent_detection_confidence is
deprecated. See google/cloud/dialogflow/cx/v3/session.proto;l=613
|
IntentOrBuilder |
getIntentOrBuilder()
Deprecated.
|
String |
getLanguageCode()
The language that was triggered during intent detection.
|
com.google.protobuf.ByteString |
getLanguageCodeBytes()
The language that was triggered during intent detection.
|
Match |
getMatch()
Intent match result, could be an intent or an event.
|
MatchOrBuilder |
getMatchOrBuilder()
Intent match result, could be an intent or an event.
|
com.google.protobuf.Struct |
getParameters()
The collected [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].
|
com.google.protobuf.StructOrBuilder |
getParametersOrBuilder()
The collected [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].
|
QueryResult.QueryCase |
getQueryCase() |
ResponseMessage |
getResponseMessages(int index)
The list of rich messages returned to the client.
|
int |
getResponseMessagesCount()
The list of rich messages returned to the client.
|
List<ResponseMessage> |
getResponseMessagesList()
The list of rich messages returned to the client.
|
ResponseMessageOrBuilder |
getResponseMessagesOrBuilder(int index)
The list of rich messages returned to the client.
|
List<? extends ResponseMessageOrBuilder> |
getResponseMessagesOrBuilderList()
The list of rich messages returned to the client.
|
SentimentAnalysisResult |
getSentimentAnalysisResult()
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.
|
SentimentAnalysisResultOrBuilder |
getSentimentAnalysisResultOrBuilder()
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.
|
String |
getText()
If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was provided as input, this field
will contain a copy of the text.
|
com.google.protobuf.ByteString |
getTextBytes()
If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was provided as input, this field
will contain a copy of the text.
|
String |
getTranscript()
If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input,
this field will contain the transcript for the audio.
|
com.google.protobuf.ByteString |
getTranscriptBytes()
If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input,
this field will contain the transcript for the audio.
|
String |
getTriggerEvent()
If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as input, this field will contain
the name of the event.
|
com.google.protobuf.ByteString |
getTriggerEventBytes()
If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as input, this field will contain
the name of the event.
|
String |
getTriggerIntent()
If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as input, this field will
contain a copy of the intent identifier.
|
com.google.protobuf.ByteString |
getTriggerIntentBytes()
If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as input, this field will
contain a copy of the intent identifier.
|
com.google.protobuf.Struct |
getWebhookPayloads(int index)
The list of webhook payload in [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.WebhookResponse.payload], in
the order of call sequence.
|
int |
getWebhookPayloadsCount()
The list of webhook payload in [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.WebhookResponse.payload], in
the order of call sequence.
|
List<com.google.protobuf.Struct> |
getWebhookPayloadsList()
The list of webhook payload in [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.WebhookResponse.payload], in
the order of call sequence.
|
com.google.protobuf.StructOrBuilder |
getWebhookPayloadsOrBuilder(int index)
The list of webhook payload in [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.WebhookResponse.payload], in
the order of call sequence.
|
List<? extends com.google.protobuf.StructOrBuilder> |
getWebhookPayloadsOrBuilderList()
The list of webhook payload in [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.WebhookResponse.payload], in
the order of call sequence.
|
com.google.rpc.Status |
getWebhookStatuses(int index)
The list of webhook call status in the order of call sequence.
|
int |
getWebhookStatusesCount()
The list of webhook call status in the order of call sequence.
|
List<com.google.rpc.Status> |
getWebhookStatusesList()
The list of webhook call status in the order of call sequence.
|
com.google.rpc.StatusOrBuilder |
getWebhookStatusesOrBuilder(int index)
The list of webhook call status in the order of call sequence.
|
List<? extends com.google.rpc.StatusOrBuilder> |
getWebhookStatusesOrBuilderList()
The list of webhook call status in the order of call sequence.
|
boolean |
hasCurrentPage()
The current [Page][google.cloud.dialogflow.cx.v3.Page].
|
boolean |
hasDiagnosticInfo()
The free-form diagnostic info.
|
boolean |
hasDtmf()
If a [DTMF][DTMFInput] was provided as input, this field will contain
a copy of the [DTMFInput][].
|
boolean |
hasIntent()
Deprecated.
google.cloud.dialogflow.cx.v3.QueryResult.intent is deprecated. See
google/cloud/dialogflow/cx/v3/session.proto;l=604
|
boolean |
hasMatch()
Intent match result, could be an intent or an event.
|
boolean |
hasParameters()
The collected [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].
|
boolean |
hasSentimentAnalysisResult()
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.
|
boolean |
hasText()
If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was provided as input, this field
will contain a copy of the text.
|
boolean |
hasTranscript()
If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input,
this field will contain the transcript for the audio.
|
boolean |
hasTriggerEvent()
If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as input, this field will contain
the name of the event.
|
boolean |
hasTriggerIntent()
If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as input, this field will
contain a copy of the intent identifier.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofboolean hasText()
If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was provided as input, this field will contain a copy of the text.
string text = 1;String getText()
If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was provided as input, this field will contain a copy of the text.
string text = 1;com.google.protobuf.ByteString getTextBytes()
If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was provided as input, this field will contain a copy of the text.
string text = 1;boolean hasTriggerIntent()
If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] 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>`.
string trigger_intent = 11 [(.google.api.resource_reference) = { ... }String getTriggerIntent()
If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] 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>`.
string trigger_intent = 11 [(.google.api.resource_reference) = { ... }com.google.protobuf.ByteString getTriggerIntentBytes()
If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] 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>`.
string trigger_intent = 11 [(.google.api.resource_reference) = { ... }boolean hasTranscript()
If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.
string transcript = 12;String getTranscript()
If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.
string transcript = 12;com.google.protobuf.ByteString getTranscriptBytes()
If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.
string transcript = 12;boolean hasTriggerEvent()
If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as input, this field will contain the name of the event.
string trigger_event = 14;String getTriggerEvent()
If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as input, this field will contain the name of the event.
string trigger_event = 14;com.google.protobuf.ByteString getTriggerEventBytes()
If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as input, this field will contain the name of the event.
string trigger_event = 14;boolean hasDtmf()
If a [DTMF][DTMFInput] was provided as input, this field will contain a copy of the [DTMFInput][].
.google.cloud.dialogflow.cx.v3.DtmfInput dtmf = 23;DtmfInput getDtmf()
If a [DTMF][DTMFInput] was provided as input, this field will contain a copy of the [DTMFInput][].
.google.cloud.dialogflow.cx.v3.DtmfInput dtmf = 23;DtmfInputOrBuilder getDtmfOrBuilder()
If a [DTMF][DTMFInput] was provided as input, this field will contain a copy of the [DTMFInput][].
.google.cloud.dialogflow.cx.v3.DtmfInput dtmf = 23;String getLanguageCode()
The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes.
string language_code = 2;com.google.protobuf.ByteString getLanguageCodeBytes()
The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes.
string language_code = 2;boolean hasParameters()
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.
.google.protobuf.Struct parameters = 3;com.google.protobuf.Struct getParameters()
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.
.google.protobuf.Struct parameters = 3;com.google.protobuf.StructOrBuilder getParametersOrBuilder()
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.
.google.protobuf.Struct parameters = 3;List<ResponseMessage> getResponseMessagesList()
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.
repeated .google.cloud.dialogflow.cx.v3.ResponseMessage response_messages = 4;ResponseMessage getResponseMessages(int index)
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.
repeated .google.cloud.dialogflow.cx.v3.ResponseMessage response_messages = 4;int getResponseMessagesCount()
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.
repeated .google.cloud.dialogflow.cx.v3.ResponseMessage response_messages = 4;List<? extends ResponseMessageOrBuilder> getResponseMessagesOrBuilderList()
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.
repeated .google.cloud.dialogflow.cx.v3.ResponseMessage response_messages = 4;ResponseMessageOrBuilder getResponseMessagesOrBuilder(int index)
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.
repeated .google.cloud.dialogflow.cx.v3.ResponseMessage response_messages = 4;List<com.google.rpc.Status> getWebhookStatusesList()
The list of webhook call status in the order of call sequence.
repeated .google.rpc.Status webhook_statuses = 13;com.google.rpc.Status getWebhookStatuses(int index)
The list of webhook call status in the order of call sequence.
repeated .google.rpc.Status webhook_statuses = 13;int getWebhookStatusesCount()
The list of webhook call status in the order of call sequence.
repeated .google.rpc.Status webhook_statuses = 13;List<? extends com.google.rpc.StatusOrBuilder> getWebhookStatusesOrBuilderList()
The list of webhook call status in the order of call sequence.
repeated .google.rpc.Status webhook_statuses = 13;com.google.rpc.StatusOrBuilder getWebhookStatusesOrBuilder(int index)
The list of webhook call status in the order of call sequence.
repeated .google.rpc.Status webhook_statuses = 13;List<com.google.protobuf.Struct> getWebhookPayloadsList()
The list of webhook payload in [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.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.
repeated .google.protobuf.Struct webhook_payloads = 6;com.google.protobuf.Struct getWebhookPayloads(int index)
The list of webhook payload in [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.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.
repeated .google.protobuf.Struct webhook_payloads = 6;int getWebhookPayloadsCount()
The list of webhook payload in [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.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.
repeated .google.protobuf.Struct webhook_payloads = 6;List<? extends com.google.protobuf.StructOrBuilder> getWebhookPayloadsOrBuilderList()
The list of webhook payload in [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.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.
repeated .google.protobuf.Struct webhook_payloads = 6;com.google.protobuf.StructOrBuilder getWebhookPayloadsOrBuilder(int index)
The list of webhook payload in [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.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.
repeated .google.protobuf.Struct webhook_payloads = 6;boolean hasCurrentPage()
The current [Page][google.cloud.dialogflow.cx.v3.Page]. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`.
.google.cloud.dialogflow.cx.v3.Page current_page = 7;Page getCurrentPage()
The current [Page][google.cloud.dialogflow.cx.v3.Page]. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`.
.google.cloud.dialogflow.cx.v3.Page current_page = 7;PageOrBuilder getCurrentPageOrBuilder()
The current [Page][google.cloud.dialogflow.cx.v3.Page]. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`.
.google.cloud.dialogflow.cx.v3.Page current_page = 7;@Deprecated boolean hasIntent()
The [Intent][google.cloud.dialogflow.cx.v3.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][google.cloud.dialogflow.cx.v3.QueryResult.match] instead.
.google.cloud.dialogflow.cx.v3.Intent intent = 8 [deprecated = true];@Deprecated Intent getIntent()
The [Intent][google.cloud.dialogflow.cx.v3.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][google.cloud.dialogflow.cx.v3.QueryResult.match] instead.
.google.cloud.dialogflow.cx.v3.Intent intent = 8 [deprecated = true];@Deprecated IntentOrBuilder getIntentOrBuilder()
The [Intent][google.cloud.dialogflow.cx.v3.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][google.cloud.dialogflow.cx.v3.QueryResult.match] instead.
.google.cloud.dialogflow.cx.v3.Intent intent = 8 [deprecated = true];@Deprecated float getIntentDetectionConfidence()
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][google.cloud.dialogflow.cx.v3.QueryResult.match] instead.
float intent_detection_confidence = 9 [deprecated = true];boolean hasMatch()
Intent match result, could be an intent or an event.
.google.cloud.dialogflow.cx.v3.Match match = 15;Match getMatch()
Intent match result, could be an intent or an event.
.google.cloud.dialogflow.cx.v3.Match match = 15;MatchOrBuilder getMatchOrBuilder()
Intent match result, could be an intent or an event.
.google.cloud.dialogflow.cx.v3.Match match = 15;boolean hasDiagnosticInfo()
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](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score.
.google.protobuf.Struct diagnostic_info = 10;com.google.protobuf.Struct getDiagnosticInfo()
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](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score.
.google.protobuf.Struct diagnostic_info = 10;com.google.protobuf.StructOrBuilder getDiagnosticInfoOrBuilder()
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](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score.
.google.protobuf.Struct diagnostic_info = 10;boolean hasSentimentAnalysisResult()
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.
.google.cloud.dialogflow.cx.v3.SentimentAnalysisResult sentiment_analysis_result = 17;
SentimentAnalysisResult getSentimentAnalysisResult()
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.
.google.cloud.dialogflow.cx.v3.SentimentAnalysisResult sentiment_analysis_result = 17;
SentimentAnalysisResultOrBuilder getSentimentAnalysisResultOrBuilder()
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.
.google.cloud.dialogflow.cx.v3.SentimentAnalysisResult sentiment_analysis_result = 17;
QueryResult.QueryCase getQueryCase()
Copyright © 2022 Google LLC. All rights reserved.