Class QueryParameters.Builder (0.60.0)

public static final class QueryParameters.Builder extends GeneratedMessageV3.Builder<QueryParameters.Builder> implements QueryParametersOrBuilder

Represents the parameters of a conversational query.

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

Inheritance

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

Implements

QueryParametersOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllFlowVersions(Iterable<String> values)

public QueryParameters.Builder addAllFlowVersions(Iterable<String> values)

A list of flow versions to override for the request. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

If version 1 of flow X is included in this list, the traffic of flow X will go through version 1 regardless of the version configuration in the environment. Each flow can have at most one version specified in this list.

repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
`values`	`Iterable<String>` The flowVersions to add.

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

addAllSessionEntityTypes(Iterable<? extends SessionEntityType> values)

public QueryParameters.Builder addAllSessionEntityTypes(Iterable<? extends SessionEntityType> values)

Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.

repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.dialogflow.cx.v3beta1.SessionEntityType>`

Returns
Type	Description
`QueryParameters.Builder`

addFlowVersions(String value)

public QueryParameters.Builder addFlowVersions(String value)

A list of flow versions to override for the request. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`String` The flowVersions to add.

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

addFlowVersionsBytes(ByteString value)

public QueryParameters.Builder addFlowVersionsBytes(ByteString value)

A list of flow versions to override for the request. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`ByteString` The bytes of the flowVersions to add.

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public QueryParameters.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`QueryParameters.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addSessionEntityTypes(SessionEntityType value)

public QueryParameters.Builder addSessionEntityTypes(SessionEntityType value)

Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.

repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

Parameter
Name	Description
`value`	`SessionEntityType`

Returns
Type	Description
`QueryParameters.Builder`

addSessionEntityTypes(SessionEntityType.Builder builderForValue)

public QueryParameters.Builder addSessionEntityTypes(SessionEntityType.Builder builderForValue)

Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.

repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

Parameter
Name	Description
`builderForValue`	`SessionEntityType.Builder`

Returns
Type	Description
`QueryParameters.Builder`

addSessionEntityTypes(int index, SessionEntityType value)

public QueryParameters.Builder addSessionEntityTypes(int index, SessionEntityType value)

Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.

repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

Parameters
Name	Description
`index`	`int`
`value`	`SessionEntityType`

Returns
Type	Description
`QueryParameters.Builder`

addSessionEntityTypes(int index, SessionEntityType.Builder builderForValue)

public QueryParameters.Builder addSessionEntityTypes(int index, SessionEntityType.Builder builderForValue)

Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.

repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`SessionEntityType.Builder`

Returns
Type	Description
`QueryParameters.Builder`

addSessionEntityTypesBuilder()

public SessionEntityType.Builder addSessionEntityTypesBuilder()

Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.

repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

Returns
Type	Description
`SessionEntityType.Builder`

addSessionEntityTypesBuilder(int index)

public SessionEntityType.Builder addSessionEntityTypesBuilder(int index)

Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.

repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SessionEntityType.Builder`

build()

public QueryParameters build()

Returns
Type	Description
`QueryParameters`

buildPartial()

public QueryParameters buildPartial()

Returns
Type	Description
`QueryParameters`

clear()

public QueryParameters.Builder clear()

Returns
Type	Description
`QueryParameters.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAnalyzeQueryTextSentiment()

public QueryParameters.Builder clearAnalyzeQueryTextSentiment()

Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.

bool analyze_query_text_sentiment = 8;

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

clearChannel()

public QueryParameters.Builder clearChannel()

The channel which this query is for.

If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel.

If unspecified, the ResponseMessage with unspecified channel will be returned.

string channel = 15;

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

clearCurrentPage()

public QueryParameters.Builder clearCurrentPage()

The unique identifier of the page to override the current page in the session. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

If current_page is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state.

string current_page = 6 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

clearCurrentPlaybook()

public QueryParameters.Builder clearCurrentPlaybook()

Optional. Start the session with the specified playbook. You can only specify the playbook at the beginning of the session. Otherwise, an error will be thrown.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>.

string current_playbook = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

clearDisableWebhook()

public QueryParameters.Builder clearDisableWebhook()

Whether to disable webhook calls for this request.

bool disable_webhook = 7;

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

clearEndUserMetadata()

public QueryParameters.Builder clearEndUserMetadata()

Optional. Information about the end-user to improve the relevance and accuracy of generative answers.

This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure.

Example:

<code><code>json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } </code></code>

.google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`QueryParameters.Builder`

clearField(Descriptors.FieldDescriptor field)

public QueryParameters.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`QueryParameters.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFlowVersions()

public QueryParameters.Builder clearFlowVersions()

A list of flow versions to override for the request. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

clearGeoLocation()

public QueryParameters.Builder clearGeoLocation()

The geo location of this conversational query.

.google.type.LatLng geo_location = 2;

Returns
Type	Description
`QueryParameters.Builder`

clearLlmModelSettings()

public QueryParameters.Builder clearLlmModelSettings()

Optional. Use the specified LLM model settings for processing the request.

.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`QueryParameters.Builder`

clearOneof(Descriptors.OneofDescriptor oneof)

public QueryParameters.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`QueryParameters.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearParameters()

public QueryParameters.Builder clearParameters()

Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

You can reference the session parameters in the agent with the following format: $session.params.parameter-id.

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 = 5;

Returns
Type	Description
`QueryParameters.Builder`

clearPayload()

public QueryParameters.Builder clearPayload()

This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: <code><code> { "telephony": { "caller_id": "+18558363987" } } </code></code>

.google.protobuf.Struct payload = 4;

Returns
Type	Description
`QueryParameters.Builder`

clearPopulateDataStoreConnectionSignals()

public QueryParameters.Builder clearPopulateDataStoreConnectionSignals()

Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations.

bool populate_data_store_connection_signals = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

clearSearchConfig()

public QueryParameters.Builder clearSearchConfig()

Optional. Search configuration for UCS search queries.

.google.cloud.dialogflow.cx.v3beta1.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`QueryParameters.Builder`

clearSessionEntityTypes()

public QueryParameters.Builder clearSessionEntityTypes()

Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.

repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

Returns
Type	Description
`QueryParameters.Builder`

clearSessionTtl()

public QueryParameters.Builder clearSessionTtl()

Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.

.google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`QueryParameters.Builder`

clearTimeZone()

public QueryParameters.Builder clearTimeZone()

The time zone of this conversational query from the time zone database, e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in the agent is used.

string time_zone = 1;

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

clearWebhookHeaders()

public QueryParameters.Builder clearWebhookHeaders()

Returns
Type	Description
`QueryParameters.Builder`

clone()

public QueryParameters.Builder clone()

Returns
Type	Description
`QueryParameters.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsWebhookHeaders(String key)

public boolean containsWebhookHeaders(String key)

This field can be used to pass HTTP headers for a webhook call. These headers will be sent to webhook along with the headers that have been configured through Dialogflow web console. The headers defined within this field will overwrite the headers configured through Dialogflow console if there is a conflict. Header names are case-insensitive. Google's specified headers are not allowed. Including: "Host", "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding", "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.

map<string, string> webhook_headers = 10;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getAnalyzeQueryTextSentiment()

public boolean getAnalyzeQueryTextSentiment()

Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.

bool analyze_query_text_sentiment = 8;

Returns
Type	Description
`boolean`	The analyzeQueryTextSentiment.

getChannel()

public String getChannel()

The channel which this query is for.

If unspecified, the ResponseMessage with unspecified channel will be returned.

string channel = 15;

Returns
Type	Description
`String`	The channel.

getChannelBytes()

public ByteString getChannelBytes()

The channel which this query is for.

If unspecified, the ResponseMessage with unspecified channel will be returned.

string channel = 15;

Returns
Type	Description
`ByteString`	The bytes for channel.

getCurrentPage()

public String getCurrentPage()

The unique identifier of the page to override the current page in the session. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

string current_page = 6 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The currentPage.

getCurrentPageBytes()

public ByteString getCurrentPageBytes()

The unique identifier of the page to override the current page in the session. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

string current_page = 6 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for currentPage.

getCurrentPlaybook()

public String getCurrentPlaybook()

Optional. Start the session with the specified playbook. You can only specify the playbook at the beginning of the session. Otherwise, an error will be thrown.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>.

string current_playbook = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The currentPlaybook.

getCurrentPlaybookBytes()

public ByteString getCurrentPlaybookBytes()

Optional. Start the session with the specified playbook. You can only specify the playbook at the beginning of the session. Otherwise, an error will be thrown.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>.

string current_playbook = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for currentPlaybook.

getDefaultInstanceForType()

public QueryParameters getDefaultInstanceForType()

Returns
Type	Description
`QueryParameters`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisableWebhook()

public boolean getDisableWebhook()

Whether to disable webhook calls for this request.

bool disable_webhook = 7;

Returns
Type	Description
`boolean`	The disableWebhook.

getEndUserMetadata()

public Struct getEndUserMetadata()

Optional. Information about the end-user to improve the relevance and accuracy of generative answers.

This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure.

Example:

<code><code>json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } </code></code>

.google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Struct`	The endUserMetadata.

getEndUserMetadataBuilder()

public Struct.Builder getEndUserMetadataBuilder()

Optional. Information about the end-user to improve the relevance and accuracy of generative answers.

This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure.

Example:

<code><code>json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } </code></code>

.google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Builder`

getEndUserMetadataOrBuilder()

public StructOrBuilder getEndUserMetadataOrBuilder()

Optional. Information about the end-user to improve the relevance and accuracy of generative answers.

This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure.

Example:

<code><code>json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } </code></code>

.google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`StructOrBuilder`

getFlowVersions(int index)

public String getFlowVersions(int index)

A list of flow versions to override for the request. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The flowVersions at the given index.

getFlowVersionsBytes(int index)

public ByteString getFlowVersionsBytes(int index)

A list of flow versions to override for the request. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the flowVersions at the given index.

getFlowVersionsCount()

public int getFlowVersionsCount()

A list of flow versions to override for the request. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`int`	The count of flowVersions.

getFlowVersionsList()

public ProtocolStringList getFlowVersionsList()

A list of flow versions to override for the request. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`ProtocolStringList`	A list containing the flowVersions.

getGeoLocation()

public LatLng getGeoLocation()

The geo location of this conversational query.

.google.type.LatLng geo_location = 2;

Returns
Type	Description
`com.google.type.LatLng`	The geoLocation.

getGeoLocationBuilder()

public LatLng.Builder getGeoLocationBuilder()

The geo location of this conversational query.

.google.type.LatLng geo_location = 2;

Returns
Type	Description
`com.google.type.LatLng.Builder`

getGeoLocationOrBuilder()

public LatLngOrBuilder getGeoLocationOrBuilder()

The geo location of this conversational query.

.google.type.LatLng geo_location = 2;

Returns
Type	Description
`com.google.type.LatLngOrBuilder`

getLlmModelSettings()

public LlmModelSettings getLlmModelSettings()

Optional. Use the specified LLM model settings for processing the request.

.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`LlmModelSettings`	The llmModelSettings.

getLlmModelSettingsBuilder()

public LlmModelSettings.Builder getLlmModelSettingsBuilder()

Optional. Use the specified LLM model settings for processing the request.

.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`LlmModelSettings.Builder`

getLlmModelSettingsOrBuilder()

public LlmModelSettingsOrBuilder getLlmModelSettingsOrBuilder()

Optional. Use the specified LLM model settings for processing the request.

.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`LlmModelSettingsOrBuilder`

getMutableWebhookHeaders() (deprecated)

public Map<String,String> getMutableWebhookHeaders()

Use alternate mutation accessors instead.

Returns
Type	Description
`Map<String,String>`

getParameters()

public Struct getParameters()

Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

You can reference the session parameters in the agent with the following format: $session.params.parameter-id.

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 = 5;

Returns
Type	Description
`Struct`	The parameters.

getParametersBuilder()

public Struct.Builder getParametersBuilder()

Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

You can reference the session parameters in the agent with the following format: $session.params.parameter-id.

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 = 5;

Returns
Type	Description
`Builder`

getParametersOrBuilder()

public StructOrBuilder getParametersOrBuilder()

Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

You can reference the session parameters in the agent with the following format: $session.params.parameter-id.

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 = 5;

Returns
Type	Description
`StructOrBuilder`

getPayload()

public Struct getPayload()

.google.protobuf.Struct payload = 4;

Returns
Type	Description
`Struct`	The payload.

getPayloadBuilder()

public Struct.Builder getPayloadBuilder()

.google.protobuf.Struct payload = 4;

Returns
Type	Description
`Builder`

getPayloadOrBuilder()

public StructOrBuilder getPayloadOrBuilder()

.google.protobuf.Struct payload = 4;

Returns
Type	Description
`StructOrBuilder`

getPopulateDataStoreConnectionSignals()

public boolean getPopulateDataStoreConnectionSignals()

Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations.

bool populate_data_store_connection_signals = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	The populateDataStoreConnectionSignals.

getSearchConfig()

public SearchConfig getSearchConfig()

Optional. Search configuration for UCS search queries.

.google.cloud.dialogflow.cx.v3beta1.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`SearchConfig`	The searchConfig.

getSearchConfigBuilder()

public SearchConfig.Builder getSearchConfigBuilder()

Optional. Search configuration for UCS search queries.

.google.cloud.dialogflow.cx.v3beta1.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`SearchConfig.Builder`

getSearchConfigOrBuilder()

public SearchConfigOrBuilder getSearchConfigOrBuilder()

Optional. Search configuration for UCS search queries.

.google.cloud.dialogflow.cx.v3beta1.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`SearchConfigOrBuilder`

getSessionEntityTypes(int index)

public SessionEntityType getSessionEntityTypes(int index)

Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.

repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SessionEntityType`

getSessionEntityTypesBuilder(int index)

public SessionEntityType.Builder getSessionEntityTypesBuilder(int index)

Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.

repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SessionEntityType.Builder`

getSessionEntityTypesBuilderList()

public List<SessionEntityType.Builder> getSessionEntityTypesBuilderList()

Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.

repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

Returns
Type	Description
`List<Builder>`

getSessionEntityTypesCount()

public int getSessionEntityTypesCount()

Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.

repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

Returns
Type	Description
`int`

getSessionEntityTypesList()

public List<SessionEntityType> getSessionEntityTypesList()

Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.

repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

Returns
Type	Description
`List<SessionEntityType>`

getSessionEntityTypesOrBuilder(int index)

public SessionEntityTypeOrBuilder getSessionEntityTypesOrBuilder(int index)

Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.

repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SessionEntityTypeOrBuilder`

getSessionEntityTypesOrBuilderList()

public List<? extends SessionEntityTypeOrBuilder> getSessionEntityTypesOrBuilderList()

Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.

repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

Returns
Type	Description
`List<? extends com.google.cloud.dialogflow.cx.v3beta1.SessionEntityTypeOrBuilder>`

getSessionTtl()

public Duration getSessionTtl()

.google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Duration`	The sessionTtl.

getSessionTtlBuilder()

public Duration.Builder getSessionTtlBuilder()

.google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Builder`

getSessionTtlOrBuilder()

public DurationOrBuilder getSessionTtlOrBuilder()

.google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`DurationOrBuilder`

getTimeZone()

public String getTimeZone()

The time zone of this conversational query from the time zone database, e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in the agent is used.

string time_zone = 1;

Returns
Type	Description
`String`	The timeZone.

getTimeZoneBytes()

public ByteString getTimeZoneBytes()

The time zone of this conversational query from the time zone database, e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in the agent is used.

string time_zone = 1;

Returns
Type	Description
`ByteString`	The bytes for timeZone.

getWebhookHeaders() (deprecated)

public Map<String,String> getWebhookHeaders()

Use #getWebhookHeadersMap() instead.

Returns
Type	Description
`Map<String,String>`

getWebhookHeadersCount()

public int getWebhookHeadersCount()

map<string, string> webhook_headers = 10;

Returns
Type	Description
`int`

getWebhookHeadersMap()

public Map<String,String> getWebhookHeadersMap()

map<string, string> webhook_headers = 10;

Returns
Type	Description
`Map<String,String>`

getWebhookHeadersOrDefault(String key, String defaultValue)

public String getWebhookHeadersOrDefault(String key, String defaultValue)

map<string, string> webhook_headers = 10;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getWebhookHeadersOrThrow(String key)

public String getWebhookHeadersOrThrow(String key)

map<string, string> webhook_headers = 10;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

hasEndUserMetadata()

public boolean hasEndUserMetadata()

Optional. Information about the end-user to improve the relevance and accuracy of generative answers.

This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure.

Example:

<code><code>json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } </code></code>

.google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the endUserMetadata field is set.

hasGeoLocation()

public boolean hasGeoLocation()

The geo location of this conversational query.

.google.type.LatLng geo_location = 2;

Returns
Type	Description
`boolean`	Whether the geoLocation field is set.

hasLlmModelSettings()

public boolean hasLlmModelSettings()

Optional. Use the specified LLM model settings for processing the request.

.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the llmModelSettings field is set.

hasParameters()

public boolean hasParameters()

Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

You can reference the session parameters in the agent with the following format: $session.params.parameter-id.

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 = 5;

Returns
Type	Description
`boolean`	Whether the parameters field is set.

hasPayload()

public boolean hasPayload()

.google.protobuf.Struct payload = 4;

Returns
Type	Description
`boolean`	Whether the payload field is set.

hasSearchConfig()

public boolean hasSearchConfig()

Optional. Search configuration for UCS search queries.

.google.cloud.dialogflow.cx.v3beta1.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the searchConfig field is set.

hasSessionTtl()

public boolean hasSessionTtl()

.google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the sessionTtl field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`com.google.protobuf.MapFieldReflectionAccessor`

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`com.google.protobuf.MapFieldReflectionAccessor`

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeEndUserMetadata(Struct value)

public QueryParameters.Builder mergeEndUserMetadata(Struct value)

Optional. Information about the end-user to improve the relevance and accuracy of generative answers.

This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure.

Example:

<code><code>json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } </code></code>

.google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Struct`

Returns
Type	Description
`QueryParameters.Builder`

mergeFrom(QueryParameters other)

public QueryParameters.Builder mergeFrom(QueryParameters other)

Parameter
Name	Description
`other`	`QueryParameters`

Returns
Type	Description
`QueryParameters.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public QueryParameters.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`QueryParameters.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public QueryParameters.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`QueryParameters.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeGeoLocation(LatLng value)

public QueryParameters.Builder mergeGeoLocation(LatLng value)

The geo location of this conversational query.

.google.type.LatLng geo_location = 2;

Parameter
Name	Description
`value`	`com.google.type.LatLng`

Returns
Type	Description
`QueryParameters.Builder`

mergeLlmModelSettings(LlmModelSettings value)

public QueryParameters.Builder mergeLlmModelSettings(LlmModelSettings value)

Optional. Use the specified LLM model settings for processing the request.

.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 21 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`LlmModelSettings`

Returns
Type	Description
`QueryParameters.Builder`

mergeParameters(Struct value)

public QueryParameters.Builder mergeParameters(Struct value)

Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

You can reference the session parameters in the agent with the following format: $session.params.parameter-id.

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 = 5;

Parameter
Name	Description
`value`	`Struct`

Returns
Type	Description
`QueryParameters.Builder`

mergePayload(Struct value)

public QueryParameters.Builder mergePayload(Struct value)

.google.protobuf.Struct payload = 4;

Parameter
Name	Description
`value`	`Struct`

Returns
Type	Description
`QueryParameters.Builder`

mergeSearchConfig(SearchConfig value)

public QueryParameters.Builder mergeSearchConfig(SearchConfig value)

Optional. Search configuration for UCS search queries.

.google.cloud.dialogflow.cx.v3beta1.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`SearchConfig`

Returns
Type	Description
`QueryParameters.Builder`

mergeSessionTtl(Duration value)

public QueryParameters.Builder mergeSessionTtl(Duration value)

.google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Duration`

Returns
Type	Description
`QueryParameters.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final QueryParameters.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`QueryParameters.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

putAllWebhookHeaders(Map<String,String> values)

public QueryParameters.Builder putAllWebhookHeaders(Map<String,String> values)

map<string, string> webhook_headers = 10;

Parameter
Name	Description
`values`	`Map<String,String>`

Returns
Type	Description
`QueryParameters.Builder`

putWebhookHeaders(String key, String value)

public QueryParameters.Builder putWebhookHeaders(String key, String value)

map<string, string> webhook_headers = 10;

Parameters
Name	Description
`key`	`String`
`value`	`String`

Returns
Type	Description
`QueryParameters.Builder`

removeSessionEntityTypes(int index)

public QueryParameters.Builder removeSessionEntityTypes(int index)

Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.

repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`QueryParameters.Builder`

removeWebhookHeaders(String key)

public QueryParameters.Builder removeWebhookHeaders(String key)

map<string, string> webhook_headers = 10;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`QueryParameters.Builder`

setAnalyzeQueryTextSentiment(boolean value)

public QueryParameters.Builder setAnalyzeQueryTextSentiment(boolean value)

Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.

bool analyze_query_text_sentiment = 8;

Parameter
Name	Description
`value`	`boolean` The analyzeQueryTextSentiment to set.

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

setChannel(String value)

public QueryParameters.Builder setChannel(String value)

The channel which this query is for.

If unspecified, the ResponseMessage with unspecified channel will be returned.

string channel = 15;

Parameter
Name	Description
`value`	`String` The channel to set.

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

setChannelBytes(ByteString value)

public QueryParameters.Builder setChannelBytes(ByteString value)

The channel which this query is for.

If unspecified, the ResponseMessage with unspecified channel will be returned.

string channel = 15;

Parameter
Name	Description
`value`	`ByteString` The bytes for channel to set.

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

setCurrentPage(String value)

public QueryParameters.Builder setCurrentPage(String value)

The unique identifier of the page to override the current page in the session. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

string current_page = 6 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`String` The currentPage to set.

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

setCurrentPageBytes(ByteString value)

public QueryParameters.Builder setCurrentPageBytes(ByteString value)

The unique identifier of the page to override the current page in the session. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

string current_page = 6 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`ByteString` The bytes for currentPage to set.

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

setCurrentPlaybook(String value)

public QueryParameters.Builder setCurrentPlaybook(String value)

Optional. Start the session with the specified playbook. You can only specify the playbook at the beginning of the session. Otherwise, an error will be thrown.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>.

string current_playbook = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`String` The currentPlaybook to set.

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

setCurrentPlaybookBytes(ByteString value)

public QueryParameters.Builder setCurrentPlaybookBytes(ByteString value)

Optional. Start the session with the specified playbook. You can only specify the playbook at the beginning of the session. Otherwise, an error will be thrown.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>.

string current_playbook = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`ByteString` The bytes for currentPlaybook to set.

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

setDisableWebhook(boolean value)

public QueryParameters.Builder setDisableWebhook(boolean value)

Whether to disable webhook calls for this request.

bool disable_webhook = 7;

Parameter
Name	Description
`value`	`boolean` The disableWebhook to set.

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

setEndUserMetadata(Struct value)

public QueryParameters.Builder setEndUserMetadata(Struct value)

Optional. Information about the end-user to improve the relevance and accuracy of generative answers.

This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure.

Example:

<code><code>json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } </code></code>

.google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Struct`

Returns
Type	Description
`QueryParameters.Builder`

setEndUserMetadata(Struct.Builder builderForValue)

public QueryParameters.Builder setEndUserMetadata(Struct.Builder builderForValue)

Optional. Information about the end-user to improve the relevance and accuracy of generative answers.

This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure.

Example:

<code><code>json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } </code></code>

.google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`QueryParameters.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public QueryParameters.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`QueryParameters.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFlowVersions(int index, String value)

public QueryParameters.Builder setFlowVersions(int index, String value)

A list of flow versions to override for the request. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The flowVersions to set.

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

setGeoLocation(LatLng value)

public QueryParameters.Builder setGeoLocation(LatLng value)

The geo location of this conversational query.

.google.type.LatLng geo_location = 2;

Parameter
Name	Description
`value`	`com.google.type.LatLng`

Returns
Type	Description
`QueryParameters.Builder`

setGeoLocation(LatLng.Builder builderForValue)

public QueryParameters.Builder setGeoLocation(LatLng.Builder builderForValue)

The geo location of this conversational query.

.google.type.LatLng geo_location = 2;

Parameter
Name	Description
`builderForValue`	`com.google.type.LatLng.Builder`

Returns
Type	Description
`QueryParameters.Builder`

setLlmModelSettings(LlmModelSettings value)

public QueryParameters.Builder setLlmModelSettings(LlmModelSettings value)

Optional. Use the specified LLM model settings for processing the request.

.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 21 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`LlmModelSettings`

Returns
Type	Description
`QueryParameters.Builder`

setLlmModelSettings(LlmModelSettings.Builder builderForValue)

public QueryParameters.Builder setLlmModelSettings(LlmModelSettings.Builder builderForValue)

Optional. Use the specified LLM model settings for processing the request.

.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 21 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`LlmModelSettings.Builder`

Returns
Type	Description
`QueryParameters.Builder`

setParameters(Struct value)

public QueryParameters.Builder setParameters(Struct value)

Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

You can reference the session parameters in the agent with the following format: $session.params.parameter-id.

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 = 5;

Parameter
Name	Description
`value`	`Struct`

Returns
Type	Description
`QueryParameters.Builder`

setParameters(Struct.Builder builderForValue)

public QueryParameters.Builder setParameters(Struct.Builder builderForValue)

Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

You can reference the session parameters in the agent with the following format: $session.params.parameter-id.

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 = 5;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`QueryParameters.Builder`

setPayload(Struct value)

public QueryParameters.Builder setPayload(Struct value)

.google.protobuf.Struct payload = 4;

Parameter
Name	Description
`value`	`Struct`

Returns
Type	Description
`QueryParameters.Builder`

setPayload(Struct.Builder builderForValue)

public QueryParameters.Builder setPayload(Struct.Builder builderForValue)

.google.protobuf.Struct payload = 4;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`QueryParameters.Builder`

setPopulateDataStoreConnectionSignals(boolean value)

public QueryParameters.Builder setPopulateDataStoreConnectionSignals(boolean value)

Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations.

bool populate_data_store_connection_signals = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`boolean` The populateDataStoreConnectionSignals to set.

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`QueryParameters.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSearchConfig(SearchConfig value)

public QueryParameters.Builder setSearchConfig(SearchConfig value)

Optional. Search configuration for UCS search queries.

.google.cloud.dialogflow.cx.v3beta1.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`SearchConfig`

Returns
Type	Description
`QueryParameters.Builder`

setSearchConfig(SearchConfig.Builder builderForValue)

public QueryParameters.Builder setSearchConfig(SearchConfig.Builder builderForValue)

Optional. Search configuration for UCS search queries.

.google.cloud.dialogflow.cx.v3beta1.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`SearchConfig.Builder`

Returns
Type	Description
`QueryParameters.Builder`

setSessionEntityTypes(int index, SessionEntityType value)

public QueryParameters.Builder setSessionEntityTypes(int index, SessionEntityType value)

Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.

repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

Parameters
Name	Description
`index`	`int`
`value`	`SessionEntityType`

Returns
Type	Description
`QueryParameters.Builder`

setSessionEntityTypes(int index, SessionEntityType.Builder builderForValue)

public QueryParameters.Builder setSessionEntityTypes(int index, SessionEntityType.Builder builderForValue)

Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.

repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`SessionEntityType.Builder`

Returns
Type	Description
`QueryParameters.Builder`

setSessionTtl(Duration value)

public QueryParameters.Builder setSessionTtl(Duration value)

.google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Duration`

Returns
Type	Description
`QueryParameters.Builder`

setSessionTtl(Duration.Builder builderForValue)

public QueryParameters.Builder setSessionTtl(Duration.Builder builderForValue)

.google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`QueryParameters.Builder`

setTimeZone(String value)

public QueryParameters.Builder setTimeZone(String value)

The time zone of this conversational query from the time zone database, e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in the agent is used.

string time_zone = 1;

Parameter
Name	Description
`value`	`String` The timeZone to set.

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

setTimeZoneBytes(ByteString value)

public QueryParameters.Builder setTimeZoneBytes(ByteString value)

The time zone of this conversational query from the time zone database, e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in the agent is used.

string time_zone = 1;

Parameter
Name	Description
`value`	`ByteString` The bytes for timeZone to set.

Returns
Type	Description
`QueryParameters.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final QueryParameters.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`QueryParameters.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)