public final class Agent extends com.google.protobuf.GeneratedMessageV3 implements AgentOrBuilder
Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add [Intents][google.cloud.dialogflow.cx.v3.Intent], [Entity Types][google.cloud.dialogflow.cx.v3.EntityType], [Flows][google.cloud.dialogflow.cx.v3.Flow], [Fulfillments][google.cloud.dialogflow.cx.v3.Fulfillment], [Webhooks][google.cloud.dialogflow.cx.v3.Webhook], and so on to manage the conversation flows..Protobuf type
google.cloud.dialogflow.cx.v3.Agent| Modifier and Type | Class and Description |
|---|---|
static class |
Agent.Builder
Agents are best described as Natural Language Understanding (NLU) modules
that transform user requests into actionable data.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
ADVANCED_SETTINGS_FIELD_NUMBER |
static int |
AVATAR_URI_FIELD_NUMBER |
static int |
DEFAULT_LANGUAGE_CODE_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
DISPLAY_NAME_FIELD_NUMBER |
static int |
ENABLE_SPELL_CORRECTION_FIELD_NUMBER |
static int |
ENABLE_STACKDRIVER_LOGGING_FIELD_NUMBER |
static int |
LOCKED_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
SECURITY_SETTINGS_FIELD_NUMBER |
static int |
SPEECH_TO_TEXT_SETTINGS_FIELD_NUMBER |
static int |
START_FLOW_FIELD_NUMBER |
static int |
SUPPORTED_LANGUAGE_CODES_FIELD_NUMBER |
static int |
TIME_ZONE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
AdvancedSettings |
getAdvancedSettings()
Hierarchical advanced settings for this agent.
|
AdvancedSettingsOrBuilder |
getAdvancedSettingsOrBuilder()
Hierarchical advanced settings for this agent.
|
String |
getAvatarUri()
The URI of the agent's avatar.
|
com.google.protobuf.ByteString |
getAvatarUriBytes()
The URI of the agent's avatar.
|
static Agent |
getDefaultInstance() |
Agent |
getDefaultInstanceForType() |
String |
getDefaultLanguageCode()
Required.
|
com.google.protobuf.ByteString |
getDefaultLanguageCodeBytes()
Required.
|
String |
getDescription()
The description of the agent.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
The description of the agent.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDisplayName()
Required.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
Required.
|
boolean |
getEnableSpellCorrection()
Indicates if automatic spell correction is enabled in detect intent
requests.
|
boolean |
getEnableStackdriverLogging()
Deprecated.
google.cloud.dialogflow.cx.v3.Agent.enable_stackdriver_logging is deprecated. See
google/cloud/dialogflow/cx/v3/agent.proto;l=245
|
boolean |
getLocked()
Indicates whether the agent is locked for changes.
|
String |
getName()
The unique identifier of the agent.
|
com.google.protobuf.ByteString |
getNameBytes()
The unique identifier of the agent.
|
com.google.protobuf.Parser<Agent> |
getParserForType() |
String |
getSecuritySettings()
Name of the [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] reference for the agent.
|
com.google.protobuf.ByteString |
getSecuritySettingsBytes()
Name of the [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] reference for the agent.
|
int |
getSerializedSize() |
SpeechToTextSettings |
getSpeechToTextSettings()
Speech recognition related settings.
|
SpeechToTextSettingsOrBuilder |
getSpeechToTextSettingsOrBuilder()
Speech recognition related settings.
|
String |
getStartFlow()
Immutable.
|
com.google.protobuf.ByteString |
getStartFlowBytes()
Immutable.
|
String |
getSupportedLanguageCodes(int index)
The list of all languages supported by the agent (except for the
`default_language_code`).
|
com.google.protobuf.ByteString |
getSupportedLanguageCodesBytes(int index)
The list of all languages supported by the agent (except for the
`default_language_code`).
|
int |
getSupportedLanguageCodesCount()
The list of all languages supported by the agent (except for the
`default_language_code`).
|
com.google.protobuf.ProtocolStringList |
getSupportedLanguageCodesList()
The list of all languages supported by the agent (except for the
`default_language_code`).
|
String |
getTimeZone()
Required.
|
com.google.protobuf.ByteString |
getTimeZoneBytes()
Required.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasAdvancedSettings()
Hierarchical advanced settings for this agent.
|
int |
hashCode() |
boolean |
hasSpeechToTextSettings()
Speech recognition related settings.
|
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, 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 NAME_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 SPEECH_TO_TEXT_SETTINGS_FIELD_NUMBER
public static final int START_FLOW_FIELD_NUMBER
public static final int SECURITY_SETTINGS_FIELD_NUMBER
public static final int ENABLE_STACKDRIVER_LOGGING_FIELD_NUMBER
public static final int ENABLE_SPELL_CORRECTION_FIELD_NUMBER
public static final int LOCKED_FIELD_NUMBER
public static final int ADVANCED_SETTINGS_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 getName()
The unique identifier of the agent. Required for the [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent] method. [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent] populates the name automatically. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
string name = 1;getName in interface AgentOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
The unique identifier of the agent. Required for the [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent] method. [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent] populates the name automatically. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
string name = 1;getNameBytes in interface AgentOrBuilderpublic String getDisplayName()
Required. The human-readable name of the agent, unique within the location.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayName in interface AgentOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
Required. The human-readable name of the agent, unique within the location.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayNameBytes in interface AgentOrBuilderpublic String getDefaultLanguageCode()
Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent] method.
string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
getDefaultLanguageCode in interface AgentOrBuilderpublic com.google.protobuf.ByteString getDefaultLanguageCodeBytes()
Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent] method.
string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
getDefaultLanguageCodeBytes in interface AgentOrBuilderpublic com.google.protobuf.ProtocolStringList getSupportedLanguageCodesList()
The list of all languages supported by the agent (except for the `default_language_code`).
repeated string supported_language_codes = 4;getSupportedLanguageCodesList in interface AgentOrBuilderpublic int getSupportedLanguageCodesCount()
The list of all languages supported by the agent (except for the `default_language_code`).
repeated string supported_language_codes = 4;getSupportedLanguageCodesCount in interface AgentOrBuilderpublic String getSupportedLanguageCodes(int index)
The list of all languages supported by the 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)
The list of all languages supported by the 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 the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];getTimeZone in interface AgentOrBuilderpublic com.google.protobuf.ByteString getTimeZoneBytes()
Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];getTimeZoneBytes in interface AgentOrBuilderpublic String getDescription()
The description of the 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()
The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
string description = 6;getDescriptionBytes in interface AgentOrBuilderpublic String getAvatarUri()
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()
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 hasSpeechToTextSettings()
Speech recognition related settings.
.google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;hasSpeechToTextSettings in interface AgentOrBuilderpublic SpeechToTextSettings getSpeechToTextSettings()
Speech recognition related settings.
.google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;getSpeechToTextSettings in interface AgentOrBuilderpublic SpeechToTextSettingsOrBuilder getSpeechToTextSettingsOrBuilder()
Speech recognition related settings.
.google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;getSpeechToTextSettingsOrBuilder in interface AgentOrBuilderpublic String getStartFlow()
Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>`.
string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
getStartFlow in interface AgentOrBuilderpublic com.google.protobuf.ByteString getStartFlowBytes()
Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>`.
string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
getStartFlowBytes in interface AgentOrBuilderpublic String getSecuritySettings()
Name of the [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] reference for the agent. Format: `projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>`.
string security_settings = 17 [(.google.api.resource_reference) = { ... }getSecuritySettings in interface AgentOrBuilderpublic com.google.protobuf.ByteString getSecuritySettingsBytes()
Name of the [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] reference for the agent. Format: `projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>`.
string security_settings = 17 [(.google.api.resource_reference) = { ... }getSecuritySettingsBytes in interface AgentOrBuilder@Deprecated public boolean getEnableStackdriverLogging()
Indicates if stackdriver logging is enabled for the agent. Please use [agent.advanced_settings][google.cloud.dialogflow.cx.v3.AdvancedSettings.LoggingSettings] instead.
bool enable_stackdriver_logging = 18 [deprecated = true];getEnableStackdriverLogging in interface AgentOrBuilderpublic boolean getEnableSpellCorrection()
Indicates if automatic spell correction is enabled in detect intent requests.
bool enable_spell_correction = 20;getEnableSpellCorrection in interface AgentOrBuilderpublic boolean getLocked()
Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [RestoreAgent][].
bool locked = 27;getLocked in interface AgentOrBuilderpublic boolean hasAdvancedSettings()
Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 22;hasAdvancedSettings in interface AgentOrBuilderpublic AdvancedSettings getAdvancedSettings()
Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 22;getAdvancedSettings in interface AgentOrBuilderpublic AdvancedSettingsOrBuilder getAdvancedSettingsOrBuilder()
Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 22;getAdvancedSettingsOrBuilder 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 © 2022 Google LLC. All rights reserved.