Class GoogleCloudDialogflowCxV3beta1QueryParameters

Represents the parameters of a conversational query.

Inheritance
object
GoogleCloudDialogflowCxV3beta1QueryParameters
Implements
Inherited Members
Namespace: Google.Apis.Dialogflow.v3beta1.Data
Assembly: Google.Apis.Dialogflow.v3beta1.dll
Syntax
public class GoogleCloudDialogflowCxV3beta1QueryParameters : IDirectResponseSchema

Properties

AnalyzeQueryTextSentiment

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

Declaration
[JsonProperty("analyzeQueryTextSentiment")]
public virtual bool? AnalyzeQueryTextSentiment { get; set; }
Property Value
Type Description
bool?

Channel

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.

Declaration
[JsonProperty("channel")]
public virtual string Channel { get; set; }
Property Value
Type Description
string

CurrentPage

The unique identifier of the page to override the current page in the session. Format: projects//locations//agents//flows//pages/. If current_page is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state.

Declaration
[JsonProperty("currentPage")]
public virtual string CurrentPage { get; set; }
Property Value
Type Description
string

CurrentPlaybook

Optional. Start the session with the specified playbook. You can only specify the playbook at the beginning of the session. Otherwise, an error will be thrown. Format: projects//locations//agents//playbooks/.

Declaration
[JsonProperty("currentPlaybook")]
public virtual string CurrentPlaybook { get; set; }
Property Value
Type Description
string

DisableWebhook

Whether to disable webhook calls for this request.

Declaration
[JsonProperty("disableWebhook")]
public virtual bool? DisableWebhook { get; set; }
Property Value
Type Description
bool?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EndUserMetadata

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:

json { "subscription plan": "Business Premium Plus", "devices owned":
[ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] }
Declaration
[JsonProperty("endUserMetadata")]
public virtual IDictionary<string, object> EndUserMetadata { get; set; }
Property Value
Type Description
IDictionary<string, object>

FlowVersions

A list of flow versions to override for the request. Format: projects//locations//agents//flows//versions/. 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.

Declaration
[JsonProperty("flowVersions")]
public virtual IList<string> FlowVersions { get; set; }
Property Value
Type Description
IList<string>

GeoLocation

The geo location of this conversational query.

Declaration
[JsonProperty("geoLocation")]
public virtual GoogleTypeLatLng GeoLocation { get; set; }
Property Value
Type Description
GoogleTypeLatLng

LlmModelSettings

Optional. Use the specified LLM model settings for processing the request.

Declaration
[JsonProperty("llmModelSettings")]
public virtual GoogleCloudDialogflowCxV3beta1LlmModelSettings LlmModelSettings { get; set; }
Property Value
Type Description
GoogleCloudDialogflowCxV3beta1LlmModelSettings

Parameters

Additional parameters to be put into session 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.

Declaration
[JsonProperty("parameters")]
public virtual IDictionary<string, object> Parameters { get; set; }
Property Value
Type Description
IDictionary<string, object>

Payload

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" } }
Declaration
[JsonProperty("payload")]
public virtual IDictionary<string, object> Payload { get; set; }
Property Value
Type Description
IDictionary<string, object>

PopulateDataStoreConnectionSignals

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.

Declaration
[JsonProperty("populateDataStoreConnectionSignals")]
public virtual bool? PopulateDataStoreConnectionSignals { get; set; }
Property Value
Type Description
bool?

SearchConfig

Optional. Search configuration for UCS search queries.

Declaration
[JsonProperty("searchConfig")]
public virtual GoogleCloudDialogflowCxV3beta1SearchConfig SearchConfig { get; set; }
Property Value
Type Description
GoogleCloudDialogflowCxV3beta1SearchConfig

SessionEntityTypes

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.

Declaration
[JsonProperty("sessionEntityTypes")]
public virtual IList<GoogleCloudDialogflowCxV3beta1SessionEntityType> SessionEntityTypes { get; set; }
Property Value
Type Description
IList<GoogleCloudDialogflowCxV3beta1SessionEntityType>

SessionTtl

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.

Declaration
[JsonProperty("sessionTtl")]
public virtual object SessionTtl { get; set; }
Property Value
Type Description
object

TimeZone

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.

Declaration
[JsonProperty("timeZone")]
public virtual string TimeZone { get; set; }
Property Value
Type Description
string

WebhookHeaders

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.

Declaration
[JsonProperty("webhookHeaders")]
public virtual IDictionary<string, string> WebhookHeaders { get; set; }
Property Value
Type Description
IDictionary<string, string>

Implements