Google Cloud Dialogflow Cx V3 Client - Class Agent (0.5.0)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class Agent.

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.

Generated from protobuf message google.cloud.dialogflow.cx.v3.Agent

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
`↳ 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 method.
`↳ supported_language_codes`	`array` 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`	`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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
`↳ security_settings`	`string` Name of the SecuritySettings reference for the agent. Format: `projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>`.
`↳ 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`	`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`	`Agent\GitIntegrationSettings` Git integration settings for this agent.
`↳ text_to_speech_settings`	`TextToSpeechSettings` Settings on instructing the speech synthesizer on how to generate the output audio content.
`↳ gen_app_builder_settings`	`Agent\GenAppBuilderSettings` Gen App Builder-related agent-level settings.
`↳ answer_feedback_settings`	`Agent\AnswerFeedbackSettings` Optional. Answer feedback collection settings.
`↳ personalization_settings`	`Agent\PersonalizationSettings` Optional. Settings for end user personalization.
`↳ client_certificate_settings`	`Agent\ClientCertificateSettings` Optional. Settings for custom client certificates.

getName

The unique identifier of the agent.

Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.

Returns
Type	Description
`string`

setName

The unique identifier of the agent.

Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

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

Returns
Type	Description
`string`

setDisplayName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDefaultLanguageCode

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.

Returns
Type	Description
`string`

setDefaultLanguageCode

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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSupportedLanguageCodes

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

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setSupportedLanguageCodes

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

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getTimeZone

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

Returns
Type	Description
`string`

setTimeZone

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

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

Returns
Type	Description
`string`

setDescription

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAvatarUri

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

Returns
Type	Description
`string`

setAvatarUri

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSpeechToTextSettings

Speech recognition related settings.

Returns
Type	Description
`SpeechToTextSettings\|null`

hasSpeechToTextSettings

clearSpeechToTextSettings

setSpeechToTextSettings

Speech recognition related settings.

Parameter
Name	Description
`var`	`SpeechToTextSettings`

Returns
Type	Description
`$this`

getStartFlow

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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

Returns
Type	Description
`string`

setStartFlow

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSecuritySettings

Name of the SecuritySettings reference for the agent. Format: projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>.

Returns
Type	Description
`string`

setSecuritySettings

Name of the SecuritySettings reference for the agent. Format: projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getEnableStackdriverLogging

Indicates if stackdriver logging is enabled for the agent.

Please use agent.advanced_settings instead.

Returns
Type	Description
`bool`

setEnableStackdriverLogging

Indicates if stackdriver logging is enabled for the agent.

Please use agent.advanced_settings instead.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getEnableSpellCorrection

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

Returns
Type	Description
`bool`

setEnableSpellCorrection

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getEnableMultiLanguageTraining

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

Returns
Type	Description
`bool`

setEnableMultiLanguageTraining

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getLocked

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

Returns
Type	Description
`bool`

setLocked

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getAdvancedSettings

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

Returns
Type	Description
`AdvancedSettings\|null`

hasAdvancedSettings

clearAdvancedSettings

setAdvancedSettings

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

Parameter
Name	Description
`var`	`AdvancedSettings`

Returns
Type	Description
`$this`

getGitIntegrationSettings

Git integration settings for this agent.

Returns
Type	Description
`Agent\GitIntegrationSettings\|null`

hasGitIntegrationSettings

clearGitIntegrationSettings

setGitIntegrationSettings

Git integration settings for this agent.

Parameter
Name	Description
`var`	`Agent\GitIntegrationSettings`

Returns
Type	Description
`$this`

getTextToSpeechSettings

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

Returns
Type	Description
`TextToSpeechSettings\|null`

hasTextToSpeechSettings

clearTextToSpeechSettings

setTextToSpeechSettings

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

Parameter
Name	Description
`var`	`TextToSpeechSettings`

Returns
Type	Description
`$this`

getGenAppBuilderSettings

Gen App Builder-related agent-level settings.

Returns
Type	Description
`Agent\GenAppBuilderSettings\|null`

hasGenAppBuilderSettings

clearGenAppBuilderSettings

setGenAppBuilderSettings

Gen App Builder-related agent-level settings.

Parameter
Name	Description
`var`	`Agent\GenAppBuilderSettings`

Returns
Type	Description
`$this`

getAnswerFeedbackSettings

Optional. Answer feedback collection settings.

Returns
Type	Description
`Agent\AnswerFeedbackSettings\|null`

hasAnswerFeedbackSettings

clearAnswerFeedbackSettings

setAnswerFeedbackSettings

Optional. Answer feedback collection settings.

Parameter
Name	Description
`var`	`Agent\AnswerFeedbackSettings`

Returns
Type	Description
`$this`

getPersonalizationSettings

Optional. Settings for end user personalization.

Returns
Type	Description
`Agent\PersonalizationSettings\|null`

hasPersonalizationSettings

clearPersonalizationSettings

setPersonalizationSettings

Optional. Settings for end user personalization.

Parameter
Name	Description
`var`	`Agent\PersonalizationSettings`

Returns
Type	Description
`$this`

getClientCertificateSettings

Optional. Settings for custom client certificates.

Returns
Type	Description
`Agent\ClientCertificateSettings\|null`

hasClientCertificateSettings

clearClientCertificateSettings

setClientCertificateSettings

Optional. Settings for custom client certificates.

Parameter
Name	Description
`var`	`Agent\ClientCertificateSettings`

Returns
Type	Description
`$this`