Class: Google::Cloud::Dialogflow::CX::V3::QueryParameters

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/cx/v3/session.rb

Overview

Represents the parameters of a conversational query.

Defined Under Namespace

Classes: WebhookHeadersEntry

Instance Attribute Summary collapse

Instance Attribute Details

#analyze_query_text_sentiment ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

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



614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 614

class QueryParameters
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebhookHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#channel ⇒ ::String

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

Returns:

  • (::String) —

    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.



614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 614

class QueryParameters
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebhookHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#current_page ⇒ ::String

Returns The unique identifier of the 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 and parameters should be configured together to direct a session to a specific state.

Returns:

  • (::String) —

    The unique identifier of the 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 and parameters should be configured together to direct a session to a specific state.



614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 614

class QueryParameters
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebhookHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#disable_webhook ⇒ ::Boolean

Returns Whether to disable webhook calls for this request.

Returns:

  • (::Boolean) —

    Whether to disable webhook calls for this request.



614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 614

class QueryParameters
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebhookHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#end_user_metadata ⇒ ::Google::Protobuf::Struct

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

{
  "subscription plan": "Business Premium Plus",
  "devices owned": [
    \\{"model": "Google Pixel 7"},
    \\{"model": "Google Pixel Tablet"}
  ]
}
```.

Returns:

  • (::Google::Protobuf::Struct) —

    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:

    {
  "subscription plan": "Business Premium Plus",
  "devices owned": [
    \\{"model": "Google Pixel 7"},
    \\{"model": "Google Pixel Tablet"}
  ]
}



614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 614

class QueryParameters
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebhookHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#flow_versions ⇒ ::Array<::String>

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

Returns:

  • (::Array<::String>) —

    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.



614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 614

class QueryParameters
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebhookHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#geo_location ⇒ ::Google::Type::LatLng

Returns The geo location of this conversational query.

Returns:



614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 614

class QueryParameters
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebhookHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#parameters ⇒ ::Google::Protobuf::Struct

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

Returns:

  • (::Google::Protobuf::Struct) —

    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.


614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 614

class QueryParameters
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebhookHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#payload ⇒ ::Google::Protobuf::Struct

Returns 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"
 }
}
```.

Returns:

  • (::Google::Protobuf::Struct) —

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



614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 614

class QueryParameters
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebhookHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#populate_data_store_connection_signals ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

    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.



614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 614

class QueryParameters
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebhookHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#search_config ⇒ ::Google::Cloud::Dialogflow::CX::V3::SearchConfig

Returns Optional. Search configuration for UCS search queries.

Returns:



614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 614

class QueryParameters
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebhookHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#session_entity_types ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::SessionEntityType>

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

Returns:



614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 614

class QueryParameters
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebhookHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#session_ttl ⇒ ::Google::Protobuf::Duration

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

Returns:

  • (::Google::Protobuf::Duration) —

    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.



614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 614

class QueryParameters
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebhookHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#time_zone ⇒ ::String

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

Returns:

  • (::String) —

    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.



614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 614

class QueryParameters
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebhookHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#webhook_headers ⇒ ::Google::Protobuf::Map{::String => ::String}

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

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    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.



614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 614

class QueryParameters
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class WebhookHeadersEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end