Class Agent (1.37.0)

Agent(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
`name`	`str` The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects/`.
`display_name`	`str` Required. The human-readable name of the agent, unique within the location.
`default_language_code`	`str` Required. Immutable. The default language of the agent as a language tag. See `Language Support
`supported_language_codes`	`MutableSequence[str]` The list of all languages supported by the agent (except for the `default_language_code`).
`time_zone`	`str` Required. The time zone of the agent from the `time zone database
`description`	`str` The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
`avatar_uri`	`str` The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted `Web Demo
`speech_to_text_settings`	`google.cloud.dialogflowcx_v3beta1.types.SpeechToTextSettings` Speech recognition related settings.
`start_flow`	`str` 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/`. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed. This field is a member of `oneof`_ `session_entry_resource`.
`start_playbook`	`str` 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/`. Currently only the default playbook with id "00000000-0000-0000-0000-000000000000" is allowed. This field is a member of `oneof`_ `session_entry_resource`.
`security_settings`	`str` Name of the SecuritySettings reference for the agent. Format: `projects/`.
`enable_stackdriver_logging`	`bool` Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings 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`	`google.cloud.dialogflowcx_v3beta1.types.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`	`google.cloud.dialogflowcx_v3beta1.types.Agent.GitIntegrationSettings` Git integration settings for this agent.
`bigquery_export_settings`	`google.cloud.dialogflowcx_v3beta1.types.BigQueryExportSettings` Optional. The BigQuery export settings for this agent. The conversation data will be exported to BigQuery tables if it is enabled. By default, BigQuery export settings will not be exported with agent. You need to set include_bigquery_export_settings to include it in the exported agent.
`text_to_speech_settings`	`google.cloud.dialogflowcx_v3beta1.types.TextToSpeechSettings` Settings on instructing the speech synthesizer on how to generate the output audio content.
`gen_app_builder_settings`	`google.cloud.dialogflowcx_v3beta1.types.Agent.GenAppBuilderSettings` Gen App Builder-related agent-level settings. This field is a member of `oneof`_ `_gen_app_builder_settings`.
`answer_feedback_settings`	`google.cloud.dialogflowcx_v3beta1.types.Agent.AnswerFeedbackSettings` Optional. Answer feedback collection settings.
`personalization_settings`	`google.cloud.dialogflowcx_v3beta1.types.Agent.PersonalizationSettings` Optional. Settings for end user personalization.
`client_certificate_settings`	`google.cloud.dialogflowcx_v3beta1.types.Agent.ClientCertificateSettings` Optional. Settings for custom client certificates.

Classes

AnswerFeedbackSettings

AnswerFeedbackSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Settings for answer feedback collection.

ClientCertificateSettings

ClientCertificateSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Settings for custom client certificates.

GenAppBuilderSettings

GenAppBuilderSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Settings for Gen App Builder.

GitIntegrationSettings

GitIntegrationSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Settings for connecting to Git repository for an agent.