Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::QueryParameters (v1.0.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::QueryParameters.

Represents the parameters of the conversational query.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#contexts

def contexts() -> ::Array<::Google::Cloud::Dialogflow::V2::Context>

Returns

(::Array<::Google::Cloud::Dialogflow::V2::Context>) — The collection of contexts to be activated before this query is executed.

#contexts=

def contexts=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::Context>

Parameter

value (::Array<::Google::Cloud::Dialogflow::V2::Context>) — The collection of contexts to be activated before this query is executed.

Returns

(::Array<::Google::Cloud::Dialogflow::V2::Context>) — The collection of contexts to be activated before this query is executed.

#geo_location

def geo_location() -> ::Google::Type::LatLng

Returns

(::Google::Type::LatLng) — The geo location of this conversational query.

#geo_location=

def geo_location=(value) -> ::Google::Type::LatLng

Parameter

value (::Google::Type::LatLng) — The geo location of this conversational query.

Returns

(::Google::Type::LatLng) — The geo location of this conversational query.

#payload

def payload() -> ::Google::Protobuf::Struct

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.

#payload=

def payload=(value) -> ::Google::Protobuf::Struct

Parameter

value (::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.

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.

#platform

def platform() -> ::String

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.

#platform=

def platform=(value) -> ::String

Parameter

value (::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.

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.

#reset_contexts

def reset_contexts() -> ::Boolean

Returns

(::Boolean) — Specifies whether to delete all contexts in the current session before the new ones are activated.

#reset_contexts=

def reset_contexts=(value) -> ::Boolean

Parameter

value (::Boolean) — 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.

#sentiment_analysis_request_config

def sentiment_analysis_request_config() -> ::Google::Cloud::Dialogflow::V2::SentimentAnalysisRequestConfig

Returns

(::Google::Cloud::Dialogflow::V2::SentimentAnalysisRequestConfig) — Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed.

#sentiment_analysis_request_config=

def sentiment_analysis_request_config=(value) -> ::Google::Cloud::Dialogflow::V2::SentimentAnalysisRequestConfig

Parameter

value (::Google::Cloud::Dialogflow::V2::SentimentAnalysisRequestConfig) — Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed.

Returns

(::Google::Cloud::Dialogflow::V2::SentimentAnalysisRequestConfig) — Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed.

#session_entity_types

def session_entity_types() -> ::Array<::Google::Cloud::Dialogflow::V2::SessionEntityType>

Returns

(::Array<::Google::Cloud::Dialogflow::V2::SessionEntityType>) — 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.

#session_entity_types=

def session_entity_types=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::SessionEntityType>

Parameter

value (::Array<::Google::Cloud::Dialogflow::V2::SessionEntityType>) — 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

(::Array<::Google::Cloud::Dialogflow::V2::SessionEntityType>) — 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.

#time_zone

def time_zone() -> ::String

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.

#time_zone=

def time_zone=(value) -> ::String

Parameter

value (::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.

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.

#webhook_headers

def webhook_headers() -> ::Google::Protobuf::Map{::String => ::String}

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.

#webhook_headers=

def webhook_headers=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::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.

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.