Class QueryParameters (0.62.0) 

public final class QueryParameters extends GeneratedMessageV3 implements QueryParametersOrBuilder

Represents the parameters of a conversational query.

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

Inheritance

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

Static Fields

ANALYZE_QUERY_TEXT_SENTIMENT_FIELD_NUMBER

public static final int ANALYZE_QUERY_TEXT_SENTIMENT_FIELD_NUMBER
Field Value
Type Description
int

CHANNEL_FIELD_NUMBER

public static final int CHANNEL_FIELD_NUMBER
Field Value
Type Description
int

CURRENT_PAGE_FIELD_NUMBER

public static final int CURRENT_PAGE_FIELD_NUMBER
Field Value
Type Description
int

CURRENT_PLAYBOOK_FIELD_NUMBER

public static final int CURRENT_PLAYBOOK_FIELD_NUMBER
Field Value
Type Description
int

DISABLE_WEBHOOK_FIELD_NUMBER

public static final int DISABLE_WEBHOOK_FIELD_NUMBER
Field Value
Type Description
int

END_USER_METADATA_FIELD_NUMBER

public static final int END_USER_METADATA_FIELD_NUMBER
Field Value
Type Description
int

FLOW_VERSIONS_FIELD_NUMBER

public static final int FLOW_VERSIONS_FIELD_NUMBER
Field Value
Type Description
int

GEO_LOCATION_FIELD_NUMBER

public static final int GEO_LOCATION_FIELD_NUMBER
Field Value
Type Description
int

LLM_MODEL_SETTINGS_FIELD_NUMBER

public static final int LLM_MODEL_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

PAYLOAD_FIELD_NUMBER

public static final int PAYLOAD_FIELD_NUMBER
Field Value
Type Description
int

POPULATE_DATA_STORE_CONNECTION_SIGNALS_FIELD_NUMBER

public static final int POPULATE_DATA_STORE_CONNECTION_SIGNALS_FIELD_NUMBER
Field Value
Type Description
int

SEARCH_CONFIG_FIELD_NUMBER

public static final int SEARCH_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

SESSION_ENTITY_TYPES_FIELD_NUMBER

public static final int SESSION_ENTITY_TYPES_FIELD_NUMBER
Field Value
Type Description
int

SESSION_TTL_FIELD_NUMBER

public static final int SESSION_TTL_FIELD_NUMBER
Field Value
Type Description
int

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER
Field Value
Type Description
int

WEBHOOK_HEADERS_FIELD_NUMBER

public static final int WEBHOOK_HEADERS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static QueryParameters getDefaultInstance()
Returns
Type Description
QueryParameters

getDescriptor()

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

newBuilder()

public static QueryParameters.Builder newBuilder()
Returns
Type Description
QueryParameters.Builder

newBuilder(QueryParameters prototype)

public static QueryParameters.Builder newBuilder(QueryParameters prototype)
Parameter
Name Description
prototype QueryParameters
Returns
Type Description
QueryParameters.Builder

parseDelimitedFrom(InputStream input)

public static QueryParameters parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QueryParameters
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryParameters parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryParameters
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static QueryParameters parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
QueryParameters
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static QueryParameters parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryParameters
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static QueryParameters parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
QueryParameters
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static QueryParameters parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryParameters
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static QueryParameters parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
QueryParameters
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryParameters parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryParameters
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static QueryParameters parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QueryParameters
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryParameters parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryParameters
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static QueryParameters parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
QueryParameters
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static QueryParameters parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryParameters
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<QueryParameters> parser()
Returns
Type Description
Parser<QueryParameters>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

The channel.

getChannelBytes()

public ByteString getChannelBytes()

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

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

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

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.

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

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

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

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

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

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

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.

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.

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

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.

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

getParserForType()

public Parser<QueryParameters> getParserForType()
Returns
Type Description
Parser<QueryParameters>
Overrides

getPayload()

public Struct getPayload()

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
Struct

The payload.

getPayloadOrBuilder()

public StructOrBuilder getPayloadOrBuilder()

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

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

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()

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
Duration

The sessionTtl.

getSessionTtlOrBuilder()

public DurationOrBuilder getSessionTtlOrBuilder()

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
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()

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;

Returns
Type Description
int

getWebhookHeadersMap()

public Map<String,String> getWebhookHeadersMap()

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;

Returns
Type Description
Map<String,String>

getWebhookHeadersOrDefault(String key, String defaultValue)

public String getWebhookHeadersOrDefault(String key, String defaultValue)

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;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getWebhookHeadersOrThrow(String key)

public String getWebhookHeadersOrThrow(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
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()

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
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()

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
boolean

Whether the sessionTtl field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public QueryParameters.Builder newBuilderForType()
Returns
Type Description
QueryParameters.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected QueryParameters.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
QueryParameters.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public QueryParameters.Builder toBuilder()
Returns
Type Description
QueryParameters.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException