Dialogflow v3 API - Class QueryParameters (2.16.0)

Version 2.16.0

• 2.20.0 (latest)
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class QueryParameters : IMessage<QueryParameters>, IEquatable<QueryParameters>, IDeepCloneable<QueryParameters>, IBufferMessage, IMessage

Reference documentation and code samples for the Dialogflow v3 API class QueryParameters.

Represents the parameters of a conversational query.

Inheritance

object > QueryParameters

Implements

IMessageQueryParameters, IEquatableQueryParameters, IDeepCloneableQueryParameters, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

QueryParameters()

public QueryParameters()

QueryParameters(QueryParameters)

public QueryParameters(QueryParameters other)

Parameter
Name	Description
other	QueryParameters

Properties

AnalyzeQueryTextSentiment

public bool AnalyzeQueryTextSentiment { get; set; }

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

Property Value
Type	Description
bool

Channel

public string Channel { get; set; }

The channel which this query is for.

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

If unspecified, the [ResponseMessage][google.cloud.dialogflow.cx.v3.ResponseMessage] with unspecified channel will be returned.

Property Value
Type	Description
string

CurrentPage

public string CurrentPage { get; set; }

The unique identifier of the [page][google.cloud.dialogflow.cx.v3.Page] to override the [current page][QueryResult.current_page] in the session. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

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.v3.QueryParameters.current_page] and [parameters][google.cloud.dialogflow.cx.v3.QueryParameters.parameters] should be configured together to direct a session to a specific state.

Property Value
Type	Description
string

CurrentPageAsPageName

public PageName CurrentPageAsPageName { get; set; }

PageName-typed view over the CurrentPage resource name property.

Property Value
Type	Description
PageName

DisableWebhook

public bool DisableWebhook { get; set; }

Whether to disable webhook calls for this request.

Property Value
Type	Description
bool

EndUserMetadata

public Struct EndUserMetadata { get; set; }

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

Property Value
Type	Description
Struct

FlowVersions

public RepeatedField<string> FlowVersions { get; }

A list of flow versions to override for the request. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

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.

Property Value
Type	Description
RepeatedFieldstring

FlowVersionsAsVersionNames

public ResourceNameList<VersionName> FlowVersionsAsVersionNames { get; }

VersionName-typed view over the FlowVersions resource name property.

Property Value
Type	Description
ResourceNameListVersionName

GeoLocation

public LatLng GeoLocation { get; set; }

The geo location of this conversational query.

Property Value
Type	Description
LatLng

Parameters

public Struct Parameters { get; set; }

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.

Property Value
Type	Description
Struct

Payload

public Struct Payload { get; set; }

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": "[phone]"
 }
}

Property Value
Type	Description
Struct

SearchConfig

public SearchConfig SearchConfig { get; set; }

Optional. Search configuration for UCS search queries.

Property Value
Type	Description
SearchConfig

SessionEntityTypes

public RepeatedField<SessionEntityType> SessionEntityTypes { get; }

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.

Property Value
Type	Description
RepeatedFieldSessionEntityType

SessionTtl

public Duration SessionTtl { get; set; }

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.

Property Value
Type	Description
Duration

TimeZone

public string TimeZone { get; set; }

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.

Property Value
Type	Description
string

WebhookHeaders

public MapField<string, string> WebhookHeaders { get; }

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.

Property Value
Type	Description
MapFieldstringstring