Interface QueryResultOrBuilder (0.33.0) 

public interface QueryResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCurrentPage()

public abstract Page getCurrentPage()

The current 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;

Returns
Type Description
Page

The currentPage.

getCurrentPageOrBuilder()

public abstract PageOrBuilder getCurrentPageOrBuilder()

The current 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;

Returns
Type Description
PageOrBuilder

getDiagnosticInfo()

public abstract 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, 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;

Returns
Type Description
Struct

The diagnosticInfo.

getDiagnosticInfoOrBuilder()

public abstract 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, 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;

Returns
Type Description
StructOrBuilder

getDtmf()

public abstract DtmfInput getDtmf()

If a DTMF was provided as input, this field will contain a copy of the DtmfInput.

.google.cloud.dialogflow.cx.v3.DtmfInput dtmf = 23;

Returns
Type Description
DtmfInput

The dtmf.

getDtmfOrBuilder()

public abstract DtmfInputOrBuilder getDtmfOrBuilder()

If a DTMF was provided as input, this field will contain a copy of the DtmfInput.

.google.cloud.dialogflow.cx.v3.DtmfInput dtmf = 23;

Returns
Type Description
DtmfInputOrBuilder

getIntent() (deprecated)

public abstract Intent getIntent()

Deprecated. google.cloud.dialogflow.cx.v3.QueryResult.intent is deprecated. See google/cloud/dialogflow/cx/v3/session.proto;l=723

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.

.google.cloud.dialogflow.cx.v3.Intent intent = 8 [deprecated = true];

Returns
Type Description
Intent

The intent.

getIntentDetectionConfidence() (deprecated)

public abstract float getIntentDetectionConfidence()

Deprecated. google.cloud.dialogflow.cx.v3.QueryResult.intent_detection_confidence is deprecated. See google/cloud/dialogflow/cx/v3/session.proto;l=734

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.

float intent_detection_confidence = 9 [deprecated = true];

Returns
Type Description
float

The intentDetectionConfidence.

getIntentOrBuilder()

public abstract IntentOrBuilder getIntentOrBuilder()

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.

.google.cloud.dialogflow.cx.v3.Intent intent = 8 [deprecated = true];

Returns
Type Description
IntentOrBuilder

getLanguageCode()

public abstract String getLanguageCode()

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

string language_code = 2;

Returns
Type Description
String

The languageCode.

getLanguageCodeBytes()

public abstract ByteString getLanguageCodeBytes()

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

string language_code = 2;

Returns
Type Description
ByteString

The bytes for languageCode.

getMatch()

public abstract Match getMatch()

Intent match result, could be an intent or an event.

.google.cloud.dialogflow.cx.v3.Match match = 15;

Returns
Type Description
Match

The match.

getMatchOrBuilder()

public abstract MatchOrBuilder getMatchOrBuilder()

Intent match result, could be an intent or an event.

.google.cloud.dialogflow.cx.v3.Match match = 15;

Returns
Type Description
MatchOrBuilder

getParameters()

public abstract Struct getParameters()

The collected session 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;

Returns
Type Description
Struct

The parameters.

getParametersOrBuilder()

public abstract StructOrBuilder getParametersOrBuilder()

The collected session 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;

Returns
Type Description
StructOrBuilder

getQueryCase()

public abstract QueryResult.QueryCase getQueryCase()
Returns
Type Description
QueryResult.QueryCase

getResponseMessages(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
ResponseMessage

getResponseMessagesCount()

public abstract 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;

Returns
Type Description
int

getResponseMessagesList()

public abstract 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;

Returns
Type Description
List<ResponseMessage>

getResponseMessagesOrBuilder(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
ResponseMessageOrBuilder

getResponseMessagesOrBuilderList()

public abstract 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;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3.ResponseMessageOrBuilder>

getSentimentAnalysisResult()

public abstract 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;

Returns
Type Description
SentimentAnalysisResult

The sentimentAnalysisResult.

getSentimentAnalysisResultOrBuilder()

public abstract 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;

Returns
Type Description
SentimentAnalysisResultOrBuilder

getText()

public abstract String getText()

If natural language text was provided as input, this field will contain a copy of the text.

string text = 1;

Returns
Type Description
String

The text.

getTextBytes()

public abstract ByteString getTextBytes()

If natural language text was provided as input, this field will contain a copy of the text.

string text = 1;

Returns
Type Description
ByteString

The bytes for text.

getTranscript()

public abstract String getTranscript()

If natural language speech audio was provided as input, this field will contain the transcript for the audio.

string transcript = 12;

Returns
Type Description
String

The transcript.

getTranscriptBytes()

public abstract ByteString getTranscriptBytes()

If natural language speech audio was provided as input, this field will contain the transcript for the audio.

string transcript = 12;

Returns
Type Description
ByteString

The bytes for transcript.

getTriggerEvent()

public abstract String getTriggerEvent()

If an event was provided as input, this field will contain the name of the event.

string trigger_event = 14;

Returns
Type Description
String

The triggerEvent.

getTriggerEventBytes()

public abstract ByteString getTriggerEventBytes()

If an event was provided as input, this field will contain the name of the event.

string trigger_event = 14;

Returns
Type Description
ByteString

The bytes for triggerEvent.

getTriggerIntent()

public abstract String getTriggerIntent()

If an intent 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) = { ... }

Returns
Type Description
String

The triggerIntent.

getTriggerIntentBytes()

public abstract ByteString getTriggerIntentBytes()

If an intent 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) = { ... }

Returns
Type Description
ByteString

The bytes for triggerIntent.

getWebhookPayloads(int index)

public abstract Struct getWebhookPayloads(int index)

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.

repeated .google.protobuf.Struct webhook_payloads = 6;

Parameter
Name Description
index int
Returns
Type Description
Struct

getWebhookPayloadsCount()

public abstract int getWebhookPayloadsCount()

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.

repeated .google.protobuf.Struct webhook_payloads = 6;

Returns
Type Description
int

getWebhookPayloadsList()

public abstract List<Struct> getWebhookPayloadsList()

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.

repeated .google.protobuf.Struct webhook_payloads = 6;

Returns
Type Description
List<Struct>

getWebhookPayloadsOrBuilder(int index)

public abstract StructOrBuilder getWebhookPayloadsOrBuilder(int index)

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.

repeated .google.protobuf.Struct webhook_payloads = 6;

Parameter
Name Description
index int
Returns
Type Description
StructOrBuilder

getWebhookPayloadsOrBuilderList()

public abstract List<? extends StructOrBuilder> getWebhookPayloadsOrBuilderList()

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.

repeated .google.protobuf.Struct webhook_payloads = 6;

Returns
Type Description
List<? extends com.google.protobuf.StructOrBuilder>

getWebhookStatuses(int index)

public abstract Status getWebhookStatuses(int index)

The list of webhook call status in the order of call sequence.

repeated .google.rpc.Status webhook_statuses = 13;

Parameter
Name Description
index int
Returns
Type Description
com.google.rpc.Status

getWebhookStatusesCount()

public abstract int getWebhookStatusesCount()

The list of webhook call status in the order of call sequence.

repeated .google.rpc.Status webhook_statuses = 13;

Returns
Type Description
int

getWebhookStatusesList()

public abstract List<Status> getWebhookStatusesList()

The list of webhook call status in the order of call sequence.

repeated .google.rpc.Status webhook_statuses = 13;

Returns
Type Description
List<com.google.rpc.Status>

getWebhookStatusesOrBuilder(int index)

public abstract StatusOrBuilder getWebhookStatusesOrBuilder(int index)

The list of webhook call status in the order of call sequence.

repeated .google.rpc.Status webhook_statuses = 13;

Parameter
Name Description
index int
Returns
Type Description
com.google.rpc.StatusOrBuilder

getWebhookStatusesOrBuilderList()

public abstract List<? extends StatusOrBuilder> getWebhookStatusesOrBuilderList()

The list of webhook call status in the order of call sequence.

repeated .google.rpc.Status webhook_statuses = 13;

Returns
Type Description
List<? extends com.google.rpc.StatusOrBuilder>

hasCurrentPage()

public abstract boolean hasCurrentPage()

The current 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;

Returns
Type Description
boolean

Whether the currentPage field is set.

hasDiagnosticInfo()

public abstract 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, 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;

Returns
Type Description
boolean

Whether the diagnosticInfo field is set.

hasDtmf()

public abstract boolean hasDtmf()

If a DTMF was provided as input, this field will contain a copy of the DtmfInput.

.google.cloud.dialogflow.cx.v3.DtmfInput dtmf = 23;

Returns
Type Description
boolean

Whether the dtmf field is set.

hasIntent() (deprecated)

public abstract boolean hasIntent()

Deprecated. google.cloud.dialogflow.cx.v3.QueryResult.intent is deprecated. See google/cloud/dialogflow/cx/v3/session.proto;l=723

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.

.google.cloud.dialogflow.cx.v3.Intent intent = 8 [deprecated = true];

Returns
Type Description
boolean

Whether the intent field is set.

hasMatch()

public abstract boolean hasMatch()

Intent match result, could be an intent or an event.

.google.cloud.dialogflow.cx.v3.Match match = 15;

Returns
Type Description
boolean

Whether the match field is set.

hasParameters()

public abstract boolean hasParameters()

The collected session 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;

Returns
Type Description
boolean

Whether the parameters field is set.

hasSentimentAnalysisResult()

public abstract 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;

Returns
Type Description
boolean

Whether the sentimentAnalysisResult field is set.

hasText()

public abstract boolean hasText()

If natural language text was provided as input, this field will contain a copy of the text.

string text = 1;

Returns
Type Description
boolean

Whether the text field is set.

hasTranscript()

public abstract boolean hasTranscript()

If natural language speech audio was provided as input, this field will contain the transcript for the audio.

string transcript = 12;

Returns
Type Description
boolean

Whether the transcript field is set.

hasTriggerEvent()

public abstract boolean hasTriggerEvent()

If an event was provided as input, this field will contain the name of the event.

string trigger_event = 14;

Returns
Type Description
boolean

Whether the triggerEvent field is set.

hasTriggerIntent()

public abstract boolean hasTriggerIntent()

If an intent 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) = { ... }

Returns
Type Description
boolean

Whether the triggerIntent field is set.