Class Agent (4.57.0)

public final class Agent extends GeneratedMessageV3 implements AgentOrBuilder

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.

Protobuf type google.cloud.dialogflow.v2.Agent

Implements

AgentOrBuilder

Static Fields

API_VERSION_FIELD_NUMBER

public static final int API_VERSION_FIELD_NUMBER
Field Value
Type Description
int

AVATAR_URI_FIELD_NUMBER

public static final int AVATAR_URI_FIELD_NUMBER
Field Value
Type Description
int

CLASSIFICATION_THRESHOLD_FIELD_NUMBER

public static final int CLASSIFICATION_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_LANGUAGE_CODE_FIELD_NUMBER

public static final int DEFAULT_LANGUAGE_CODE_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_LOGGING_FIELD_NUMBER

public static final int ENABLE_LOGGING_FIELD_NUMBER
Field Value
Type Description
int

MATCH_MODE_FIELD_NUMBER

public static final int MATCH_MODE_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

SUPPORTED_LANGUAGE_CODES_FIELD_NUMBER

public static final int SUPPORTED_LANGUAGE_CODES_FIELD_NUMBER
Field Value
Type Description
int

TIER_FIELD_NUMBER

public static final int TIER_FIELD_NUMBER
Field Value
Type Description
int

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Agent getDefaultInstance()
Returns
Type Description
Agent

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Agent.Builder newBuilder()
Returns
Type Description
Agent.Builder

newBuilder(Agent prototype)

public static Agent.Builder newBuilder(Agent prototype)
Parameter
Name Description
prototype Agent
Returns
Type Description
Agent.Builder

parseDelimitedFrom(InputStream input)

public static Agent parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Agent
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Agent parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Agent
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Agent parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Agent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Agent parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Agent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Agent parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Agent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Agent parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Agent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Agent parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Agent
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Agent parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Agent
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Agent parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Agent
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Agent parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Agent
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Agent parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Agent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Agent parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Agent
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Agent> parser()
Returns
Type Description
Parser<Agent>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getApiVersion()

public 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 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 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 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 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.

getDefaultInstanceForType()

public Agent getDefaultInstanceForType()
Returns
Type Description
Agent

getDefaultLanguageCode()

public 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 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 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 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 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 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 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 Agent.MatchMode getMatchMode()

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

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 int getMatchModeValue()

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

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 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 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.

getParserForType()

public Parser<Agent> getParserForType()
Returns
Type Description
Parser<Agent>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSupportedLanguageCodes(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the supportedLanguageCodes.

getTier()

public 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Agent.Builder newBuilderForType()
Returns
Type Description
Agent.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Agent.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Agent.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Agent.Builder toBuilder()
Returns
Type Description
Agent.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException