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
Static Fields
API_VERSION_FIELD_NUMBER
public static final int API_VERSION_FIELD_NUMBER
Field Value
AVATAR_URI_FIELD_NUMBER
public static final int AVATAR_URI_FIELD_NUMBER
Field Value
CLASSIFICATION_THRESHOLD_FIELD_NUMBER
public static final int CLASSIFICATION_THRESHOLD_FIELD_NUMBER
Field Value
DEFAULT_LANGUAGE_CODE_FIELD_NUMBER
public static final int DEFAULT_LANGUAGE_CODE_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
ENABLE_LOGGING_FIELD_NUMBER
public static final int ENABLE_LOGGING_FIELD_NUMBER
Field Value
MATCH_MODE_FIELD_NUMBER
public static final int MATCH_MODE_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
SUPPORTED_LANGUAGE_CODES_FIELD_NUMBER
public static final int SUPPORTED_LANGUAGE_CODES_FIELD_NUMBER
Field Value
TIER_FIELD_NUMBER
public static final int TIER_FIELD_NUMBER
Field Value
TIME_ZONE_FIELD_NUMBER
public static final int TIME_ZONE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Agent getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Agent.Builder newBuilder()
Returns
newBuilder(Agent prototype)
public static Agent.Builder newBuilder(Agent prototype)
Parameter
| Name |
Description |
| prototype |
Agent
|
Returns
public static Agent parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Agent parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Agent parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Agent parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Agent parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Agent parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Agent parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Agent parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Agent parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Agent parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Agent parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Agent parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Agent> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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];
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];
| 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];
| 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];
| 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];
| Type |
Description |
| float |
The classificationThreshold.
|
getDefaultInstanceForType()
public Agent getDefaultInstanceForType()
Returns
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];
| 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];
| 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];
| 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];
| 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];
| Type |
Description |
| String |
The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Required. The name of this agent.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| 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];
| 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=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];
getMatchModeValue() (deprecated)
public 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];
| 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) = { ... }
| 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) = { ... }
getParserForType()
public Parser<Agent> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
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];
| 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];
| 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];
| 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];
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];
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];
| 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];
| 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];
| Type |
Description |
| ByteString |
The bytes for timeZone.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Agent.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Agent.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Agent.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
