Class GoogleCloudDialogflowCxV3Agent
Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.
Implements
Inherited Members
Namespace: Google.Apis.Dialogflow.v3.Data
Assembly: Google.Apis.Dialogflow.v3.dll
Syntax
public class GoogleCloudDialogflowCxV3Agent : IDirectResponseSchema
Properties
AdvancedSettings
Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
Declaration
[JsonProperty("advancedSettings")]
public virtual GoogleCloudDialogflowCxV3AdvancedSettings AdvancedSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| GoogleCloudDialogflowCxV3AdvancedSettings |
AnswerFeedbackSettings
Optional. Answer feedback collection settings.
Declaration
[JsonProperty("answerFeedbackSettings")]
public virtual GoogleCloudDialogflowCxV3AgentAnswerFeedbackSettings AnswerFeedbackSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| GoogleCloudDialogflowCxV3AgentAnswerFeedbackSettings |
AvatarUri
The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
Declaration
[JsonProperty("avatarUri")]
public virtual string AvatarUri { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
ClientCertificateSettings
Optional. Settings for custom client certificates.
Declaration
[JsonProperty("clientCertificateSettings")]
public virtual GoogleCloudDialogflowCxV3AgentClientCertificateSettings ClientCertificateSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| GoogleCloudDialogflowCxV3AgentClientCertificateSettings |
DefaultLanguageCode
Required. Immutable. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
Declaration
[JsonProperty("defaultLanguageCode")]
public virtual string DefaultLanguageCode { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Description
The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
DisplayName
Required. The human-readable name of the agent, unique within the location.
Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
EnableMultiLanguageTraining
Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
Declaration
[JsonProperty("enableMultiLanguageTraining")]
public virtual bool? EnableMultiLanguageTraining { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |
EnableSpellCorrection
Indicates if automatic spell correction is enabled in detect intent requests.
Declaration
[JsonProperty("enableSpellCorrection")]
public virtual bool? EnableSpellCorrection { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |
EnableStackdriverLogging
Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
Declaration
[JsonProperty("enableStackdriverLogging")]
public virtual bool? EnableStackdriverLogging { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |
GenAppBuilderSettings
Gen App Builder-related agent-level settings.
Declaration
[JsonProperty("genAppBuilderSettings")]
public virtual GoogleCloudDialogflowCxV3AgentGenAppBuilderSettings GenAppBuilderSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| GoogleCloudDialogflowCxV3AgentGenAppBuilderSettings |
GitIntegrationSettings
Git integration settings for this agent.
Declaration
[JsonProperty("gitIntegrationSettings")]
public virtual GoogleCloudDialogflowCxV3AgentGitIntegrationSettings GitIntegrationSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| GoogleCloudDialogflowCxV3AgentGitIntegrationSettings |
Locked
Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.
Declaration
[JsonProperty("locked")]
public virtual bool? Locked { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |
Name
The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates
the name automatically. Format: projects//locations//agents/.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
PersonalizationSettings
Optional. Settings for end user personalization.
Declaration
[JsonProperty("personalizationSettings")]
public virtual GoogleCloudDialogflowCxV3AgentPersonalizationSettings PersonalizationSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| GoogleCloudDialogflowCxV3AgentPersonalizationSettings |
SatisfiesPzi
Optional. Output only. A read only boolean field reflecting Zone Isolation status of the agent.
Declaration
[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |
SatisfiesPzs
Optional. Output only. A read only boolean field reflecting Zone Separation status of the agent.
Declaration
[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |
SecuritySettings
Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
Declaration
[JsonProperty("securitySettings")]
public virtual string SecuritySettings { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
SpeechToTextSettings
Speech recognition related settings.
Declaration
[JsonProperty("speechToTextSettings")]
public virtual GoogleCloudDialogflowCxV3SpeechToTextSettings SpeechToTextSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| GoogleCloudDialogflowCxV3SpeechToTextSettings |
StartFlow
Name of the start flow in this agent. A start flow will be automatically created when the agent is created,
and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/. Currently only
the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed.
Declaration
[JsonProperty("startFlow")]
public virtual string StartFlow { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
StartPlaybook
Name of the start playbook in this agent. A start playbook will be automatically created when the agent is
created, and can only be deleted by deleting the agent. Format: projects//locations//agents//playbooks/.
Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed.
Declaration
[JsonProperty("startPlaybook")]
public virtual string StartPlaybook { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
SupportedLanguageCodes
The list of all languages supported by the agent (except for the default_language_code).
Declaration
[JsonProperty("supportedLanguageCodes")]
public virtual IList<string> SupportedLanguageCodes { get; set; }
Property Value
| Type | Description |
|---|---|
| IList<string> |
TextToSpeechSettings
Settings on instructing the speech synthesizer on how to generate the output audio content.
Declaration
[JsonProperty("textToSpeechSettings")]
public virtual GoogleCloudDialogflowCxV3TextToSpeechSettings TextToSpeechSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| GoogleCloudDialogflowCxV3TextToSpeechSettings |
TimeZone
Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
Declaration
[JsonProperty("timeZone")]
public virtual string TimeZone { get; set; }
Property Value
| Type | Description |
|---|---|
| string |