Interface AgentOrBuilder (4.6.0)

Version 4.6.0

• 4.59.0 (latest)
• 4.58.0
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

public interface AgentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getApiVersion()

public abstract Agent.ApiVersion 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.

.google.cloud.dialogflow.v2.Agent.ApiVersion api_version = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
Agent.ApiVersion	The apiVersion.

getApiVersionValue()

public abstract int getApiVersionValue()

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.

.google.cloud.dialogflow.v2.Agent.ApiVersion api_version = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
int	The enum numeric value on the wire for apiVersion.

getAvatarUri()

public abstract String 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 avatar_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
String	The avatarUri.

getAvatarUriBytes()

public abstract ByteString getAvatarUriBytes()

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

string avatar_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ByteString	The bytes for avatarUri.

getClassificationThreshold()

public abstract float 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 classification_threshold = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
float	The classificationThreshold.

getDefaultLanguageCode()

public abstract String 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 default_language_code = 3 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
String	The defaultLanguageCode.

getDefaultLanguageCodeBytes()

public abstract ByteString getDefaultLanguageCodeBytes()

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 default_language_code = 3 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for defaultLanguageCode.

getDescription()

public abstract String getDescription()

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

string description = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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

string description = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ByteString	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Required. The name of this agent.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. The name of this agent.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for displayName.

getEnableLogging()

public abstract boolean getEnableLogging()

Optional. Determines whether this agent should log conversation queries.

bool enable_logging = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
boolean	The enableLogging.

getMatchMode() (deprecated)

public abstract Agent.MatchMode getMatchMode()

Deprecated. google.cloud.dialogflow.v2.Agent.match_mode is deprecated. See google/cloud/dialogflow/v2/agent.proto;l=349

Optional. Determines how intents are detected from user queries.

.google.cloud.dialogflow.v2.Agent.MatchMode match_mode = 9 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
Agent.MatchMode	The matchMode.

getMatchModeValue() (deprecated)

public abstract int getMatchModeValue()

Deprecated. google.cloud.dialogflow.v2.Agent.match_mode is deprecated. See google/cloud/dialogflow/v2/agent.proto;l=349

Optional. Determines how intents are detected from user queries.

.google.cloud.dialogflow.v2.Agent.MatchMode match_mode = 9 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
int	The enum numeric value on the wire for matchMode.

getParent()

public abstract String getParent()

Required. The project of this agent. Format: projects/<Project ID>.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
String	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The project of this agent. Format: projects/<Project ID>.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
ByteString	The bytes for parent.

getSupportedLanguageCodes(int index)

public abstract String getSupportedLanguageCodes(int index)

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

repeated string supported_language_codes = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The supportedLanguageCodes at the given index.

getSupportedLanguageCodesBytes(int index)

public abstract ByteString getSupportedLanguageCodesBytes(int index)

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

repeated string supported_language_codes = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the supportedLanguageCodes at the given index.

getSupportedLanguageCodesCount()

public abstract int getSupportedLanguageCodesCount()

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

repeated string supported_language_codes = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
int	The count of supportedLanguageCodes.

getSupportedLanguageCodesList()

public abstract List<String> getSupportedLanguageCodesList()

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

repeated string supported_language_codes = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
List<String>	A list containing the supportedLanguageCodes.

getTier()

public abstract Agent.Tier getTier()

Optional. The agent tier. If not specified, TIER_STANDARD is assumed.

.google.cloud.dialogflow.v2.Agent.Tier tier = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
Agent.Tier	The tier.

getTierValue()

public abstract int getTierValue()

Optional. The agent tier. If not specified, TIER_STANDARD is assumed.

.google.cloud.dialogflow.v2.Agent.Tier tier = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
int	The enum numeric value on the wire for tier.

getTimeZone()

public abstract String getTimeZone()

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

string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
String	The timeZone.

getTimeZoneBytes()

public abstract ByteString getTimeZoneBytes()

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

string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for timeZone.