public final class Agent extends com.google.protobuf.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](https://cloud.google.com/dialogflow/docs/agents-overview).Protobuf type
google.cloud.dialogflow.v2beta1.Agent| Modifier and Type | Class and Description |
|---|---|
static class |
Agent.ApiVersion
API version for the agent.
|
static class |
Agent.Builder
A Dialogflow agent is a virtual agent that handles conversations with your
end-users.
|
static class |
Agent.MatchMode
Match mode determines how intents are detected from user queries.
|
static class |
Agent.Tier
Represents the agent tier.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
API_VERSION_FIELD_NUMBER |
static int |
AVATAR_URI_FIELD_NUMBER |
static int |
CLASSIFICATION_THRESHOLD_FIELD_NUMBER |
static int |
DEFAULT_LANGUAGE_CODE_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
DISPLAY_NAME_FIELD_NUMBER |
static int |
ENABLE_LOGGING_FIELD_NUMBER |
static int |
MATCH_MODE_FIELD_NUMBER |
static int |
PARENT_FIELD_NUMBER |
static int |
SUPPORTED_LANGUAGE_CODES_FIELD_NUMBER |
static int |
TIER_FIELD_NUMBER |
static int |
TIME_ZONE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
Agent.ApiVersion |
getApiVersion()
Optional.
|
int |
getApiVersionValue()
Optional.
|
String |
getAvatarUri()
Optional.
|
com.google.protobuf.ByteString |
getAvatarUriBytes()
Optional.
|
float |
getClassificationThreshold()
Optional.
|
static Agent |
getDefaultInstance() |
Agent |
getDefaultInstanceForType() |
String |
getDefaultLanguageCode()
Required.
|
com.google.protobuf.ByteString |
getDefaultLanguageCodeBytes()
Required.
|
String |
getDescription()
Optional.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
Optional.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDisplayName()
Required.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
Required.
|
boolean |
getEnableLogging()
Optional.
|
Agent.MatchMode |
getMatchMode()
Deprecated.
google.cloud.dialogflow.v2beta1.Agent.match_mode is deprecated. See
google/cloud/dialogflow/v2beta1/agent.proto;l=355
|
int |
getMatchModeValue()
Deprecated.
google.cloud.dialogflow.v2beta1.Agent.match_mode is deprecated. See
google/cloud/dialogflow/v2beta1/agent.proto;l=355
|
String |
getParent()
Required.
|
com.google.protobuf.ByteString |
getParentBytes()
Required.
|
com.google.protobuf.Parser<Agent> |
getParserForType() |
int |
getSerializedSize() |
String |
getSupportedLanguageCodes(int index)
Optional.
|
com.google.protobuf.ByteString |
getSupportedLanguageCodesBytes(int index)
Optional.
|
int |
getSupportedLanguageCodesCount()
Optional.
|
com.google.protobuf.ProtocolStringList |
getSupportedLanguageCodesList()
Optional.
|
Agent.Tier |
getTier()
Optional.
|
int |
getTierValue()
Optional.
|
String |
getTimeZone()
Required.
|
com.google.protobuf.ByteString |
getTimeZoneBytes()
Required.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Agent.Builder |
newBuilder() |
static Agent.Builder |
newBuilder(Agent prototype) |
Agent.Builder |
newBuilderForType() |
protected Agent.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Agent |
parseDelimitedFrom(InputStream input) |
static Agent |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Agent |
parseFrom(byte[] data) |
static Agent |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Agent |
parseFrom(ByteBuffer data) |
static Agent |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Agent |
parseFrom(com.google.protobuf.ByteString data) |
static Agent |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Agent |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Agent |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Agent |
parseFrom(InputStream input) |
static Agent |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Agent> |
parser() |
Agent.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int PARENT_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int DEFAULT_LANGUAGE_CODE_FIELD_NUMBER
public static final int SUPPORTED_LANGUAGE_CODES_FIELD_NUMBER
public static final int TIME_ZONE_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int AVATAR_URI_FIELD_NUMBER
public static final int ENABLE_LOGGING_FIELD_NUMBER
public static final int MATCH_MODE_FIELD_NUMBER
public static final int CLASSIFICATION_THRESHOLD_FIELD_NUMBER
public static final int API_VERSION_FIELD_NUMBER
public static final int TIER_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getParent()
Required. The project of this agent.
Format: `projects/<Project ID>` or
`projects/<Project ID>/locations/<Location ID>`
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParent in interface AgentOrBuilderpublic com.google.protobuf.ByteString getParentBytes()
Required. The project of this agent.
Format: `projects/<Project ID>` or
`projects/<Project ID>/locations/<Location ID>`
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParentBytes in interface AgentOrBuilderpublic String getDisplayName()
Required. The name of this agent.
string display_name = 2;getDisplayName in interface AgentOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
Required. The name of this agent.
string display_name = 2;getDisplayNameBytes in interface AgentOrBuilderpublic String getDefaultLanguageCode()
Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method.
string default_language_code = 3;getDefaultLanguageCode in interface AgentOrBuilderpublic com.google.protobuf.ByteString getDefaultLanguageCodeBytes()
Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method.
string default_language_code = 3;getDefaultLanguageCodeBytes in interface AgentOrBuilderpublic com.google.protobuf.ProtocolStringList getSupportedLanguageCodesList()
Optional. The list of all languages supported by this agent (except for the `default_language_code`).
repeated string supported_language_codes = 4;getSupportedLanguageCodesList in interface AgentOrBuilderpublic int getSupportedLanguageCodesCount()
Optional. The list of all languages supported by this agent (except for the `default_language_code`).
repeated string supported_language_codes = 4;getSupportedLanguageCodesCount in interface AgentOrBuilderpublic 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;getSupportedLanguageCodes in interface AgentOrBuilderindex - The index of the element to return.public com.google.protobuf.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;getSupportedLanguageCodesBytes in interface AgentOrBuilderindex - The index of the value to return.public String getTimeZone()
Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
string time_zone = 5;getTimeZone in interface AgentOrBuilderpublic com.google.protobuf.ByteString getTimeZoneBytes()
Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
string time_zone = 5;getTimeZoneBytes in interface AgentOrBuilderpublic String getDescription()
Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
string description = 6;getDescription in interface AgentOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
string description = 6;getDescriptionBytes in interface AgentOrBuilderpublic String getAvatarUri()
Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
string avatar_uri = 7;getAvatarUri in interface AgentOrBuilderpublic com.google.protobuf.ByteString getAvatarUriBytes()
Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
string avatar_uri = 7;getAvatarUriBytes in interface AgentOrBuilderpublic boolean getEnableLogging()
Optional. Determines whether this agent should log conversation queries.
bool enable_logging = 8;getEnableLogging in interface AgentOrBuilder@Deprecated public int getMatchModeValue()
Optional. Determines how intents are detected from user queries.
.google.cloud.dialogflow.v2beta1.Agent.MatchMode match_mode = 9 [deprecated = true];
getMatchModeValue in interface AgentOrBuilder@Deprecated public Agent.MatchMode getMatchMode()
Optional. Determines how intents are detected from user queries.
.google.cloud.dialogflow.v2beta1.Agent.MatchMode match_mode = 9 [deprecated = true];
getMatchMode in interface AgentOrBuilderpublic 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;getClassificationThreshold in interface AgentOrBuilderpublic 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.v2beta1.Agent.ApiVersion api_version = 14;getApiVersionValue in interface AgentOrBuilderpublic 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.v2beta1.Agent.ApiVersion api_version = 14;getApiVersion in interface AgentOrBuilderpublic int getTierValue()
Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
.google.cloud.dialogflow.v2beta1.Agent.Tier tier = 15;getTierValue in interface AgentOrBuilderpublic Agent.Tier getTier()
Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
.google.cloud.dialogflow.v2beta1.Agent.Tier tier = 15;getTier in interface AgentOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Agent parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Agent parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Agent parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Agent parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Agent parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Agent parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Agent parseFrom(InputStream input) throws IOException
IOExceptionpublic static Agent parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Agent parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Agent parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Agent parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Agent parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Agent.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Agent.Builder newBuilder()
public static Agent.Builder newBuilder(Agent prototype)
public Agent.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Agent.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Agent getDefaultInstance()
public static com.google.protobuf.Parser<Agent> parser()
public com.google.protobuf.Parser<Agent> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Agent getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023 Google LLC. All rights reserved.