Interface DetectIntentResponseOrBuilder (4.28.0)

public interface DetectIntentResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAlternativeQueryResults(int index)

public abstract QueryResult getAlternativeQueryResults(int index)

If Knowledge Connectors are enabled, there could be more than one result returned for a given query or event, and this field will contain all results except for the top one, which is captured in query_result. The alternative results are ordered by decreasing QueryResult.intent_detection_confidence. If Knowledge Connectors are disabled, this field will be empty until multiple responses for regular intents are supported, at which point those additional results will be surfaced here.

repeated .google.cloud.dialogflow.v2beta1.QueryResult alternative_query_results = 5;

Parameter
Name Description
index int
Returns
Type Description
QueryResult

getAlternativeQueryResultsCount()

public abstract int getAlternativeQueryResultsCount()

If Knowledge Connectors are enabled, there could be more than one result returned for a given query or event, and this field will contain all results except for the top one, which is captured in query_result. The alternative results are ordered by decreasing QueryResult.intent_detection_confidence. If Knowledge Connectors are disabled, this field will be empty until multiple responses for regular intents are supported, at which point those additional results will be surfaced here.

repeated .google.cloud.dialogflow.v2beta1.QueryResult alternative_query_results = 5;

Returns
Type Description
int

getAlternativeQueryResultsList()

public abstract List<QueryResult> getAlternativeQueryResultsList()

If Knowledge Connectors are enabled, there could be more than one result returned for a given query or event, and this field will contain all results except for the top one, which is captured in query_result. The alternative results are ordered by decreasing QueryResult.intent_detection_confidence. If Knowledge Connectors are disabled, this field will be empty until multiple responses for regular intents are supported, at which point those additional results will be surfaced here.

repeated .google.cloud.dialogflow.v2beta1.QueryResult alternative_query_results = 5;

Returns
Type Description
List<QueryResult>

getAlternativeQueryResultsOrBuilder(int index)

public abstract QueryResultOrBuilder getAlternativeQueryResultsOrBuilder(int index)

If Knowledge Connectors are enabled, there could be more than one result returned for a given query or event, and this field will contain all results except for the top one, which is captured in query_result. The alternative results are ordered by decreasing QueryResult.intent_detection_confidence. If Knowledge Connectors are disabled, this field will be empty until multiple responses for regular intents are supported, at which point those additional results will be surfaced here.

repeated .google.cloud.dialogflow.v2beta1.QueryResult alternative_query_results = 5;

Parameter
Name Description
index int
Returns
Type Description
QueryResultOrBuilder

getAlternativeQueryResultsOrBuilderList()

public abstract List<? extends QueryResultOrBuilder> getAlternativeQueryResultsOrBuilderList()

If Knowledge Connectors are enabled, there could be more than one result returned for a given query or event, and this field will contain all results except for the top one, which is captured in query_result. The alternative results are ordered by decreasing QueryResult.intent_detection_confidence. If Knowledge Connectors are disabled, this field will be empty until multiple responses for regular intents are supported, at which point those additional results will be surfaced here.

repeated .google.cloud.dialogflow.v2beta1.QueryResult alternative_query_results = 5;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2beta1.QueryResultOrBuilder>

getOutputAudio()

public abstract ByteString getOutputAudio()

The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the query_result.fulfillment_messages field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty.

In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content.

bytes output_audio = 4;

Returns
Type Description
ByteString

The outputAudio.

getOutputAudioConfig()

public abstract OutputAudioConfig getOutputAudioConfig()

The config used by the speech synthesizer to generate the output audio.

.google.cloud.dialogflow.v2beta1.OutputAudioConfig output_audio_config = 6;

Returns
Type Description
OutputAudioConfig

The outputAudioConfig.

getOutputAudioConfigOrBuilder()

public abstract OutputAudioConfigOrBuilder getOutputAudioConfigOrBuilder()

The config used by the speech synthesizer to generate the output audio.

.google.cloud.dialogflow.v2beta1.OutputAudioConfig output_audio_config = 6;

Returns
Type Description
OutputAudioConfigOrBuilder

getQueryResult()

public abstract QueryResult getQueryResult()

The selected results of the conversational query or event processing. See alternative_query_results for additional potential results.

.google.cloud.dialogflow.v2beta1.QueryResult query_result = 2;

Returns
Type Description
QueryResult

The queryResult.

getQueryResultOrBuilder()

public abstract QueryResultOrBuilder getQueryResultOrBuilder()

The selected results of the conversational query or event processing. See alternative_query_results for additional potential results.

.google.cloud.dialogflow.v2beta1.QueryResult query_result = 2;

Returns
Type Description
QueryResultOrBuilder

getResponseId()

public abstract String getResponseId()

The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.

string response_id = 1;

Returns
Type Description
String

The responseId.

getResponseIdBytes()

public abstract ByteString getResponseIdBytes()

The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.

string response_id = 1;

Returns
Type Description
ByteString

The bytes for responseId.

getWebhookStatus()

public abstract Status getWebhookStatus()

Specifies the status of the webhook request.

.google.rpc.Status webhook_status = 3;

Returns
Type Description
com.google.rpc.Status

The webhookStatus.

getWebhookStatusOrBuilder()

public abstract StatusOrBuilder getWebhookStatusOrBuilder()

Specifies the status of the webhook request.

.google.rpc.Status webhook_status = 3;

Returns
Type Description
com.google.rpc.StatusOrBuilder

hasOutputAudioConfig()

public abstract boolean hasOutputAudioConfig()

The config used by the speech synthesizer to generate the output audio.

.google.cloud.dialogflow.v2beta1.OutputAudioConfig output_audio_config = 6;

Returns
Type Description
boolean

Whether the outputAudioConfig field is set.

hasQueryResult()

public abstract boolean hasQueryResult()

The selected results of the conversational query or event processing. See alternative_query_results for additional potential results.

.google.cloud.dialogflow.v2beta1.QueryResult query_result = 2;

Returns
Type Description
boolean

Whether the queryResult field is set.

hasWebhookStatus()

public abstract boolean hasWebhookStatus()

Specifies the status of the webhook request.

.google.rpc.Status webhook_status = 3;

Returns
Type Description
boolean

Whether the webhookStatus field is set.