View Source GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Agent (google_api_dialogflow v0.88.3)

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.

Attributes

  • advancedSettings (type: GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3AdvancedSettings.t, default: nil) - Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
  • answerFeedbackSettings (type: GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3AgentAnswerFeedbackSettings.t, default: nil) - Optional. Answer feedback collection settings.
  • avatarUri (type: String.t, default: nil) - The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
  • clientCertificateSettings (type: GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3AgentClientCertificateSettings.t, default: nil) - Optional. Settings for custom client certificates.
  • defaultLanguageCode (type: String.t, default: nil) - 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.
  • description (type: String.t, default: nil) - The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
  • displayName (type: String.t, default: nil) - Required. The human-readable name of the agent, unique within the location.
  • enableMultiLanguageTraining (type: boolean(), default: nil) - Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
  • enableSpellCorrection (type: boolean(), default: nil) - Indicates if automatic spell correction is enabled in detect intent requests.
  • enableStackdriverLogging (type: boolean(), default: nil) - Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
  • genAppBuilderSettings (type: GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3AgentGenAppBuilderSettings.t, default: nil) - Gen App Builder-related agent-level settings.
  • gitIntegrationSettings (type: GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3AgentGitIntegrationSettings.t, default: nil) - Git integration settings for this agent.
  • locked (type: boolean(), default: nil) - Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.
  • name (type: String.t, default: nil) - The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects//locations//agents/.
  • personalizationSettings (type: GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3AgentPersonalizationSettings.t, default: nil) - Optional. Settings for end user personalization.
  • securitySettings (type: String.t, default: nil) - Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.
  • speechToTextSettings (type: GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SpeechToTextSettings.t, default: nil) - Speech recognition related settings.
  • startFlow (type: String.t, default: nil) - 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//locations//agents//flows/.
  • supportedLanguageCodes (type: list(String.t), default: nil) - The list of all languages supported by the agent (except for the default_language_code).
  • textToSpeechSettings (type: GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TextToSpeechSettings.t, default: nil) - Settings on instructing the speech synthesizer on how to generate the output audio content.
  • timeZone (type: String.t, default: nil) - Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3Agent{
  advancedSettings:
    GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3AdvancedSettings.t()
    | nil,
  answerFeedbackSettings:
    GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3AgentAnswerFeedbackSettings.t()
    | nil,
  avatarUri: String.t() | nil,
  clientCertificateSettings:
    GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3AgentClientCertificateSettings.t()
    | nil,
  defaultLanguageCode: String.t() | nil,
  description: String.t() | nil,
  displayName: String.t() | nil,
  enableMultiLanguageTraining: boolean() | nil,
  enableSpellCorrection: boolean() | nil,
  enableStackdriverLogging: boolean() | nil,
  genAppBuilderSettings:
    GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3AgentGenAppBuilderSettings.t()
    | nil,
  gitIntegrationSettings:
    GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3AgentGitIntegrationSettings.t()
    | nil,
  locked: boolean() | nil,
  name: String.t() | nil,
  personalizationSettings:
    GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3AgentPersonalizationSettings.t()
    | nil,
  securitySettings: String.t() | nil,
  speechToTextSettings:
    GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3SpeechToTextSettings.t()
    | nil,
  startFlow: String.t() | nil,
  supportedLanguageCodes: [String.t()] | nil,
  textToSpeechSettings:
    GoogleApi.Dialogflow.V3.Model.GoogleCloudDialogflowCxV3TextToSpeechSettings.t()
    | nil,
  timeZone: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.