Class: Google::Cloud::Dialogflow::V2::QueryParameters

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

Overview

Represents the parameters of the conversational query.

Defined Under Namespace

Classes: WebhookHeadersEntry

Instance Attribute Summary collapse

Instance Attribute Details

#contexts ⇒ ::Array<::Google::Cloud::Dialogflow::V2::Context>

Returns The collection of contexts to be activated before this query is executed.

Returns:



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 166

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:



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 166

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 to your webhook. Arbitrary JSON objects are supported. If supplied, the value is used to populate the WebhookRequest.original_detect_intent_request.payload field sent to your webhook.

Returns:

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

    This field can be used to pass custom data to your webhook. Arbitrary JSON objects are supported. If supplied, the value is used to populate the WebhookRequest.original_detect_intent_request.payload field sent to your webhook.



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 166

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

#platform ⇒ ::String

Returns The platform of the virtual agent response messages.

If not empty, only emits messages from this platform in the response. Valid values are the enum names of platform.

Returns:

  • (::String) —

    The platform of the virtual agent response messages.

    If not empty, only emits messages from this platform in the response. Valid values are the enum names of platform.



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 166

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

#reset_contexts ⇒ ::Boolean

Returns Specifies whether to delete all contexts in the current session before the new ones are activated.

Returns:

  • (::Boolean) —

    Specifies whether to delete all contexts in the current session before the new ones are activated.



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 166

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

#sentiment_analysis_request_config ⇒ ::Google::Cloud::Dialogflow::V2::SentimentAnalysisRequestConfig

Returns Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed.

Returns:



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 166

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



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 166

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 agent settings 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 agent settings is used.



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 166

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 the Dialogflow web console. The headers defined within this field will overwrite the headers configured through the 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 the Dialogflow web console. The headers defined within this field will overwrite the headers configured through the 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.



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/session.rb', line 166

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