Package com.google.cloud.dialogflow.cx.v3beta1

Interface QueryParametersOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
QueryParameters, QueryParameters.Builder
@Generated public interface QueryParametersOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getTimeZone

      String getTimeZone()
       The time zone of this conversational query from the [time zone
 database](https://www.iana.org/time-zones), e.g., America/New_York,
 Europe/Paris. If not provided, the time zone specified in the agent is
 used.
      string time_zone = 1;
      Returns:
      The timeZone.

    • getTimeZoneBytes

      com.google.protobuf.ByteString getTimeZoneBytes()
       The time zone of this conversational query from the [time zone
 database](https://www.iana.org/time-zones), e.g., America/New_York,
 Europe/Paris. If not provided, the time zone specified in the agent is
 used.
      string time_zone = 1;
      Returns:
      The bytes for timeZone.

    • hasGeoLocation

      boolean hasGeoLocation()
       The geo location of this conversational query.
      .google.type.LatLng geo_location = 2;
      Returns:
      Whether the geoLocation field is set.

    • getGeoLocation

      LatLng getGeoLocation()
       The geo location of this conversational query.
      .google.type.LatLng geo_location = 2;
      Returns:
      The geoLocation.

    • getGeoLocationOrBuilder

      LatLngOrBuilder getGeoLocationOrBuilder()
       The geo location of this conversational query.
      .google.type.LatLng geo_location = 2;

    • getSessionEntityTypesList

      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;

    • getSessionEntityTypes

      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;

    • getSessionEntityTypesCount

      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;

    • getSessionEntityTypesOrBuilderList

      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;

    • getSessionEntityTypesOrBuilder

      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;

    • hasPayload

      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:
 ```
 {
 "telephony": {
 "caller_id": "+18558363987"
 }
 }
 ```
      .google.protobuf.Struct payload = 4;
      Returns:
      Whether the payload field is set.

    • getPayload

      com.google.protobuf.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:
 ```
 {
 "telephony": {
 "caller_id": "+18558363987"
 }
 }
 ```
      .google.protobuf.Struct payload = 4;
      Returns:
      The payload.

    • getPayloadOrBuilder

      com.google.protobuf.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:
 ```
 {
 "telephony": {
 "caller_id": "+18558363987"
 }
 }
 ```
      .google.protobuf.Struct payload = 4;

    • hasParameters

      boolean hasParameters()
       Additional parameters to be put into [session
 parameters][SessionInfo.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:
      Whether the parameters field is set.

    • getParameters

      com.google.protobuf.Struct getParameters()
       Additional parameters to be put into [session
 parameters][SessionInfo.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:
      The parameters.

    • getParametersOrBuilder

      com.google.protobuf.StructOrBuilder getParametersOrBuilder()
       Additional parameters to be put into [session
 parameters][SessionInfo.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;

    • getParameterScope

      String getParameterScope()
       Scope for the parameters. If not specified, parameters will be treated as
 session parameters. Parameters with custom scope will not be put into
 [session
 parameters][google.cloud.dialogflow.cx.v3beta1.SessionInfo.parameters].

 You can reference the parameters with custom scope in the agent with the
 following format: $parameter-scope.params.parameter-id.
      string parameter_scope = 12;
      Returns:
      The parameterScope.

    • getParameterScopeBytes

      com.google.protobuf.ByteString getParameterScopeBytes()
       Scope for the parameters. If not specified, parameters will be treated as
 session parameters. Parameters with custom scope will not be put into
 [session
 parameters][google.cloud.dialogflow.cx.v3beta1.SessionInfo.parameters].

 You can reference the parameters with custom scope in the agent with the
 following format: $parameter-scope.params.parameter-id.
      string parameter_scope = 12;
      Returns:
      The bytes for parameterScope.

    • getCurrentPage

      String getCurrentPage()
       The unique identifier of the
 [page][google.cloud.dialogflow.cx.v3beta1.Page] to override the [current
 page][QueryResult.current_page] in the session.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.

 If `current_page` is specified, the previous state of the session will be
 ignored by Dialogflow, including the [previous
 page][QueryResult.current_page] and the [previous session
 parameters][QueryResult.parameters].
 In most cases,
 [current_page][google.cloud.dialogflow.cx.v3beta1.QueryParameters.current_page]
 and
 [parameters][google.cloud.dialogflow.cx.v3beta1.QueryParameters.parameters]
 should be configured together to direct a session to a specific state.
      string current_page = 6 [(.google.api.resource_reference) = { ... }
      Returns:
      The currentPage.

    • getCurrentPageBytes

      com.google.protobuf.ByteString getCurrentPageBytes()
       The unique identifier of the
 [page][google.cloud.dialogflow.cx.v3beta1.Page] to override the [current
 page][QueryResult.current_page] in the session.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.

 If `current_page` is specified, the previous state of the session will be
 ignored by Dialogflow, including the [previous
 page][QueryResult.current_page] and the [previous session
 parameters][QueryResult.parameters].
 In most cases,
 [current_page][google.cloud.dialogflow.cx.v3beta1.QueryParameters.current_page]
 and
 [parameters][google.cloud.dialogflow.cx.v3beta1.QueryParameters.parameters]
 should be configured together to direct a session to a specific state.
      string current_page = 6 [(.google.api.resource_reference) = { ... }
      Returns:
      The bytes for currentPage.

    • getDisableWebhook

      boolean getDisableWebhook()
       Whether to disable webhook calls for this request.
      bool disable_webhook = 7;
      Returns:
      The disableWebhook.

    • getAnalyzeQueryTextSentiment

      boolean getAnalyzeQueryTextSentiment()
       Configures whether sentiment analysis should be performed. If not
 provided, sentiment analysis is not performed.
      bool analyze_query_text_sentiment = 8;
      Returns:
      The analyzeQueryTextSentiment.

    • getWebhookHeadersCount

      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;

    • containsWebhookHeaders

      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;

    • getWebhookHeaders

      @Deprecated Map<String,String> getWebhookHeaders()
      Deprecated.
      Use getWebhookHeadersMap() instead.

    • getWebhookHeadersMap

      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;

    • getWebhookHeadersOrDefault

      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;

    • getWebhookHeadersOrThrow

      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;

    • getFlowVersionsList

      List<String> getFlowVersionsList()
       A list of flow versions to override for the request.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.

 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:
      A list containing the flowVersions.

    • getFlowVersionsCount

      int getFlowVersionsCount()
       A list of flow versions to override for the request.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.

 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:
      The count of flowVersions.

    • getFlowVersions

      String getFlowVersions(int index)
       A list of flow versions to override for the request.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.

 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) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The flowVersions at the given index.

    • getFlowVersionsBytes

      com.google.protobuf.ByteString getFlowVersionsBytes(int index)
       A list of flow versions to override for the request.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.

 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) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the flowVersions at the given index.

    • getCurrentPlaybook

      String getCurrentPlaybook()
       Optional. The unique identifier of the
 [playbook][google.cloud.dialogflow.cx.v3beta1.Playbook] to start or
 continue the session with. If `current_playbook` is specified, the previous
 state of the session will be ignored by Dialogflow.

 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
      string current_playbook = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      The currentPlaybook.

    • getCurrentPlaybookBytes

      com.google.protobuf.ByteString getCurrentPlaybookBytes()
       Optional. The unique identifier of the
 [playbook][google.cloud.dialogflow.cx.v3beta1.Playbook] to start or
 continue the session with. If `current_playbook` is specified, the previous
 state of the session will be ignored by Dialogflow.

 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
      string current_playbook = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for currentPlaybook.

    • hasLlmModelSettings

      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:
      Whether the llmModelSettings field is set.

    • getLlmModelSettings

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

    • getLlmModelSettingsOrBuilder

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

    • getChannel

      String getChannel()
       The channel which this query is for.

 If specified, only the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage]
 associated with the channel will be returned. If no
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] is
 associated with the channel, it falls back to the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] with
 unspecified channel.

 If unspecified, the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] with
 unspecified channel will be returned.
      string channel = 15;
      Returns:
      The channel.

    • getChannelBytes

      com.google.protobuf.ByteString getChannelBytes()
       The channel which this query is for.

 If specified, only the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage]
 associated with the channel will be returned. If no
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] is
 associated with the channel, it falls back to the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] with
 unspecified channel.

 If unspecified, the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] with
 unspecified channel will be returned.
      string channel = 15;
      Returns:
      The bytes for channel.

    • hasSessionTtl

      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:
      Whether the sessionTtl field is set.

    • getSessionTtl

      com.google.protobuf.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:
      The sessionTtl.

    • getSessionTtlOrBuilder

      com.google.protobuf.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];

    • hasEndUserMetadata

      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:

 ```json
 {
 "subscription plan": "Business Premium Plus",
 "devices owned": [
 {"model": "Google Pixel 7"},
 {"model": "Google Pixel Tablet"}
 ]
 }
 ```
      .google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the endUserMetadata field is set.

    • getEndUserMetadata

      com.google.protobuf.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:

 ```json
 {
 "subscription plan": "Business Premium Plus",
 "devices owned": [
 {"model": "Google Pixel 7"},
 {"model": "Google Pixel Tablet"}
 ]
 }
 ```
      .google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The endUserMetadata.

    • getEndUserMetadataOrBuilder

      com.google.protobuf.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:

 ```json
 {
 "subscription plan": "Business Premium Plus",
 "devices owned": [
 {"model": "Google Pixel 7"},
 {"model": "Google Pixel Tablet"}
 ]
 }
 ```
      .google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];

    • hasSearchConfig

      boolean hasSearchConfig()
       Optional. Search configuration for UCS search queries.
      .google.cloud.dialogflow.cx.v3beta1.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the searchConfig field is set.

    • getSearchConfig

      SearchConfig getSearchConfig()
       Optional. Search configuration for UCS search queries.
      .google.cloud.dialogflow.cx.v3beta1.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The searchConfig.

    • getSearchConfigOrBuilder

      SearchConfigOrBuilder getSearchConfigOrBuilder()
       Optional. Search configuration for UCS search queries.
      .google.cloud.dialogflow.cx.v3beta1.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];

    • getPopulateDataStoreConnectionSignals

      @Deprecated boolean getPopulateDataStoreConnectionSignals()
      Deprecated.
      google.cloud.dialogflow.cx.v3beta1.QueryParameters.populate_data_store_connection_signals is deprecated. See google/cloud/dialogflow/cx/v3beta1/session.proto;l=775
       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 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The populateDataStoreConnectionSignals.