com.google.cloud.dialogflow.v2.QueryResultOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dialogflow-v2 Show documentation
Show all versions of proto-google-cloud-dialogflow-v2 Show documentation
PROTO library for proto-google-cloud-dialogflow-v2
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dialogflow/v2/session.proto
package com.google.cloud.dialogflow.v2;
public interface QueryResultOrBuilder extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2.QueryResult)
com.google.protobuf.MessageOrBuilder {
/**
*
* The original conversational query text:
* - If natural language text was provided as input, `query_text` contains
* a copy of the input.
* - If natural language speech audio was provided as input, `query_text`
* contains the speech recognition result. If speech recognizer produced
* multiple alternatives, a particular one is picked.
* - If an event was provided as input, `query_text` is not set.
*
*
* string query_text = 1;
*/
java.lang.String getQueryText();
/**
*
* The original conversational query text:
* - If natural language text was provided as input, `query_text` contains
* a copy of the input.
* - If natural language speech audio was provided as input, `query_text`
* contains the speech recognition result. If speech recognizer produced
* multiple alternatives, a particular one is picked.
* - If an event was provided as input, `query_text` is not set.
*
*
* string query_text = 1;
*/
com.google.protobuf.ByteString
getQueryTextBytes();
/**
*
* The language that was triggered during intent detection.
* See [Language Support](https://dialogflow.com/docs/reference/language)
* for a list of the currently supported language codes.
*
*
* string language_code = 15;
*/
java.lang.String getLanguageCode();
/**
*
* The language that was triggered during intent detection.
* See [Language Support](https://dialogflow.com/docs/reference/language)
* for a list of the currently supported language codes.
*
*
* string language_code = 15;
*/
com.google.protobuf.ByteString
getLanguageCodeBytes();
/**
*
* The Speech recognition confidence between 0.0 and 1.0. A higher number
* indicates an estimated greater likelihood that the recognized words are
* correct. The default of 0.0 is a sentinel value indicating that confidence
* was not set.
* You should not rely on this field as it isn't guaranteed to be accurate, or
* even set. In particular this field isn't set in Webhook calls and for
* StreamingDetectIntent since the streaming endpoint has separate confidence
* estimates per portion of the audio in StreamingRecognitionResult.
*
*
* float speech_recognition_confidence = 2;
*/
float getSpeechRecognitionConfidence();
/**
*
* The action name from the matched intent.
*
*
* string action = 3;
*/
java.lang.String getAction();
/**
*
* The action name from the matched intent.
*
*
* string action = 3;
*/
com.google.protobuf.ByteString
getActionBytes();
/**
*
* The collection of extracted parameters.
*
*
* .google.protobuf.Struct parameters = 4;
*/
boolean hasParameters();
/**
*
* The collection of extracted parameters.
*
*
* .google.protobuf.Struct parameters = 4;
*/
com.google.protobuf.Struct getParameters();
/**
*
* The collection of extracted parameters.
*
*
* .google.protobuf.Struct parameters = 4;
*/
com.google.protobuf.StructOrBuilder getParametersOrBuilder();
/**
*
* This field is set to:
* - `false` if the matched intent has required parameters and not all of
* the required parameter values have been collected.
* - `true` if all required parameter values have been collected, or if the
* matched intent doesn't contain any required parameters.
*
*
* bool all_required_params_present = 5;
*/
boolean getAllRequiredParamsPresent();
/**
*
* The text to be pronounced to the user or shown on the screen.
*
*
* string fulfillment_text = 6;
*/
java.lang.String getFulfillmentText();
/**
*
* The text to be pronounced to the user or shown on the screen.
*
*
* string fulfillment_text = 6;
*/
com.google.protobuf.ByteString
getFulfillmentTextBytes();
/**
*
* The collection of rich messages to present to the user.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
*/
java.util.List
getFulfillmentMessagesList();
/**
*
* The collection of rich messages to present to the user.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
*/
com.google.cloud.dialogflow.v2.Intent.Message getFulfillmentMessages(int index);
/**
*
* The collection of rich messages to present to the user.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
*/
int getFulfillmentMessagesCount();
/**
*
* The collection of rich messages to present to the user.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
*/
java.util.List
getFulfillmentMessagesOrBuilderList();
/**
*
* The collection of rich messages to present to the user.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 7;
*/
com.google.cloud.dialogflow.v2.Intent.MessageOrBuilder getFulfillmentMessagesOrBuilder(
int index);
/**
*
* If the query was fulfilled by a webhook call, this field is set to the
* value of the `source` field returned in the webhook response.
*
*
* string webhook_source = 8;
*/
java.lang.String getWebhookSource();
/**
*
* If the query was fulfilled by a webhook call, this field is set to the
* value of the `source` field returned in the webhook response.
*
*
* string webhook_source = 8;
*/
com.google.protobuf.ByteString
getWebhookSourceBytes();
/**
*
* If the query was fulfilled by a webhook call, this field is set to the
* value of the `payload` field returned in the webhook response.
*
*
* .google.protobuf.Struct webhook_payload = 9;
*/
boolean hasWebhookPayload();
/**
*
* If the query was fulfilled by a webhook call, this field is set to the
* value of the `payload` field returned in the webhook response.
*
*
* .google.protobuf.Struct webhook_payload = 9;
*/
com.google.protobuf.Struct getWebhookPayload();
/**
*
* If the query was fulfilled by a webhook call, this field is set to the
* value of the `payload` field returned in the webhook response.
*
*
* .google.protobuf.Struct webhook_payload = 9;
*/
com.google.protobuf.StructOrBuilder getWebhookPayloadOrBuilder();
/**
*
* The collection of output contexts. If applicable,
* `output_contexts.parameters` contains entries with name
* `<parameter name>.original` containing the original parameter values
* before the query.
*
*
* repeated .google.cloud.dialogflow.v2.Context output_contexts = 10;
*/
java.util.List
getOutputContextsList();
/**
*
* The collection of output contexts. If applicable,
* `output_contexts.parameters` contains entries with name
* `<parameter name>.original` containing the original parameter values
* before the query.
*
*
* repeated .google.cloud.dialogflow.v2.Context output_contexts = 10;
*/
com.google.cloud.dialogflow.v2.Context getOutputContexts(int index);
/**
*
* The collection of output contexts. If applicable,
* `output_contexts.parameters` contains entries with name
* `<parameter name>.original` containing the original parameter values
* before the query.
*
*
* repeated .google.cloud.dialogflow.v2.Context output_contexts = 10;
*/
int getOutputContextsCount();
/**
*
* The collection of output contexts. If applicable,
* `output_contexts.parameters` contains entries with name
* `<parameter name>.original` containing the original parameter values
* before the query.
*
*
* repeated .google.cloud.dialogflow.v2.Context output_contexts = 10;
*/
java.util.List
getOutputContextsOrBuilderList();
/**
*
* The collection of output contexts. If applicable,
* `output_contexts.parameters` contains entries with name
* `<parameter name>.original` containing the original parameter values
* before the query.
*
*
* repeated .google.cloud.dialogflow.v2.Context output_contexts = 10;
*/
com.google.cloud.dialogflow.v2.ContextOrBuilder getOutputContextsOrBuilder(
int index);
/**
*
* The intent that matched the conversational query. Some, not
* all fields are filled in this message, including but not limited to:
* `name`, `display_name` and `webhook_state`.
*
*
* .google.cloud.dialogflow.v2.Intent intent = 11;
*/
boolean hasIntent();
/**
*
* The intent that matched the conversational query. Some, not
* all fields are filled in this message, including but not limited to:
* `name`, `display_name` and `webhook_state`.
*
*
* .google.cloud.dialogflow.v2.Intent intent = 11;
*/
com.google.cloud.dialogflow.v2.Intent getIntent();
/**
*
* The intent that matched the conversational query. Some, not
* all fields are filled in this message, including but not limited to:
* `name`, `display_name` and `webhook_state`.
*
*
* .google.cloud.dialogflow.v2.Intent intent = 11;
*/
com.google.cloud.dialogflow.v2.IntentOrBuilder getIntentOrBuilder();
/**
*
* The intent detection confidence. Values range from 0.0
* (completely uncertain) to 1.0 (completely certain).
*
*
* float intent_detection_confidence = 12;
*/
float getIntentDetectionConfidence();
/**
*
* The free-form diagnostic info. For example, this field
* could contain webhook call latency.
*
*
* .google.protobuf.Struct diagnostic_info = 14;
*/
boolean hasDiagnosticInfo();
/**
*
* The free-form diagnostic info. For example, this field
* could contain webhook call latency.
*
*
* .google.protobuf.Struct diagnostic_info = 14;
*/
com.google.protobuf.Struct getDiagnosticInfo();
/**
*
* The free-form diagnostic info. For example, this field
* could contain webhook call latency.
*
*
* .google.protobuf.Struct diagnostic_info = 14;
*/
com.google.protobuf.StructOrBuilder getDiagnosticInfoOrBuilder();
}