- 0.66.0 (latest)
- 0.65.0
- 0.64.0
- 0.63.0
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.7
- 0.13.1
- 0.12.1
- 0.11.5
public final class QueryResult extends GeneratedMessageV3 implements QueryResultOrBuilderRepresents the result of a conversational query.
Protobuf type google.cloud.dialogflow.cx.v3beta1.QueryResult
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > QueryResultImplements
QueryResultOrBuilderStatic Fields
ADVANCED_SETTINGS_FIELD_NUMBER
public static final int ADVANCED_SETTINGS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ALLOW_ANSWER_FEEDBACK_FIELD_NUMBER
public static final int ALLOW_ANSWER_FEEDBACK_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CURRENT_FLOW_FIELD_NUMBER
public static final int CURRENT_FLOW_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CURRENT_PAGE_FIELD_NUMBER
public static final int CURRENT_PAGE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DATA_STORE_CONNECTION_SIGNALS_FIELD_NUMBER
public static final int DATA_STORE_CONNECTION_SIGNALS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DIAGNOSTIC_INFO_FIELD_NUMBER
public static final int DIAGNOSTIC_INFO_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DTMF_FIELD_NUMBER
public static final int DTMF_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
GENERATIVE_INFO_FIELD_NUMBER
public static final int GENERATIVE_INFO_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
INTENT_DETECTION_CONFIDENCE_FIELD_NUMBER
public static final int INTENT_DETECTION_CONFIDENCE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
INTENT_FIELD_NUMBER
public static final int INTENT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LANGUAGE_CODE_FIELD_NUMBER
public static final int LANGUAGE_CODE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
MATCH_FIELD_NUMBER
public static final int MATCH_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PARAMETERS_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RESPONSE_MESSAGES_FIELD_NUMBER
public static final int RESPONSE_MESSAGES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SENTIMENT_ANALYSIS_RESULT_FIELD_NUMBER
public static final int SENTIMENT_ANALYSIS_RESULT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TEXT_FIELD_NUMBER
public static final int TEXT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TRANSCRIPT_FIELD_NUMBER
public static final int TRANSCRIPT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TRIGGER_EVENT_FIELD_NUMBER
public static final int TRIGGER_EVENT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TRIGGER_INTENT_FIELD_NUMBER
public static final int TRIGGER_INTENT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
WEBHOOK_DISPLAY_NAMES_FIELD_NUMBER
public static final int WEBHOOK_DISPLAY_NAMES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
WEBHOOK_IDS_FIELD_NUMBER
public static final int WEBHOOK_IDS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
WEBHOOK_LATENCIES_FIELD_NUMBER
public static final int WEBHOOK_LATENCIES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
WEBHOOK_PAYLOADS_FIELD_NUMBER
public static final int WEBHOOK_PAYLOADS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
WEBHOOK_STATUSES_FIELD_NUMBER
public static final int WEBHOOK_STATUSES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
WEBHOOK_TAGS_FIELD_NUMBER
public static final int WEBHOOK_TAGS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static QueryResult getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
QueryResult |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static QueryResult.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
QueryResult.Builder |
|
newBuilder(QueryResult prototype)
public static QueryResult.Builder newBuilder(QueryResult prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
QueryResult |
| Returns | |
|---|---|
| Type | Description |
QueryResult.Builder |
|
parseDelimitedFrom(InputStream input)
public static QueryResult parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
QueryResult |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static QueryResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
QueryResult |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static QueryResult parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
QueryResult |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static QueryResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
QueryResult |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static QueryResult parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
QueryResult |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QueryResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
QueryResult |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static QueryResult parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
QueryResult |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static QueryResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
QueryResult |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static QueryResult parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
QueryResult |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static QueryResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
QueryResult |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static QueryResult parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
QueryResult |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static QueryResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
QueryResult |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<QueryResult> parser()| Returns | |
|---|---|
| Type | Description |
Parser<QueryResult> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAdvancedSettings()
public AdvancedSettings getAdvancedSettings()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.
.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 21;
| Returns | |
|---|---|
| Type | Description |
AdvancedSettings |
The advancedSettings. |
getAdvancedSettingsOrBuilder()
public AdvancedSettingsOrBuilder getAdvancedSettingsOrBuilder()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.
.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 21;
| Returns | |
|---|---|
| Type | Description |
AdvancedSettingsOrBuilder |
|
getAllowAnswerFeedback()
public boolean getAllowAnswerFeedback()Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.
bool allow_answer_feedback = 32;
| Returns | |
|---|---|
| Type | Description |
boolean |
The allowAnswerFeedback. |
getCurrentFlow()
public Flow getCurrentFlow() The current Flow. Some, not all
fields are filled in this message, including but not limited to name and
display_name.
.google.cloud.dialogflow.cx.v3beta1.Flow current_flow = 31;
| Returns | |
|---|---|
| Type | Description |
Flow |
The currentFlow. |
getCurrentFlowOrBuilder()
public FlowOrBuilder getCurrentFlowOrBuilder() The current Flow. Some, not all
fields are filled in this message, including but not limited to name and
display_name.
.google.cloud.dialogflow.cx.v3beta1.Flow current_flow = 31;
| Returns | |
|---|---|
| Type | Description |
FlowOrBuilder |
|
getCurrentPage()
public 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.v3beta1.Page current_page = 7;
| Returns | |
|---|---|
| Type | Description |
Page |
The currentPage. |
getCurrentPageOrBuilder()
public 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.v3beta1.Page current_page = 7;
| Returns | |
|---|---|
| Type | Description |
PageOrBuilder |
|
getDataStoreConnectionSignals()
public DataStoreConnectionSignals getDataStoreConnectionSignals()Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request.
.google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals data_store_connection_signals = 35 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataStoreConnectionSignals |
The dataStoreConnectionSignals. |
getDataStoreConnectionSignalsOrBuilder()
public DataStoreConnectionSignalsOrBuilder getDataStoreConnectionSignalsOrBuilder()Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request.
.google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals data_store_connection_signals = 35 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataStoreConnectionSignalsOrBuilder |
|
getDefaultInstanceForType()
public QueryResult getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
QueryResult |
|
getDiagnosticInfo()
public 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 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 DtmfInput getDtmf()If a DTMF was provided as input, this field will contain a copy of the DtmfInput.
.google.cloud.dialogflow.cx.v3beta1.DtmfInput dtmf = 23;
| Returns | |
|---|---|
| Type | Description |
DtmfInput |
The dtmf. |
getDtmfOrBuilder()
public DtmfInputOrBuilder getDtmfOrBuilder()If a DTMF was provided as input, this field will contain a copy of the DtmfInput.
.google.cloud.dialogflow.cx.v3beta1.DtmfInput dtmf = 23;
| Returns | |
|---|---|
| Type | Description |
DtmfInputOrBuilder |
|
getGenerativeInfo()
public GenerativeInfo getGenerativeInfo()The information of a query if handled by generative agent resources.
.google.cloud.dialogflow.cx.v3beta1.GenerativeInfo generative_info = 33;
| Returns | |
|---|---|
| Type | Description |
GenerativeInfo |
The generativeInfo. |
getGenerativeInfoOrBuilder()
public GenerativeInfoOrBuilder getGenerativeInfoOrBuilder()The information of a query if handled by generative agent resources.
.google.cloud.dialogflow.cx.v3beta1.GenerativeInfo generative_info = 33;
| Returns | |
|---|---|
| Type | Description |
GenerativeInfoOrBuilder |
|
getIntent() (deprecated)
public Intent getIntent()Deprecated. google.cloud.dialogflow.cx.v3beta1.QueryResult.intent is deprecated. See google/cloud/dialogflow/cx/v3beta1/session.proto;l=1003
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.v3beta1.Intent intent = 8 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
Intent |
The intent. |
getIntentDetectionConfidence() (deprecated)
public float getIntentDetectionConfidence()Deprecated. google.cloud.dialogflow.cx.v3beta1.QueryResult.intent_detection_confidence is deprecated. See google/cloud/dialogflow/cx/v3beta1/session.proto;l=1014
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() (deprecated)
public 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.v3beta1.Intent intent = 8 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
IntentOrBuilder |
|
getLanguageCode()
public 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 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 Match getMatch()Intent match result, could be an intent or an event.
.google.cloud.dialogflow.cx.v3beta1.Match match = 15;
| Returns | |
|---|---|
| Type | Description |
Match |
The match. |
getMatchOrBuilder()
public MatchOrBuilder getMatchOrBuilder()Intent match result, could be an intent or an event.
.google.cloud.dialogflow.cx.v3beta1.Match match = 15;
| Returns | |
|---|---|
| Type | Description |
MatchOrBuilder |
|
getParameters()
public 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 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 |
|
getParserForType()
public Parser<QueryResult> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<QueryResult> |
|
getQueryCase()
public QueryResult.QueryCase getQueryCase()| Returns | |
|---|---|
| Type | Description |
QueryResult.QueryCase |
|
getResponseMessages(int index)
public 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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ResponseMessage |
|
getResponseMessagesCount()
public 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;
| Returns | |
|---|---|
| Type | Description |
int |
|
getResponseMessagesList()
public 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.v3beta1.ResponseMessage response_messages = 4;
| Returns | |
|---|---|
| Type | Description |
List<ResponseMessage> |
|
getResponseMessagesOrBuilder(int index)
public 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.v3beta1.ResponseMessage response_messages = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ResponseMessageOrBuilder |
|
getResponseMessagesOrBuilderList()
public 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.v3beta1.ResponseMessage response_messages = 4;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.dialogflow.cx.v3beta1.ResponseMessageOrBuilder> |
|
getSentimentAnalysisResult()
public 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;
| Returns | |
|---|---|
| Type | Description |
SentimentAnalysisResult |
The sentimentAnalysisResult. |
getSentimentAnalysisResultOrBuilder()
public SentimentAnalysisResultOrBuilder getSentimentAnalysisResultOrBuilder() 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;
| Returns | |
|---|---|
| Type | Description |
SentimentAnalysisResultOrBuilder |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
getText()
public 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 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 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 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 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 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 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 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. |
getWebhookDisplayNames(int index)
public String getWebhookDisplayNames(int index)The list of webhook display names in the order of call sequence.
repeated string webhook_display_names = 26;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The webhookDisplayNames at the given index. |
getWebhookDisplayNamesBytes(int index)
public ByteString getWebhookDisplayNamesBytes(int index)The list of webhook display names in the order of call sequence.
repeated string webhook_display_names = 26;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the webhookDisplayNames at the given index. |
getWebhookDisplayNamesCount()
public int getWebhookDisplayNamesCount()The list of webhook display names in the order of call sequence.
repeated string webhook_display_names = 26;
| Returns | |
|---|---|
| Type | Description |
int |
The count of webhookDisplayNames. |
getWebhookDisplayNamesList()
public ProtocolStringList getWebhookDisplayNamesList()The list of webhook display names in the order of call sequence.
repeated string webhook_display_names = 26;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the webhookDisplayNames. |
getWebhookIds(int index)
public String getWebhookIds(int index)The list of webhook ids in the order of call sequence.
repeated string webhook_ids = 25;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The webhookIds at the given index. |
getWebhookIdsBytes(int index)
public ByteString getWebhookIdsBytes(int index)The list of webhook ids in the order of call sequence.
repeated string webhook_ids = 25;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the webhookIds at the given index. |
getWebhookIdsCount()
public int getWebhookIdsCount()The list of webhook ids in the order of call sequence.
repeated string webhook_ids = 25;
| Returns | |
|---|---|
| Type | Description |
int |
The count of webhookIds. |
getWebhookIdsList()
public ProtocolStringList getWebhookIdsList()The list of webhook ids in the order of call sequence.
repeated string webhook_ids = 25;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the webhookIds. |
getWebhookLatencies(int index)
public Duration getWebhookLatencies(int index)The list of webhook latencies in the order of call sequence.
repeated .google.protobuf.Duration webhook_latencies = 27;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Duration |
|
getWebhookLatenciesCount()
public int getWebhookLatenciesCount()The list of webhook latencies in the order of call sequence.
repeated .google.protobuf.Duration webhook_latencies = 27;
| Returns | |
|---|---|
| Type | Description |
int |
|
getWebhookLatenciesList()
public List<Duration> getWebhookLatenciesList()The list of webhook latencies in the order of call sequence.
repeated .google.protobuf.Duration webhook_latencies = 27;
| Returns | |
|---|---|
| Type | Description |
List<Duration> |
|
getWebhookLatenciesOrBuilder(int index)
public DurationOrBuilder getWebhookLatenciesOrBuilder(int index)The list of webhook latencies in the order of call sequence.
repeated .google.protobuf.Duration webhook_latencies = 27;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getWebhookLatenciesOrBuilderList()
public List<? extends DurationOrBuilder> getWebhookLatenciesOrBuilderList()The list of webhook latencies in the order of call sequence.
repeated .google.protobuf.Duration webhook_latencies = 27;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.protobuf.DurationOrBuilder> |
|
getWebhookPayloads(int index)
public 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 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 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 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 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 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 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 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 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 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> |
|
getWebhookTags(int index)
public String getWebhookTags(int index)The list of webhook tags in the order of call sequence.
repeated string webhook_tags = 29;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The webhookTags at the given index. |
getWebhookTagsBytes(int index)
public ByteString getWebhookTagsBytes(int index)The list of webhook tags in the order of call sequence.
repeated string webhook_tags = 29;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the webhookTags at the given index. |
getWebhookTagsCount()
public int getWebhookTagsCount()The list of webhook tags in the order of call sequence.
repeated string webhook_tags = 29;
| Returns | |
|---|---|
| Type | Description |
int |
The count of webhookTags. |
getWebhookTagsList()
public ProtocolStringList getWebhookTagsList()The list of webhook tags in the order of call sequence.
repeated string webhook_tags = 29;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the webhookTags. |
hasAdvancedSettings()
public boolean hasAdvancedSettings()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.
.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 21;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the advancedSettings field is set. |
hasCurrentFlow()
public boolean hasCurrentFlow() The current Flow. Some, not all
fields are filled in this message, including but not limited to name and
display_name.
.google.cloud.dialogflow.cx.v3beta1.Flow current_flow = 31;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the currentFlow field is set. |
hasCurrentPage()
public 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.v3beta1.Page current_page = 7;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the currentPage field is set. |
hasDataStoreConnectionSignals()
public boolean hasDataStoreConnectionSignals()Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request.
.google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals data_store_connection_signals = 35 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the dataStoreConnectionSignals field is set. |
hasDiagnosticInfo()
public 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 boolean hasDtmf()If a DTMF was provided as input, this field will contain a copy of the DtmfInput.
.google.cloud.dialogflow.cx.v3beta1.DtmfInput dtmf = 23;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the dtmf field is set. |
hasGenerativeInfo()
public boolean hasGenerativeInfo()The information of a query if handled by generative agent resources.
.google.cloud.dialogflow.cx.v3beta1.GenerativeInfo generative_info = 33;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the generativeInfo field is set. |
hasIntent() (deprecated)
public boolean hasIntent()Deprecated. google.cloud.dialogflow.cx.v3beta1.QueryResult.intent is deprecated. See google/cloud/dialogflow/cx/v3beta1/session.proto;l=1003
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.v3beta1.Intent intent = 8 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the intent field is set. |
hasMatch()
public boolean hasMatch()Intent match result, could be an intent or an event.
.google.cloud.dialogflow.cx.v3beta1.Match match = 15;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the match field is set. |
hasParameters()
public 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 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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the sentimentAnalysisResult field is set. |
hasText()
public 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 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 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 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. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public QueryResult.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
QueryResult.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected QueryResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
QueryResult.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public QueryResult.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
QueryResult.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|