/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dialogflow/cx/v3beta1/session.proto
package com.google.cloud.dialogflow.cx.v3beta1;
public interface QueryResultOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3beta1.QueryResult)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* If [natural language text][google.cloud.dialogflow.cx.v3beta1.TextInput]
* was provided as input, this field will contain a copy of the text.
*
*
* string text = 1;
*
* @return Whether the text field is set.
*/
boolean hasText();
/**
*
*
*
* If [natural language text][google.cloud.dialogflow.cx.v3beta1.TextInput]
* was provided as input, this field will contain a copy of the text.
*
*
* string text = 1;
*
* @return The text.
*/
java.lang.String getText();
/**
*
*
*
* If [natural language text][google.cloud.dialogflow.cx.v3beta1.TextInput]
* was provided as input, this field will contain a copy of the text.
*
*
* string text = 1;
*
* @return The bytes for text.
*/
com.google.protobuf.ByteString getTextBytes();
/**
*
*
*
* If an [intent][google.cloud.dialogflow.cx.v3beta1.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) = { ... }
*
* @return Whether the triggerIntent field is set.
*/
boolean hasTriggerIntent();
/**
*
*
*
* If an [intent][google.cloud.dialogflow.cx.v3beta1.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) = { ... }
*
* @return The triggerIntent.
*/
java.lang.String getTriggerIntent();
/**
*
*
*
* If an [intent][google.cloud.dialogflow.cx.v3beta1.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) = { ... }
*
* @return The bytes for triggerIntent.
*/
com.google.protobuf.ByteString getTriggerIntentBytes();
/**
*
*
*
* If [natural language speech
* audio][google.cloud.dialogflow.cx.v3beta1.AudioInput] was provided as
* input, this field will contain the transcript for the audio.
*
*
* string transcript = 12;
*
* @return Whether the transcript field is set.
*/
boolean hasTranscript();
/**
*
*
*
* If [natural language speech
* audio][google.cloud.dialogflow.cx.v3beta1.AudioInput] was provided as
* input, this field will contain the transcript for the audio.
*
*
* string transcript = 12;
*
* @return The transcript.
*/
java.lang.String getTranscript();
/**
*
*
*
* If [natural language speech
* audio][google.cloud.dialogflow.cx.v3beta1.AudioInput] was provided as
* input, this field will contain the transcript for the audio.
*
*
* string transcript = 12;
*
* @return The bytes for transcript.
*/
com.google.protobuf.ByteString getTranscriptBytes();
/**
*
*
*
* If an [event][google.cloud.dialogflow.cx.v3beta1.EventInput] was provided
* as input, this field will contain the name of the event.
*
*
* string trigger_event = 14;
*
* @return Whether the triggerEvent field is set.
*/
boolean hasTriggerEvent();
/**
*
*
*
* If an [event][google.cloud.dialogflow.cx.v3beta1.EventInput] was provided
* as input, this field will contain the name of the event.
*
*
* string trigger_event = 14;
*
* @return The triggerEvent.
*/
java.lang.String getTriggerEvent();
/**
*
*
*
* If an [event][google.cloud.dialogflow.cx.v3beta1.EventInput] was provided
* as input, this field will contain the name of the event.
*
*
* string trigger_event = 14;
*
* @return The bytes for triggerEvent.
*/
com.google.protobuf.ByteString getTriggerEventBytes();
/**
*
*
*
* If a [DTMF][google.cloud.dialogflow.cx.v3beta1.DtmfInput] was provided as
* input, this field will contain a copy of the
* [DtmfInput][google.cloud.dialogflow.cx.v3beta1.DtmfInput].
*
*
* .google.cloud.dialogflow.cx.v3beta1.DtmfInput dtmf = 23;
*
* @return Whether the dtmf field is set.
*/
boolean hasDtmf();
/**
*
*
*
* If a [DTMF][google.cloud.dialogflow.cx.v3beta1.DtmfInput] was provided as
* input, this field will contain a copy of the
* [DtmfInput][google.cloud.dialogflow.cx.v3beta1.DtmfInput].
*
*
* .google.cloud.dialogflow.cx.v3beta1.DtmfInput dtmf = 23;
*
* @return The dtmf.
*/
com.google.cloud.dialogflow.cx.v3beta1.DtmfInput getDtmf();
/**
*
*
*
* If a [DTMF][google.cloud.dialogflow.cx.v3beta1.DtmfInput] was provided as
* input, this field will contain a copy of the
* [DtmfInput][google.cloud.dialogflow.cx.v3beta1.DtmfInput].
*
*
* .google.cloud.dialogflow.cx.v3beta1.DtmfInput dtmf = 23;
*/
com.google.cloud.dialogflow.cx.v3beta1.DtmfInputOrBuilder getDtmfOrBuilder();
/**
*
*
*
* 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;
*
* @return The languageCode.
*/
java.lang.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;
*
* @return The bytes for languageCode.
*/
com.google.protobuf.ByteString getLanguageCodeBytes();
/**
*
*
*
* 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.
*
*
* .google.protobuf.Struct parameters = 3;
*
* @return Whether the parameters field is set.
*/
boolean hasParameters();
/**
*
*
*
* 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.
*
*
* .google.protobuf.Struct parameters = 3;
*
* @return The parameters.
*/
com.google.protobuf.Struct getParameters();
/**
*
*
*
* 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.
*
*
* .google.protobuf.Struct parameters = 3;
*/
com.google.protobuf.StructOrBuilder getParametersOrBuilder();
/**
*
*
*
* 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.v3beta1.ResponseMessage response_messages = 4;
*
*/
java.util.List 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.v3beta1.ResponseMessage response_messages = 4;
*
*/
com.google.cloud.dialogflow.cx.v3beta1.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.v3beta1.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.v3beta1.ResponseMessage response_messages = 4;
*
*/
java.util.List
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.v3beta1.ResponseMessage response_messages = 4;
*
*/
com.google.cloud.dialogflow.cx.v3beta1.ResponseMessageOrBuilder getResponseMessagesOrBuilder(
int index);
/**
*
*
*
* The list of webhook call status in the order of call sequence.
*
*
* repeated .google.rpc.Status webhook_statuses = 13;
*/
java.util.List 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;
*/
java.util.List 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 payload in
* [WebhookResponse.payload][google.cloud.dialogflow.cx.v3beta1.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;
*/
java.util.List getWebhookPayloadsList();
/**
*
*
*
* The list of webhook payload in
* [WebhookResponse.payload][google.cloud.dialogflow.cx.v3beta1.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.v3beta1.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.v3beta1.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;
*/
java.util.List getWebhookPayloadsOrBuilderList();
/**
*
*
*
* The list of webhook payload in
* [WebhookResponse.payload][google.cloud.dialogflow.cx.v3beta1.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 current [Page][google.cloud.dialogflow.cx.v3beta1.Page]. Some, not all
* fields are filled in this message, including but not limited to `name` and
* `display_name`.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Page current_page = 7;
*
* @return Whether the currentPage field is set.
*/
boolean hasCurrentPage();
/**
*
*
*
* The current [Page][google.cloud.dialogflow.cx.v3beta1.Page]. Some, not all
* fields are filled in this message, including but not limited to `name` and
* `display_name`.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Page current_page = 7;
*
* @return The currentPage.
*/
com.google.cloud.dialogflow.cx.v3beta1.Page getCurrentPage();
/**
*
*
*
* The current [Page][google.cloud.dialogflow.cx.v3beta1.Page]. Some, not all
* fields are filled in this message, including but not limited to `name` and
* `display_name`.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Page current_page = 7;
*/
com.google.cloud.dialogflow.cx.v3beta1.PageOrBuilder getCurrentPageOrBuilder();
/**
*
*
*
* The [Intent][google.cloud.dialogflow.cx.v3beta1.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.v3beta1.QueryResult.match]
* instead.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Intent intent = 8 [deprecated = true];
*
* @deprecated google.cloud.dialogflow.cx.v3beta1.QueryResult.intent is deprecated. See
* google/cloud/dialogflow/cx/v3beta1/session.proto;l=718
* @return Whether the intent field is set.
*/
@java.lang.Deprecated
boolean hasIntent();
/**
*
*
*
* The [Intent][google.cloud.dialogflow.cx.v3beta1.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.v3beta1.QueryResult.match]
* instead.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Intent intent = 8 [deprecated = true];
*
* @deprecated google.cloud.dialogflow.cx.v3beta1.QueryResult.intent is deprecated. See
* google/cloud/dialogflow/cx/v3beta1/session.proto;l=718
* @return The intent.
*/
@java.lang.Deprecated
com.google.cloud.dialogflow.cx.v3beta1.Intent getIntent();
/**
*
*
*
* The [Intent][google.cloud.dialogflow.cx.v3beta1.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.v3beta1.QueryResult.match]
* instead.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Intent intent = 8 [deprecated = true];
*/
@java.lang.Deprecated
com.google.cloud.dialogflow.cx.v3beta1.IntentOrBuilder getIntentOrBuilder();
/**
*
*
*
* 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.v3beta1.QueryResult.match]
* instead.
*
*
* float intent_detection_confidence = 9 [deprecated = true];
*
* @deprecated google.cloud.dialogflow.cx.v3beta1.QueryResult.intent_detection_confidence is
* deprecated. See google/cloud/dialogflow/cx/v3beta1/session.proto;l=729
* @return The intentDetectionConfidence.
*/
@java.lang.Deprecated
float getIntentDetectionConfidence();
/**
*
*
*
* Intent match result, could be an intent or an event.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Match match = 15;
*
* @return Whether the match field is set.
*/
boolean hasMatch();
/**
*
*
*
* Intent match result, could be an intent or an event.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Match match = 15;
*
* @return The match.
*/
com.google.cloud.dialogflow.cx.v3beta1.Match getMatch();
/**
*
*
*
* Intent match result, could be an intent or an event.
*
*
* .google.cloud.dialogflow.cx.v3beta1.Match match = 15;
*/
com.google.cloud.dialogflow.cx.v3beta1.MatchOrBuilder getMatchOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the diagnosticInfo field is set.
*/
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;
*
* @return The diagnosticInfo.
*/
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 sentiment analyss result, which depends on
* [`analyze_query_text_sentiment`]
* [google.cloud.dialogflow.cx.v3beta1.QueryParameters.analyze_query_text_sentiment],
* specified in the request.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.SentimentAnalysisResult sentiment_analysis_result = 17;
*
*
* @return Whether the sentimentAnalysisResult field is set.
*/
boolean hasSentimentAnalysisResult();
/**
*
*
*
* 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.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.SentimentAnalysisResult sentiment_analysis_result = 17;
*
*
* @return The sentimentAnalysisResult.
*/
com.google.cloud.dialogflow.cx.v3beta1.SentimentAnalysisResult getSentimentAnalysisResult();
/**
*
*
*
* 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.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.SentimentAnalysisResult sentiment_analysis_result = 17;
*
*/
com.google.cloud.dialogflow.cx.v3beta1.SentimentAnalysisResultOrBuilder
getSentimentAnalysisResultOrBuilder();
public com.google.cloud.dialogflow.cx.v3beta1.QueryResult.QueryCase getQueryCase();
}