Class Agent (0.63.0) 

public final class Agent extends 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, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.

Protobuf type google.cloud.dialogflow.cx.v3.Agent

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Agent

Implements

AgentOrBuilder

Static Fields

ADVANCED_SETTINGS_FIELD_NUMBER

public static final int ADVANCED_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

ANSWER_FEEDBACK_SETTINGS_FIELD_NUMBER

public static final int ANSWER_FEEDBACK_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

AVATAR_URI_FIELD_NUMBER

public static final int AVATAR_URI_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_MULTI_LANGUAGE_TRAINING_FIELD_NUMBER

public static final int ENABLE_MULTI_LANGUAGE_TRAINING_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_SPELL_CORRECTION_FIELD_NUMBER

public static final int ENABLE_SPELL_CORRECTION_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_STACKDRIVER_LOGGING_FIELD_NUMBER

public static final int ENABLE_STACKDRIVER_LOGGING_FIELD_NUMBER
Field Value
Type Description
int

GEN_APP_BUILDER_SETTINGS_FIELD_NUMBER

public static final int GEN_APP_BUILDER_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

GIT_INTEGRATION_SETTINGS_FIELD_NUMBER

public static final int GIT_INTEGRATION_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

LOCKED_FIELD_NUMBER

public static final int LOCKED_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PERSONALIZATION_SETTINGS_FIELD_NUMBER

public static final int PERSONALIZATION_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

SECURITY_SETTINGS_FIELD_NUMBER

public static final int SECURITY_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

SPEECH_TO_TEXT_SETTINGS_FIELD_NUMBER

public static final int SPEECH_TO_TEXT_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

START_FLOW_FIELD_NUMBER

public static final int START_FLOW_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

TEXT_TO_SPEECH_SETTINGS_FIELD_NUMBER

public static final int TEXT_TO_SPEECH_SETTINGS_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

getAdvancedSettings()

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

Returns
Type Description
AdvancedSettings

The advancedSettings.

getAdvancedSettingsOrBuilder()

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

Returns
Type Description
AdvancedSettingsOrBuilder

getAnswerFeedbackSettings()

public Agent.AnswerFeedbackSettings getAnswerFeedbackSettings()

Optional. Answer feedback collection settings.

.google.cloud.dialogflow.cx.v3.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Agent.AnswerFeedbackSettings

The answerFeedbackSettings.

getAnswerFeedbackSettingsOrBuilder()

public Agent.AnswerFeedbackSettingsOrBuilder getAnswerFeedbackSettingsOrBuilder()

Optional. Answer feedback collection settings.

.google.cloud.dialogflow.cx.v3.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Agent.AnswerFeedbackSettingsOrBuilder

getAvatarUri()

public String getAvatarUri()

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;

Returns
Type Description
String

The avatarUri.

getAvatarUriBytes()

public ByteString getAvatarUriBytes()

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;

Returns
Type Description
ByteString

The bytes for avatarUri.

getDefaultInstanceForType()

public Agent getDefaultInstanceForType()
Returns
Type Description
Agent

getDefaultLanguageCode()

public String getDefaultLanguageCode()

Required. Immutable. 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 Agents.UpdateAgent method.

string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The defaultLanguageCode.

getDefaultLanguageCodeBytes()

public ByteString getDefaultLanguageCodeBytes()

Required. Immutable. 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 Agents.UpdateAgent method.

string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for defaultLanguageCode.

getDescription()

public String getDescription()

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

string description = 6;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

string description = 6;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Required. The human-readable name of the agent, unique within the location.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The human-readable name of the agent, unique within the location.

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

Returns
Type Description
ByteString

The bytes for displayName.

getEnableMultiLanguageTraining()

public boolean getEnableMultiLanguageTraining()

Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.

bool enable_multi_language_training = 40 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enableMultiLanguageTraining.

getEnableSpellCorrection()

public boolean getEnableSpellCorrection()

Indicates if automatic spell correction is enabled in detect intent requests.

bool enable_spell_correction = 20;

Returns
Type Description
boolean

The enableSpellCorrection.

getEnableStackdriverLogging() (deprecated)

public boolean getEnableStackdriverLogging()

Deprecated. google.cloud.dialogflow.cx.v3.Agent.enable_stackdriver_logging is deprecated. See google/cloud/dialogflow/cx/v3/agent.proto;l=337

Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.

bool enable_stackdriver_logging = 18 [deprecated = true];

Returns
Type Description
boolean

The enableStackdriverLogging.

getGenAppBuilderSettings()

public Agent.GenAppBuilderSettings getGenAppBuilderSettings()

Gen App Builder-related agent-level settings.

optional .google.cloud.dialogflow.cx.v3.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;

Returns
Type Description
Agent.GenAppBuilderSettings

The genAppBuilderSettings.

getGenAppBuilderSettingsOrBuilder()

public Agent.GenAppBuilderSettingsOrBuilder getGenAppBuilderSettingsOrBuilder()

Gen App Builder-related agent-level settings.

optional .google.cloud.dialogflow.cx.v3.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;

Returns
Type Description
Agent.GenAppBuilderSettingsOrBuilder

getGitIntegrationSettings()

public Agent.GitIntegrationSettings getGitIntegrationSettings()

Git integration settings for this agent.

.google.cloud.dialogflow.cx.v3.Agent.GitIntegrationSettings git_integration_settings = 30;

Returns
Type Description
Agent.GitIntegrationSettings

The gitIntegrationSettings.

getGitIntegrationSettingsOrBuilder()

public Agent.GitIntegrationSettingsOrBuilder getGitIntegrationSettingsOrBuilder()

Git integration settings for this agent.

.google.cloud.dialogflow.cx.v3.Agent.GitIntegrationSettings git_integration_settings = 30;

Returns
Type Description
Agent.GitIntegrationSettingsOrBuilder

getLocked()

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

Returns
Type Description
boolean

The locked.

getName()

public String getName()

The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getPersonalizationSettings()

public Agent.PersonalizationSettings getPersonalizationSettings()

Optional. Settings for end user personalization.

.google.cloud.dialogflow.cx.v3.Agent.PersonalizationSettings personalization_settings = 42 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Agent.PersonalizationSettings

The personalizationSettings.

getPersonalizationSettingsOrBuilder()

public Agent.PersonalizationSettingsOrBuilder getPersonalizationSettingsOrBuilder()

Optional. Settings for end user personalization.

.google.cloud.dialogflow.cx.v3.Agent.PersonalizationSettings personalization_settings = 42 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Agent.PersonalizationSettingsOrBuilder

getSecuritySettings()

public String getSecuritySettings()

Name of the SecuritySettings reference for the agent. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

string security_settings = 17 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The securitySettings.

getSecuritySettingsBytes()

public ByteString getSecuritySettingsBytes()

Name of the SecuritySettings reference for the agent. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

string security_settings = 17 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for securitySettings.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSpeechToTextSettings()

public SpeechToTextSettings getSpeechToTextSettings()

Speech recognition related settings.

.google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;

Returns
Type Description
SpeechToTextSettings

The speechToTextSettings.

getSpeechToTextSettingsOrBuilder()

public SpeechToTextSettingsOrBuilder getSpeechToTextSettingsOrBuilder()

Speech recognition related settings.

.google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;

Returns
Type Description
SpeechToTextSettingsOrBuilder

getStartFlow()

public 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) = { ... }

Returns
Type Description
String

The startFlow.

getStartFlowBytes()

public 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) = { ... }

Returns
Type Description
ByteString

The bytes for startFlow.

getSupportedLanguageCodes(int index)

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

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)

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

repeated string supported_language_codes = 4;

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

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

repeated string supported_language_codes = 4;

Returns
Type Description
int

The count of supportedLanguageCodes.

getSupportedLanguageCodesList()

public ProtocolStringList getSupportedLanguageCodesList()

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

repeated string supported_language_codes = 4;

Returns
Type Description
ProtocolStringList

A list containing the supportedLanguageCodes.

getTextToSpeechSettings()

public TextToSpeechSettings getTextToSpeechSettings()

Settings on instructing the speech synthesizer on how to generate the output audio content.

.google.cloud.dialogflow.cx.v3.TextToSpeechSettings text_to_speech_settings = 31;

Returns
Type Description
TextToSpeechSettings

The textToSpeechSettings.

getTextToSpeechSettingsOrBuilder()

public TextToSpeechSettingsOrBuilder getTextToSpeechSettingsOrBuilder()

Settings on instructing the speech synthesizer on how to generate the output audio content.

.google.cloud.dialogflow.cx.v3.TextToSpeechSettings text_to_speech_settings = 31;

Returns
Type Description
TextToSpeechSettingsOrBuilder

getTimeZone()

public String getTimeZone()

Required. The time zone of the 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 the 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.

hasAdvancedSettings()

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

Returns
Type Description
boolean

Whether the advancedSettings field is set.

hasAnswerFeedbackSettings()

public boolean hasAnswerFeedbackSettings()

Optional. Answer feedback collection settings.

.google.cloud.dialogflow.cx.v3.Agent.AnswerFeedbackSettings answer_feedback_settings = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the answerFeedbackSettings field is set.

hasGenAppBuilderSettings()

public boolean hasGenAppBuilderSettings()

Gen App Builder-related agent-level settings.

optional .google.cloud.dialogflow.cx.v3.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;

Returns
Type Description
boolean

Whether the genAppBuilderSettings field is set.

hasGitIntegrationSettings()

public boolean hasGitIntegrationSettings()

Git integration settings for this agent.

.google.cloud.dialogflow.cx.v3.Agent.GitIntegrationSettings git_integration_settings = 30;

Returns
Type Description
boolean

Whether the gitIntegrationSettings field is set.

hasPersonalizationSettings()

public boolean hasPersonalizationSettings()

Optional. Settings for end user personalization.

.google.cloud.dialogflow.cx.v3.Agent.PersonalizationSettings personalization_settings = 42 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the personalizationSettings field is set.

hasSpeechToTextSettings()

public boolean hasSpeechToTextSettings()

Speech recognition related settings.

.google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;

Returns
Type Description
boolean

Whether the speechToTextSettings field is set.

hasTextToSpeechSettings()

public boolean hasTextToSpeechSettings()

Settings on instructing the speech synthesizer on how to generate the output audio content.

.google.cloud.dialogflow.cx.v3.TextToSpeechSettings text_to_speech_settings = 31;

Returns
Type Description
boolean

Whether the textToSpeechSettings field is set.

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