Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class Agent.
A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system.
For more information about agents, see the Agent guide .
Generated from protobuf message google.cloud.dialogflow.v2.Agent
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The project of this agent. Format: projects/<Project ID>
.
↳ display_name
string
Required. The name of this agent.
↳ default_language_code
string
Required. 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 Update
method.
↳ supported_language_codes
array
Optional. The list of all languages supported by this agent (except for the default_language_code
).
↳ time_zone
string
Required. The time zone of this agent from the time zone database , e.g., America/New_York, Europe/Paris.
↳ description
string
Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
↳ avatar_uri
string
Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
↳ enable_logging
bool
Optional. Determines whether this agent should log conversation queries.
↳ match_mode
int
Optional. Determines how intents are detected from user queries.
↳ classification_threshold
float
Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
↳ api_version
int
Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.
↳ tier
int
Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
getParent
Required. The project of this agent.
Format: projects/<Project ID>
.
string
setParent
Required. The project of this agent.
Format: projects/<Project ID>
.
var
string
$this
getDisplayName
Required. The name of this agent.
string
setDisplayName
Required. The name of this agent.
var
string
$this
getDefaultLanguageCode
Required. 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 Update
method.
string
setDefaultLanguageCode
Required. 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 Update
method.
var
string
$this
getSupportedLanguageCodes
Optional. The list of all languages supported by this agent (except for the default_language_code
).
setSupportedLanguageCodes
Optional. The list of all languages supported by this agent (except for the default_language_code
).
var
string[]
$this
getTimeZone
Required. The time zone of this agent from the time zone database , e.g., America/New_York, Europe/Paris.
string
setTimeZone
Required. The time zone of this agent from the time zone database , e.g., America/New_York, Europe/Paris.
var
string
$this
getDescription
Optional. The description of this agent.
The maximum length is 500 characters. If exceeded, the request is rejected.
string
setDescription
Optional. The description of this agent.
The maximum length is 500 characters. If exceeded, the request is rejected.
var
string
$this
getAvatarUri
Optional. The URI of the agent's avatar.
Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
string
setAvatarUri
Optional. 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
getEnableLogging
Optional. Determines whether this agent should log conversation queries.
bool
setEnableLogging
Optional. Determines whether this agent should log conversation queries.
var
bool
$this
getMatchMode
Optional. Determines how intents are detected from user queries.
int
setMatchMode
Optional. Determines how intents are detected from user queries.
var
int
$this
getClassificationThreshold
Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain).
If set to 0.0, the default of 0.3 is used.
float
setClassificationThreshold
Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain).
If set to 0.0, the default of 0.3 is used.
var
float
$this
getApiVersion
Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.
int
setApiVersion
Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.
var
int
$this
getTier
Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
int
setTier
Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
var
int
$this