Class Agent (2.1.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class Agent : IMessage<Agent>, IEquatable<Agent>, IDeepCloneable<Agent>, IBufferMessage, IMessage

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][google.cloud.dialogflow.cx.v3.Intent], [Entity Types][google.cloud.dialogflow.cx.v3.EntityType], [Flows][google.cloud.dialogflow.cx.v3.Flow], [Fulfillments][google.cloud.dialogflow.cx.v3.Fulfillment], [Webhooks][google.cloud.dialogflow.cx.v3.Webhook], and so on to manage the conversation flows..

Inheritance

Object > Agent

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

Agent()

public Agent()

Agent(Agent)

public Agent(Agent other)
Parameter
NameDescription
otherAgent

Properties

AdvancedSettings

public AdvancedSettings AdvancedSettings { get; set; }

Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

Property Value
TypeDescription
AdvancedSettings

AgentName

public AgentName AgentName { get; set; }

AgentName-typed view over the Name resource name property.

Property Value
TypeDescription
AgentName

AvatarUri

public string AvatarUri { get; set; }

The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

Property Value
TypeDescription
String

DefaultLanguageCode

public string DefaultLanguageCode { get; set; }

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][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent] method.

Property Value
TypeDescription
String

Description

public string Description { get; set; }

The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

Property Value
TypeDescription
String

DisplayName

public string DisplayName { get; set; }

Required. The human-readable name of the agent, unique within the location.

Property Value
TypeDescription
String

EnableSpellCorrection

public bool EnableSpellCorrection { get; set; }

Indicates if automatic spell correction is enabled in detect intent requests.

Property Value
TypeDescription
Boolean

EnableStackdriverLogging

[Obsolete]
public bool EnableStackdriverLogging { get; set; }

Indicates if stackdriver logging is enabled for the agent. Please use [agent.advanced_settings][google.cloud.dialogflow.cx.v3.AdvancedSettings.LoggingSettings] instead.

Property Value
TypeDescription
Boolean

Locked

public bool Locked { get; set; }

Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [RestoreAgent][].

Property Value
TypeDescription
Boolean

Name

public string Name { get; set; }

The unique identifier of the agent. Required for the [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent] method. [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent] populates the name automatically. Format: projects/&lt;Project ID>/locations/&lt;Location ID>/agents/&lt;Agent ID>.

Property Value
TypeDescription
String

SecuritySettings

public string SecuritySettings { get; set; }

Name of the [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] reference for the agent. Format: projects/&lt;Project ID>/locations/&lt;Location ID>/securitySettings/&lt;Security Settings ID>.

Property Value
TypeDescription
String

SecuritySettingsAsSecuritySettingsName

public SecuritySettingsName SecuritySettingsAsSecuritySettingsName { get; set; }

SecuritySettingsName-typed view over the SecuritySettings resource name property.

Property Value
TypeDescription
SecuritySettingsName

SpeechToTextSettings

public SpeechToTextSettings SpeechToTextSettings { get; set; }

Speech recognition related settings.

Property Value
TypeDescription
SpeechToTextSettings

StartFlow

public string StartFlow { get; set; }

Immutable. 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/&lt;Project ID>/locations/&lt;Location ID>/agents/&lt;Agent ID>/flows/&lt;Flow ID>.

Property Value
TypeDescription
String

StartFlowAsFlowName

public FlowName StartFlowAsFlowName { get; set; }

FlowName-typed view over the StartFlow resource name property.

Property Value
TypeDescription
FlowName

SupportedLanguageCodes

public RepeatedField<string> SupportedLanguageCodes { get; }

The list of all languages supported by the agent (except for the default_language_code).

Property Value
TypeDescription
RepeatedField<String>

TimeZone

public string TimeZone { get; set; }

Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

Property Value
TypeDescription
String