Class QueryResult.Builder (0.56.0) 

public static final class QueryResult.Builder extends GeneratedMessageV3.Builder<QueryResult.Builder> implements QueryResultOrBuilder

Represents the result of a conversational query.

Protobuf type google.cloud.dialogflow.cx.v3beta1.QueryResult

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > QueryResult.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllResponseMessages(Iterable<? extends ResponseMessage> values)

public QueryResult.Builder addAllResponseMessages(Iterable<? extends ResponseMessage> values)

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
values Iterable<? extends com.google.cloud.dialogflow.cx.v3beta1.ResponseMessage>
Returns
Type Description
QueryResult.Builder

addAllWebhookDisplayNames(Iterable<String> values)

public QueryResult.Builder addAllWebhookDisplayNames(Iterable<String> values)

The list of webhook display names in the order of call sequence.

repeated string webhook_display_names = 26;

Parameter
Name Description
values Iterable<String>

The webhookDisplayNames to add.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

addAllWebhookIds(Iterable<String> values)

public QueryResult.Builder addAllWebhookIds(Iterable<String> values)

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

repeated string webhook_ids = 25;

Parameter
Name Description
values Iterable<String>

The webhookIds to add.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

addAllWebhookLatencies(Iterable<? extends Duration> values)

public QueryResult.Builder addAllWebhookLatencies(Iterable<? extends Duration> values)

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

repeated .google.protobuf.Duration webhook_latencies = 27;

Parameter
Name Description
values Iterable<? extends com.google.protobuf.Duration>
Returns
Type Description
QueryResult.Builder

addAllWebhookPayloads(Iterable<? extends Struct> values)

public QueryResult.Builder addAllWebhookPayloads(Iterable<? extends Struct> values)

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
values Iterable<? extends com.google.protobuf.Struct>
Returns
Type Description
QueryResult.Builder

addAllWebhookStatuses(Iterable<? extends Status> values)

public QueryResult.Builder addAllWebhookStatuses(Iterable<? extends Status> values)

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

repeated .google.rpc.Status webhook_statuses = 13;

Parameter
Name Description
values Iterable<? extends com.google.rpc.Status>
Returns
Type Description
QueryResult.Builder

addAllWebhookTags(Iterable<String> values)

public QueryResult.Builder addAllWebhookTags(Iterable<String> values)

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

repeated string webhook_tags = 29;

Parameter
Name Description
values Iterable<String>

The webhookTags to add.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public QueryResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
QueryResult.Builder
Overrides

addResponseMessages(ResponseMessage value)

public QueryResult.Builder addResponseMessages(ResponseMessage value)

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
value ResponseMessage
Returns
Type Description
QueryResult.Builder

addResponseMessages(ResponseMessage.Builder builderForValue)

public QueryResult.Builder addResponseMessages(ResponseMessage.Builder builderForValue)

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
builderForValue ResponseMessage.Builder
Returns
Type Description
QueryResult.Builder

addResponseMessages(int index, ResponseMessage value)

public QueryResult.Builder addResponseMessages(int index, ResponseMessage value)

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;

Parameters
Name Description
index int
value ResponseMessage
Returns
Type Description
QueryResult.Builder

addResponseMessages(int index, ResponseMessage.Builder builderForValue)

public QueryResult.Builder addResponseMessages(int index, ResponseMessage.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue ResponseMessage.Builder
Returns
Type Description
QueryResult.Builder

addResponseMessagesBuilder()

public ResponseMessage.Builder addResponseMessagesBuilder()

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
ResponseMessage.Builder

addResponseMessagesBuilder(int index)

public ResponseMessage.Builder addResponseMessagesBuilder(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.Builder

addWebhookDisplayNames(String value)

public QueryResult.Builder addWebhookDisplayNames(String value)

The list of webhook display names in the order of call sequence.

repeated string webhook_display_names = 26;

Parameter
Name Description
value String

The webhookDisplayNames to add.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

addWebhookDisplayNamesBytes(ByteString value)

public QueryResult.Builder addWebhookDisplayNamesBytes(ByteString value)

The list of webhook display names in the order of call sequence.

repeated string webhook_display_names = 26;

Parameter
Name Description
value ByteString

The bytes of the webhookDisplayNames to add.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

addWebhookIds(String value)

public QueryResult.Builder addWebhookIds(String value)

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

repeated string webhook_ids = 25;

Parameter
Name Description
value String

The webhookIds to add.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

addWebhookIdsBytes(ByteString value)

public QueryResult.Builder addWebhookIdsBytes(ByteString value)

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

repeated string webhook_ids = 25;

Parameter
Name Description
value ByteString

The bytes of the webhookIds to add.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

addWebhookLatencies(Duration value)

public QueryResult.Builder addWebhookLatencies(Duration value)

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

repeated .google.protobuf.Duration webhook_latencies = 27;

Parameter
Name Description
value Duration
Returns
Type Description
QueryResult.Builder

addWebhookLatencies(Duration.Builder builderForValue)

public QueryResult.Builder addWebhookLatencies(Duration.Builder builderForValue)

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

repeated .google.protobuf.Duration webhook_latencies = 27;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
QueryResult.Builder

addWebhookLatencies(int index, Duration value)

public QueryResult.Builder addWebhookLatencies(int index, Duration value)

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

repeated .google.protobuf.Duration webhook_latencies = 27;

Parameters
Name Description
index int
value Duration
Returns
Type Description
QueryResult.Builder

addWebhookLatencies(int index, Duration.Builder builderForValue)

public QueryResult.Builder addWebhookLatencies(int index, Duration.Builder builderForValue)

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

repeated .google.protobuf.Duration webhook_latencies = 27;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
QueryResult.Builder

addWebhookLatenciesBuilder()

public Duration.Builder addWebhookLatenciesBuilder()

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

repeated .google.protobuf.Duration webhook_latencies = 27;

Returns
Type Description
Builder

addWebhookLatenciesBuilder(int index)

public Duration.Builder addWebhookLatenciesBuilder(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
Builder

addWebhookPayloads(Struct value)

public QueryResult.Builder addWebhookPayloads(Struct value)

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
value Struct
Returns
Type Description
QueryResult.Builder

addWebhookPayloads(Struct.Builder builderForValue)

public QueryResult.Builder addWebhookPayloads(Struct.Builder builderForValue)

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
builderForValue Builder
Returns
Type Description
QueryResult.Builder

addWebhookPayloads(int index, Struct value)

public QueryResult.Builder addWebhookPayloads(int index, Struct value)

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;

Parameters
Name Description
index int
value Struct
Returns
Type Description
QueryResult.Builder

addWebhookPayloads(int index, Struct.Builder builderForValue)

public QueryResult.Builder addWebhookPayloads(int index, Struct.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
QueryResult.Builder

addWebhookPayloadsBuilder()

public Struct.Builder addWebhookPayloadsBuilder()

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
Builder

addWebhookPayloadsBuilder(int index)

public Struct.Builder addWebhookPayloadsBuilder(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
Builder

addWebhookStatuses(Status value)

public QueryResult.Builder addWebhookStatuses(Status value)

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

repeated .google.rpc.Status webhook_statuses = 13;

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
QueryResult.Builder

addWebhookStatuses(Status.Builder builderForValue)

public QueryResult.Builder addWebhookStatuses(Status.Builder builderForValue)

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

repeated .google.rpc.Status webhook_statuses = 13;

Parameter
Name Description
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
QueryResult.Builder

addWebhookStatuses(int index, Status value)

public QueryResult.Builder addWebhookStatuses(int index, Status value)

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

repeated .google.rpc.Status webhook_statuses = 13;

Parameters
Name Description
index int
value com.google.rpc.Status
Returns
Type Description
QueryResult.Builder

addWebhookStatuses(int index, Status.Builder builderForValue)

public QueryResult.Builder addWebhookStatuses(int index, Status.Builder builderForValue)

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

repeated .google.rpc.Status webhook_statuses = 13;

Parameters
Name Description
index int
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
QueryResult.Builder

addWebhookStatusesBuilder()

public Status.Builder addWebhookStatusesBuilder()

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

repeated .google.rpc.Status webhook_statuses = 13;

Returns
Type Description
com.google.rpc.Status.Builder

addWebhookStatusesBuilder(int index)

public Status.Builder addWebhookStatusesBuilder(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.Builder

addWebhookTags(String value)

public QueryResult.Builder addWebhookTags(String value)

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

repeated string webhook_tags = 29;

Parameter
Name Description
value String

The webhookTags to add.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

addWebhookTagsBytes(ByteString value)

public QueryResult.Builder addWebhookTagsBytes(ByteString value)

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

repeated string webhook_tags = 29;

Parameter
Name Description
value ByteString

The bytes of the webhookTags to add.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

build()

public QueryResult build()
Returns
Type Description
QueryResult

buildPartial()

public QueryResult buildPartial()
Returns
Type Description
QueryResult

clear()

public QueryResult.Builder clear()
Returns
Type Description
QueryResult.Builder
Overrides

clearAdvancedSettings()

public QueryResult.Builder clearAdvancedSettings()

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
QueryResult.Builder

clearAllowAnswerFeedback()

public QueryResult.Builder clearAllowAnswerFeedback()

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
QueryResult.Builder

This builder for chaining.

clearCurrentFlow()

public QueryResult.Builder clearCurrentFlow()

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
QueryResult.Builder

clearCurrentPage()

public QueryResult.Builder clearCurrentPage()

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
QueryResult.Builder

clearDataStoreConnectionSignals()

public QueryResult.Builder clearDataStoreConnectionSignals()

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
QueryResult.Builder

clearDiagnosticInfo()

public QueryResult.Builder clearDiagnosticInfo()

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
QueryResult.Builder

clearDtmf()

public QueryResult.Builder clearDtmf()

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
QueryResult.Builder

clearField(Descriptors.FieldDescriptor field)

public QueryResult.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
QueryResult.Builder
Overrides

clearGenerativeInfo()

public QueryResult.Builder clearGenerativeInfo()

The information of a query if handled by generative agent resources.

.google.cloud.dialogflow.cx.v3beta1.GenerativeInfo generative_info = 33;

Returns
Type Description
QueryResult.Builder

clearIntent() (deprecated)

public QueryResult.Builder clearIntent()

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
QueryResult.Builder

clearIntentDetectionConfidence() (deprecated)

public QueryResult.Builder clearIntentDetectionConfidence()

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
QueryResult.Builder

This builder for chaining.

clearLanguageCode()

public QueryResult.Builder clearLanguageCode()

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
QueryResult.Builder

This builder for chaining.

clearMatch()

public QueryResult.Builder clearMatch()

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

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

Returns
Type Description
QueryResult.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public QueryResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
QueryResult.Builder
Overrides

clearParameters()

public QueryResult.Builder clearParameters()

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
QueryResult.Builder

clearQuery()

public QueryResult.Builder clearQuery()
Returns
Type Description
QueryResult.Builder

clearResponseMessages()

public QueryResult.Builder clearResponseMessages()

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
QueryResult.Builder

clearSentimentAnalysisResult()

public QueryResult.Builder clearSentimentAnalysisResult()

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
QueryResult.Builder

clearText()

public QueryResult.Builder clearText()

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

string text = 1;

Returns
Type Description
QueryResult.Builder

This builder for chaining.

clearTranscript()

public QueryResult.Builder clearTranscript()

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

string transcript = 12;

Returns
Type Description
QueryResult.Builder

This builder for chaining.

clearTriggerEvent()

public QueryResult.Builder clearTriggerEvent()

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

string trigger_event = 14;

Returns
Type Description
QueryResult.Builder

This builder for chaining.

clearTriggerIntent()

public QueryResult.Builder clearTriggerIntent()

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
QueryResult.Builder

This builder for chaining.

clearWebhookDisplayNames()

public QueryResult.Builder clearWebhookDisplayNames()

The list of webhook display names in the order of call sequence.

repeated string webhook_display_names = 26;

Returns
Type Description
QueryResult.Builder

This builder for chaining.

clearWebhookIds()

public QueryResult.Builder clearWebhookIds()

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

repeated string webhook_ids = 25;

Returns
Type Description
QueryResult.Builder

This builder for chaining.

clearWebhookLatencies()

public QueryResult.Builder clearWebhookLatencies()

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

repeated .google.protobuf.Duration webhook_latencies = 27;

Returns
Type Description
QueryResult.Builder

clearWebhookPayloads()

public QueryResult.Builder clearWebhookPayloads()

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
QueryResult.Builder

clearWebhookStatuses()

public QueryResult.Builder clearWebhookStatuses()

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

repeated .google.rpc.Status webhook_statuses = 13;

Returns
Type Description
QueryResult.Builder

clearWebhookTags()

public QueryResult.Builder clearWebhookTags()

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

repeated string webhook_tags = 29;

Returns
Type Description
QueryResult.Builder

This builder for chaining.

clone()

public QueryResult.Builder clone()
Returns
Type Description
QueryResult.Builder
Overrides

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.

getAdvancedSettingsBuilder()

public AdvancedSettings.Builder getAdvancedSettingsBuilder()

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.Builder

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.

getCurrentFlowBuilder()

public Flow.Builder getCurrentFlowBuilder()

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.Builder

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.

getCurrentPageBuilder()

public Page.Builder getCurrentPageBuilder()

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.Builder

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.

getDataStoreConnectionSignalsBuilder()

public DataStoreConnectionSignals.Builder getDataStoreConnectionSignalsBuilder()

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.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getDiagnosticInfoBuilder()

public Struct.Builder getDiagnosticInfoBuilder()

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
Builder

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.

getDtmfBuilder()

public DtmfInput.Builder getDtmfBuilder()

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.Builder

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.

getGenerativeInfoBuilder()

public GenerativeInfo.Builder getGenerativeInfoBuilder()

The information of a query if handled by generative agent resources.

.google.cloud.dialogflow.cx.v3beta1.GenerativeInfo generative_info = 33;

Returns
Type Description
GenerativeInfo.Builder

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.

getIntentBuilder() (deprecated)

public Intent.Builder getIntentBuilder()

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.Builder

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.

getMatchBuilder()

public Match.Builder getMatchBuilder()

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

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

Returns
Type Description
Match.Builder

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.

getParametersBuilder()

public Struct.Builder getParametersBuilder()

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
Builder

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

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

getResponseMessagesBuilder(int index)

public ResponseMessage.Builder getResponseMessagesBuilder(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.Builder

getResponseMessagesBuilderList()

public List<ResponseMessage.Builder> getResponseMessagesBuilderList()

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<Builder>

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.

getSentimentAnalysisResultBuilder()

public SentimentAnalysisResult.Builder getSentimentAnalysisResultBuilder()

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.Builder

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

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 int

The 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 int

The 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 int

The 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 int

The 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

getWebhookLatenciesBuilder(int index)

public Duration.Builder getWebhookLatenciesBuilder(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
Builder

getWebhookLatenciesBuilderList()

public List<Duration.Builder> getWebhookLatenciesBuilderList()

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

repeated .google.protobuf.Duration webhook_latencies = 27;

Returns
Type Description
List<Builder>

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

getWebhookPayloadsBuilder(int index)

public Struct.Builder getWebhookPayloadsBuilder(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
Builder

getWebhookPayloadsBuilderList()

public List<Struct.Builder> getWebhookPayloadsBuilderList()

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<Builder>

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

getWebhookStatusesBuilder(int index)

public Status.Builder getWebhookStatusesBuilder(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.Builder

getWebhookStatusesBuilderList()

public List<Status.Builder> getWebhookStatusesBuilderList()

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.Builder>

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 int

The 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 int

The 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAdvancedSettings(AdvancedSettings value)

public QueryResult.Builder mergeAdvancedSettings(AdvancedSettings value)

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;

Parameter
Name Description
value AdvancedSettings
Returns
Type Description
QueryResult.Builder

mergeCurrentFlow(Flow value)

public QueryResult.Builder mergeCurrentFlow(Flow value)

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;

Parameter
Name Description
value Flow
Returns
Type Description
QueryResult.Builder

mergeCurrentPage(Page value)

public QueryResult.Builder mergeCurrentPage(Page value)

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;

Parameter
Name Description
value Page
Returns
Type Description
QueryResult.Builder

mergeDataStoreConnectionSignals(DataStoreConnectionSignals value)

public QueryResult.Builder mergeDataStoreConnectionSignals(DataStoreConnectionSignals value)

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];

Parameter
Name Description
value DataStoreConnectionSignals
Returns
Type Description
QueryResult.Builder

mergeDiagnosticInfo(Struct value)

public QueryResult.Builder mergeDiagnosticInfo(Struct value)

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;

Parameter
Name Description
value Struct
Returns
Type Description
QueryResult.Builder

mergeDtmf(DtmfInput value)

public QueryResult.Builder mergeDtmf(DtmfInput value)

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

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

Parameter
Name Description
value DtmfInput
Returns
Type Description
QueryResult.Builder

mergeFrom(QueryResult other)

public QueryResult.Builder mergeFrom(QueryResult other)
Parameter
Name Description
other QueryResult
Returns
Type Description
QueryResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public QueryResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryResult.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public QueryResult.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
QueryResult.Builder
Overrides

mergeGenerativeInfo(GenerativeInfo value)

public QueryResult.Builder mergeGenerativeInfo(GenerativeInfo value)

The information of a query if handled by generative agent resources.

.google.cloud.dialogflow.cx.v3beta1.GenerativeInfo generative_info = 33;

Parameter
Name Description
value GenerativeInfo
Returns
Type Description
QueryResult.Builder

mergeIntent(Intent value) (deprecated)

public QueryResult.Builder mergeIntent(Intent value)

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];

Parameter
Name Description
value Intent
Returns
Type Description
QueryResult.Builder

mergeMatch(Match value)

public QueryResult.Builder mergeMatch(Match value)

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

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

Parameter
Name Description
value Match
Returns
Type Description
QueryResult.Builder

mergeParameters(Struct value)

public QueryResult.Builder mergeParameters(Struct value)

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;

Parameter
Name Description
value Struct
Returns
Type Description
QueryResult.Builder

mergeSentimentAnalysisResult(SentimentAnalysisResult value)

public QueryResult.Builder mergeSentimentAnalysisResult(SentimentAnalysisResult value)

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;

Parameter
Name Description
value SentimentAnalysisResult
Returns
Type Description
QueryResult.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final QueryResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
QueryResult.Builder
Overrides

removeResponseMessages(int index)

public QueryResult.Builder removeResponseMessages(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
QueryResult.Builder

removeWebhookLatencies(int index)

public QueryResult.Builder removeWebhookLatencies(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
QueryResult.Builder

removeWebhookPayloads(int index)

public QueryResult.Builder removeWebhookPayloads(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
QueryResult.Builder

removeWebhookStatuses(int index)

public QueryResult.Builder removeWebhookStatuses(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
QueryResult.Builder

setAdvancedSettings(AdvancedSettings value)

public QueryResult.Builder setAdvancedSettings(AdvancedSettings value)

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;

Parameter
Name Description
value AdvancedSettings
Returns
Type Description
QueryResult.Builder

setAdvancedSettings(AdvancedSettings.Builder builderForValue)

public QueryResult.Builder setAdvancedSettings(AdvancedSettings.Builder builderForValue)

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;

Parameter
Name Description
builderForValue AdvancedSettings.Builder
Returns
Type Description
QueryResult.Builder

setAllowAnswerFeedback(boolean value)

public QueryResult.Builder setAllowAnswerFeedback(boolean value)

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;

Parameter
Name Description
value boolean

The allowAnswerFeedback to set.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

setCurrentFlow(Flow value)

public QueryResult.Builder setCurrentFlow(Flow value)

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;

Parameter
Name Description
value Flow
Returns
Type Description
QueryResult.Builder

setCurrentFlow(Flow.Builder builderForValue)

public QueryResult.Builder setCurrentFlow(Flow.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Flow.Builder
Returns
Type Description
QueryResult.Builder

setCurrentPage(Page value)

public QueryResult.Builder setCurrentPage(Page value)

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;

Parameter
Name Description
value Page
Returns
Type Description
QueryResult.Builder

setCurrentPage(Page.Builder builderForValue)

public QueryResult.Builder setCurrentPage(Page.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Page.Builder
Returns
Type Description
QueryResult.Builder

setDataStoreConnectionSignals(DataStoreConnectionSignals value)

public QueryResult.Builder setDataStoreConnectionSignals(DataStoreConnectionSignals value)

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];

Parameter
Name Description
value DataStoreConnectionSignals
Returns
Type Description
QueryResult.Builder

setDataStoreConnectionSignals(DataStoreConnectionSignals.Builder builderForValue)

public QueryResult.Builder setDataStoreConnectionSignals(DataStoreConnectionSignals.Builder builderForValue)

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];

Parameter
Name Description
builderForValue DataStoreConnectionSignals.Builder
Returns
Type Description
QueryResult.Builder

setDiagnosticInfo(Struct value)

public QueryResult.Builder setDiagnosticInfo(Struct value)

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;

Parameter
Name Description
value Struct
Returns
Type Description
QueryResult.Builder

setDiagnosticInfo(Struct.Builder builderForValue)

public QueryResult.Builder setDiagnosticInfo(Struct.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
QueryResult.Builder

setDtmf(DtmfInput value)

public QueryResult.Builder setDtmf(DtmfInput value)

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

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

Parameter
Name Description
value DtmfInput
Returns
Type Description
QueryResult.Builder

setDtmf(DtmfInput.Builder builderForValue)

public QueryResult.Builder setDtmf(DtmfInput.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue DtmfInput.Builder
Returns
Type Description
QueryResult.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public QueryResult.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
QueryResult.Builder
Overrides

setGenerativeInfo(GenerativeInfo value)

public QueryResult.Builder setGenerativeInfo(GenerativeInfo value)

The information of a query if handled by generative agent resources.

.google.cloud.dialogflow.cx.v3beta1.GenerativeInfo generative_info = 33;

Parameter
Name Description
value GenerativeInfo
Returns
Type Description
QueryResult.Builder

setGenerativeInfo(GenerativeInfo.Builder builderForValue)

public QueryResult.Builder setGenerativeInfo(GenerativeInfo.Builder builderForValue)

The information of a query if handled by generative agent resources.

.google.cloud.dialogflow.cx.v3beta1.GenerativeInfo generative_info = 33;

Parameter
Name Description
builderForValue GenerativeInfo.Builder
Returns
Type Description
QueryResult.Builder

setIntent(Intent value) (deprecated)

public QueryResult.Builder setIntent(Intent value)

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];

Parameter
Name Description
value Intent
Returns
Type Description
QueryResult.Builder

setIntent(Intent.Builder builderForValue) (deprecated)

public QueryResult.Builder setIntent(Intent.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Intent.Builder
Returns
Type Description
QueryResult.Builder

setIntentDetectionConfidence(float value) (deprecated)

public QueryResult.Builder setIntentDetectionConfidence(float value)

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];

Parameter
Name Description
value float

The intentDetectionConfidence to set.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

setLanguageCode(String value)

public QueryResult.Builder setLanguageCode(String value)

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

string language_code = 2;

Parameter
Name Description
value String

The languageCode to set.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

setLanguageCodeBytes(ByteString value)

public QueryResult.Builder setLanguageCodeBytes(ByteString value)

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

string language_code = 2;

Parameter
Name Description
value ByteString

The bytes for languageCode to set.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

setMatch(Match value)

public QueryResult.Builder setMatch(Match value)

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

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

Parameter
Name Description
value Match
Returns
Type Description
QueryResult.Builder

setMatch(Match.Builder builderForValue)

public QueryResult.Builder setMatch(Match.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Match.Builder
Returns
Type Description
QueryResult.Builder

setParameters(Struct value)

public QueryResult.Builder setParameters(Struct value)

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;

Parameter
Name Description
value Struct
Returns
Type Description
QueryResult.Builder

setParameters(Struct.Builder builderForValue)

public QueryResult.Builder setParameters(Struct.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
QueryResult.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public QueryResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
QueryResult.Builder
Overrides

setResponseMessages(int index, ResponseMessage value)

public QueryResult.Builder setResponseMessages(int index, ResponseMessage value)

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;

Parameters
Name Description
index int
value ResponseMessage
Returns
Type Description
QueryResult.Builder

setResponseMessages(int index, ResponseMessage.Builder builderForValue)

public QueryResult.Builder setResponseMessages(int index, ResponseMessage.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue ResponseMessage.Builder
Returns
Type Description
QueryResult.Builder

setSentimentAnalysisResult(SentimentAnalysisResult value)

public QueryResult.Builder setSentimentAnalysisResult(SentimentAnalysisResult value)

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;

Parameter
Name Description
value SentimentAnalysisResult
Returns
Type Description
QueryResult.Builder

setSentimentAnalysisResult(SentimentAnalysisResult.Builder builderForValue)

public QueryResult.Builder setSentimentAnalysisResult(SentimentAnalysisResult.Builder builderForValue)

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;

Parameter
Name Description
builderForValue SentimentAnalysisResult.Builder
Returns
Type Description
QueryResult.Builder

setText(String value)

public QueryResult.Builder setText(String value)

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

string text = 1;

Parameter
Name Description
value String

The text to set.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

setTextBytes(ByteString value)

public QueryResult.Builder setTextBytes(ByteString value)

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

string text = 1;

Parameter
Name Description
value ByteString

The bytes for text to set.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

setTranscript(String value)

public QueryResult.Builder setTranscript(String value)

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

string transcript = 12;

Parameter
Name Description
value String

The transcript to set.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

setTranscriptBytes(ByteString value)

public QueryResult.Builder setTranscriptBytes(ByteString value)

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

string transcript = 12;

Parameter
Name Description
value ByteString

The bytes for transcript to set.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

setTriggerEvent(String value)

public QueryResult.Builder setTriggerEvent(String value)

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

string trigger_event = 14;

Parameter
Name Description
value String

The triggerEvent to set.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

setTriggerEventBytes(ByteString value)

public QueryResult.Builder setTriggerEventBytes(ByteString value)

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

string trigger_event = 14;

Parameter
Name Description
value ByteString

The bytes for triggerEvent to set.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

setTriggerIntent(String value)

public QueryResult.Builder setTriggerIntent(String value)

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

Parameter
Name Description
value String

The triggerIntent to set.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

setTriggerIntentBytes(ByteString value)

public QueryResult.Builder setTriggerIntentBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for triggerIntent to set.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final QueryResult.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
QueryResult.Builder
Overrides

setWebhookDisplayNames(int index, String value)

public QueryResult.Builder setWebhookDisplayNames(int index, String value)

The list of webhook display names in the order of call sequence.

repeated string webhook_display_names = 26;

Parameters
Name Description
index int

The index to set the value at.
value String

The webhookDisplayNames to set.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

setWebhookIds(int index, String value)

public QueryResult.Builder setWebhookIds(int index, String value)

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

repeated string webhook_ids = 25;

Parameters
Name Description
index int

The index to set the value at.
value String

The webhookIds to set.
Returns
Type Description
QueryResult.Builder

This builder for chaining.

setWebhookLatencies(int index, Duration value)

public QueryResult.Builder setWebhookLatencies(int index, Duration value)

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

repeated .google.protobuf.Duration webhook_latencies = 27;

Parameters
Name Description
index int
value Duration
Returns
Type Description
QueryResult.Builder

setWebhookLatencies(int index, Duration.Builder builderForValue)

public QueryResult.Builder setWebhookLatencies(int index, Duration.Builder builderForValue)

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

repeated .google.protobuf.Duration webhook_latencies = 27;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
QueryResult.Builder

setWebhookPayloads(int index, Struct value)

public QueryResult.Builder setWebhookPayloads(int index, Struct value)

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;

Parameters
Name Description
index int
value Struct
Returns
Type Description
QueryResult.Builder

setWebhookPayloads(int index, Struct.Builder builderForValue)

public QueryResult.Builder setWebhookPayloads(int index, Struct.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
QueryResult.Builder

setWebhookStatuses(int index, Status value)

public QueryResult.Builder setWebhookStatuses(int index, Status value)

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

repeated .google.rpc.Status webhook_statuses = 13;

Parameters
Name Description
index int
value com.google.rpc.Status
Returns
Type Description
QueryResult.Builder

setWebhookStatuses(int index, Status.Builder builderForValue)

public QueryResult.Builder setWebhookStatuses(int index, Status.Builder builderForValue)

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

repeated .google.rpc.Status webhook_statuses = 13;

Parameters
Name Description
index int
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
QueryResult.Builder

setWebhookTags(int index, String value)

public QueryResult.Builder setWebhookTags(int index, String value)

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

repeated string webhook_tags = 29;

Parameters
Name Description
index int

The index to set the value at.
value String

The webhookTags to set.
Returns
Type Description
QueryResult.Builder

This builder for chaining.