QueryParameters

Represents the parameters of the conversational query.

JSON representation 
{
  "timeZone": string,
  "geoLocation": {
    object (LatLng)
  },
  "contexts": [
    {
      object (Context)
    }
  ],
  "resetContexts": boolean,
  "sessionEntityTypes": [
    {
      object (SessionEntityType)
    }
  ],
  "payload": {
    object
  },
  "knowledgeBaseNames": [
    string
  ],
  "sentimentAnalysisRequestConfig": {
    object (SentimentAnalysisRequestConfig)
  },
  "subAgents": [
    {
      object (SubAgent)
    }
  ],
  "webhookHeaders": {
    string: string,
    ...
  },
  "platform": string
}
Fields
timeZone

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

object (LatLng)

The geo location of this conversational query.
contexts[]

object (Context)

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

boolean

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

object (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.
payload

object (Struct format)

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.
knowledgeBaseNames[]

string

KnowledgeBases to get alternative results from. If not set, the KnowledgeBases enabled in the agent (through UI) will be used. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>.
sentimentAnalysisRequestConfig

object (SentimentAnalysisRequestConfig)

Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed. Note: Sentiment Analysis is only currently available for Essentials Edition agents.
subAgents[]

object (SubAgent)

For mega agent query, directly specify which sub agents to query. If any specified sub agent is not linked to the mega agent, an error will be returned. If empty, Dialogflow will decide which sub agents to query. If specified for a non-mega-agent query, will be silently ignored.
webhookHeaders

map (key: string, value: 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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
platform

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.

LatLng

An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.

JSON representation 
{
  "latitude": number,
  "longitude": number
}
Fields
latitude

number

The latitude in degrees. It must be in the range [-90.0, +90.0].
longitude

number

The longitude in degrees. It must be in the range [-180.0, +180.0].

SentimentAnalysisRequestConfig

Configures the types of sentiment analysis to perform.

JSON representation 
{
  "analyzeQueryTextSentiment": boolean
}
Fields
analyzeQueryTextSentiment

boolean

Instructs the service to perform sentiment analysis on queryText. If not provided, sentiment analysis is not performed on queryText.

SubAgent

Contains basic configuration for a sub-agent.

JSON representation 
{
  "project": string,
  "environment": string
}
Fields
project

string

Required. The project of this agent. Format: projects/<Project ID> or projects/<Project ID>/locations/<Location ID>.
environment

string

Optional. The unique identifier (environment name in dialogflow console) of this sub-agent environment. Assumes draft environment if environment is not set.