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 \ V3Methods
__construct
Constructor.
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/<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 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
↳ 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>
.
↳ security_settings
string
Name of the SecuritySettings
reference for the agent. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>
.
↳ 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.
↳ 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\Dialogflow\Cx\V3\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
↳ text_to_speech_settings
Google\Cloud\Dialogflow\Cx\V3\TextToSpeechSettings
Settings on instructing the speech synthesizer on how to generate the output audio content.
↳ gen_app_builder_settings
Google\Cloud\Dialogflow\Cx\V3\Agent\GenAppBuilderSettings
Gen App Builder-related agent-level settings.
↳ answer_feedback_settings
Google\Cloud\Dialogflow\Cx\V3\Agent\AnswerFeedbackSettings
Optional. Answer feedback collection settings.
getName
The unique identifier of the agent.
Required for the Agents.UpdateAgent
method. Agents.CreateAgent
populates the name automatically.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
.
string
setName
The unique identifier of the agent.
Required for the Agents.UpdateAgent
method. Agents.CreateAgent
populates the name automatically.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>
.
var
string
$this
getDisplayName
Required. The human-readable name of the agent, unique within the location.
string
setDisplayName
Required. The human-readable name of the agent, unique within the location.
var
string
$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.
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.
var
string
$this
getSupportedLanguageCodes
The list of all languages supported by the agent (except for the default_language_code
).
setSupportedLanguageCodes
The list of all languages supported by the agent (except for the default_language_code
).
var
string[]
$this
getTimeZone
Required. The time zone of the agent from the time zone database , e.g., America/New_York, Europe/Paris.
string
setTimeZone
Required. The time zone of the agent from the time zone database , e.g., America/New_York, Europe/Paris.
var
string
$this
getDescription
The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
string
setDescription
The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
var
string
$this
getAvatarUri
The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
string
setAvatarUri
The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
var
string
$this
getSpeechToTextSettings
Speech recognition related settings.
hasSpeechToTextSettings
clearSpeechToTextSettings
setSpeechToTextSettings
Speech recognition related settings.
$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/<Project ID>/locations/<Location
ID>/agents/<Agent ID>/flows/<Flow ID>
.
string
setStartFlow
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>
.
var
string
$this
getSecuritySettings
Name of the SecuritySettings
reference for the agent. Format: projects/<Project ID>/locations/<Location
ID>/securitySettings/<Security Settings ID>
.
string
setSecuritySettings
Name of the SecuritySettings
reference for the agent. Format: projects/<Project ID>/locations/<Location
ID>/securitySettings/<Security Settings ID>
.
var
string
$this
getEnableStackdriverLogging
Indicates if stackdriver logging is enabled for the agent.
Please use agent.advanced_settings instead.
bool
setEnableStackdriverLogging
Indicates if stackdriver logging is enabled for the agent.
Please use agent.advanced_settings instead.
var
bool
$this
getEnableSpellCorrection
Indicates if automatic spell correction is enabled in detect intent requests.
bool
setEnableSpellCorrection
Indicates if automatic spell correction is enabled in detect intent requests.
var
bool
$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 .
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 .
var
bool
$this
getAdvancedSettings
Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
hasAdvancedSettings
clearAdvancedSettings
setAdvancedSettings
Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
$this
getGitIntegrationSettings
Git integration settings for this agent.
hasGitIntegrationSettings
clearGitIntegrationSettings
setGitIntegrationSettings
Git integration settings for this agent.
$this
getTextToSpeechSettings
Settings on instructing the speech synthesizer on how to generate the output audio content.
hasTextToSpeechSettings
clearTextToSpeechSettings
setTextToSpeechSettings
Settings on instructing the speech synthesizer on how to generate the output audio content.
$this
getGenAppBuilderSettings
Gen App Builder-related agent-level settings.
hasGenAppBuilderSettings
clearGenAppBuilderSettings
setGenAppBuilderSettings
Gen App Builder-related agent-level settings.
$this
getAnswerFeedbackSettings
Optional. Answer feedback collection settings.
hasAnswerFeedbackSettings
clearAnswerFeedbackSettings
setAnswerFeedbackSettings
Optional. Answer feedback collection settings.
$this
