Struct google_api_proto::google::cloud::dialogflow::cx::v3beta1::Agent

pub struct Agent {

    pub name: String,
    pub display_name: String,
    pub default_language_code: String,
    pub supported_language_codes: Vec<String>,
    pub time_zone: String,
    pub description: String,
    pub avatar_uri: String,
    pub speech_to_text_settings: Option<SpeechToTextSettings>,
    pub start_flow: String,
    pub start_playbook: String,
    pub security_settings: String,
    pub enable_stackdriver_logging: bool,
    pub enable_spell_correction: bool,
    pub enable_multi_language_training: bool,
    pub locked: bool,
    pub advanced_settings: Option<AdvancedSettings>,
    pub git_integration_settings: Option<GitIntegrationSettings>,
    pub text_to_speech_settings: Option<TextToSpeechSettings>,
    pub gen_app_builder_settings: Option<GenAppBuilderSettings>,
    pub answer_feedback_settings: Option<AnswerFeedbackSettings>,
    pub personalization_settings: Option<PersonalizationSettings>,
}

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

Fields

name: String

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

display_name: String

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

default_language_code: String

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.v3beta1.Agents.UpdateAgent] method.

supported_language_codes: Vec<String>

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

time_zone: String

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

description: String

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

avatar_uri: String

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

speech_to_text_settings: Option<SpeechToTextSettings>

Speech recognition related settings.

start_flow: String

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

start_playbook: String

Optional. 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/playbooks/<Playbook ID>. Currently only the default playbook with id “00000000-0000-0000-0000-000000000000” is allowed.

Only one of start_flow or start_playbook should be set, but not both.

security_settings: String

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

enable_stackdriver_logging: bool

👎Deprecated

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

enable_spell_correction: bool

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

enable_multi_language_training: bool

Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.

locked: bool

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

advanced_settings: Option<AdvancedSettings>

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

git_integration_settings: Option<GitIntegrationSettings>

Git integration settings for this agent.

text_to_speech_settings: Option<TextToSpeechSettings>

Settings on instructing the speech synthesizer on how to generate the output audio content.

gen_app_builder_settings: Option<GenAppBuilderSettings>

Gen App Builder-related agent-level settings.

answer_feedback_settings: Option<AnswerFeedbackSettings>

Optional. Answer feedback collection settings.

personalization_settings: Option<PersonalizationSettings>

Optional. Settings for end user personalization.

Trait Implementations

impl Clone for Agent

fn clone(&self) -> Agent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Agent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Agent

fn default() -> Self

Returns the “default value” for a type.

impl Message for Agent

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Agent

fn eq(&self, other: &Agent) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Agent