public static final class Agent.Builder extends GeneratedMessageV3.Builder<Agent.Builder> 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.AgentgetAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofmergeDelimitedFrom, mergeDelimitedFrommergeFrompublic static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<Agent.Builder>public Agent.Builder clear()
clear in interface Message.Builderclear in interface MessageLite.Builderclear in class GeneratedMessageV3.Builder<Agent.Builder>public Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface Message.BuildergetDescriptorForType in interface MessageOrBuildergetDescriptorForType in class GeneratedMessageV3.Builder<Agent.Builder>public Agent getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderpublic Agent build()
build in interface Message.Builderbuild in interface MessageLite.Builderpublic Agent buildPartial()
buildPartial in interface Message.BuilderbuildPartial in interface MessageLite.Builderpublic Agent.Builder clone()
clone in interface Message.Builderclone in interface MessageLite.Builderclone in class GeneratedMessageV3.Builder<Agent.Builder>public Agent.Builder setField(Descriptors.FieldDescriptor field, Object value)
setField in interface Message.BuildersetField in class GeneratedMessageV3.Builder<Agent.Builder>public Agent.Builder clearField(Descriptors.FieldDescriptor field)
clearField in interface Message.BuilderclearField in class GeneratedMessageV3.Builder<Agent.Builder>public Agent.Builder clearOneof(Descriptors.OneofDescriptor oneof)
clearOneof in interface Message.BuilderclearOneof in class GeneratedMessageV3.Builder<Agent.Builder>public Agent.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface Message.BuildersetRepeatedField in class GeneratedMessageV3.Builder<Agent.Builder>public Agent.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface Message.BuilderaddRepeatedField in class GeneratedMessageV3.Builder<Agent.Builder>public Agent.Builder mergeFrom(Message other)
mergeFrom in interface Message.BuildermergeFrom in class AbstractMessage.Builder<Agent.Builder>public Agent.Builder mergeFrom(Agent other)
public final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3.Builder<Agent.Builder>public Agent.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessage.Builder<Agent.Builder>IOExceptionpublic 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 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 Agent.Builder setParent(String value)
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) = { ... }
value - The parent to set.public Agent.Builder clearParent()
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) = { ... }
public Agent.Builder setParentBytes(ByteString value)
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) = { ... }
value - The bytes for parent to set.public String getDisplayName()
Required. The name of this agent.
string display_name = 2;getDisplayName in interface AgentOrBuilderpublic ByteString getDisplayNameBytes()
Required. The name of this agent.
string display_name = 2;getDisplayNameBytes in interface AgentOrBuilderpublic Agent.Builder setDisplayName(String value)
Required. The name of this agent.
string display_name = 2;value - The displayName to set.public Agent.Builder clearDisplayName()
Required. The name of this agent.
string display_name = 2;public Agent.Builder setDisplayNameBytes(ByteString value)
Required. The name of this agent.
string display_name = 2;value - The bytes for displayName to set.public 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 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 Agent.Builder setDefaultLanguageCode(String value)
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;value - The defaultLanguageCode to set.public Agent.Builder clearDefaultLanguageCode()
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;public Agent.Builder setDefaultLanguageCodeBytes(ByteString value)
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;value - The bytes for defaultLanguageCode to set.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;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 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 Agent.Builder setSupportedLanguageCodes(int index, String value)
Optional. The list of all languages supported by this agent (except for the `default_language_code`).
repeated string supported_language_codes = 4;index - The index to set the value at.value - The supportedLanguageCodes to set.public Agent.Builder addSupportedLanguageCodes(String value)
Optional. The list of all languages supported by this agent (except for the `default_language_code`).
repeated string supported_language_codes = 4;value - The supportedLanguageCodes to add.public Agent.Builder addAllSupportedLanguageCodes(Iterable<String> values)
Optional. The list of all languages supported by this agent (except for the `default_language_code`).
repeated string supported_language_codes = 4;values - The supportedLanguageCodes to add.public Agent.Builder clearSupportedLanguageCodes()
Optional. The list of all languages supported by this agent (except for the `default_language_code`).
repeated string supported_language_codes = 4;public Agent.Builder addSupportedLanguageCodesBytes(ByteString value)
Optional. The list of all languages supported by this agent (except for the `default_language_code`).
repeated string supported_language_codes = 4;value - The bytes of the supportedLanguageCodes to add.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 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 Agent.Builder setTimeZone(String value)
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;value - The timeZone to set.public Agent.Builder clearTimeZone()
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;public Agent.Builder setTimeZoneBytes(ByteString value)
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;value - The bytes for timeZone to set.public 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 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 Agent.Builder setDescription(String value)
Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
string description = 6;value - The description to set.public Agent.Builder clearDescription()
Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
string description = 6;public Agent.Builder setDescriptionBytes(ByteString value)
Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
string description = 6;value - The bytes for description to set.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](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
string avatar_uri = 7;getAvatarUri in interface AgentOrBuilderpublic 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 Agent.Builder setAvatarUri(String value)
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;value - The avatarUri to set.public Agent.Builder clearAvatarUri()
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;public Agent.Builder setAvatarUriBytes(ByteString value)
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;value - The bytes for avatarUri to set.public boolean getEnableLogging()
Optional. Determines whether this agent should log conversation queries.
bool enable_logging = 8;getEnableLogging in interface AgentOrBuilderpublic Agent.Builder setEnableLogging(boolean value)
Optional. Determines whether this agent should log conversation queries.
bool enable_logging = 8;value - The enableLogging to set.public Agent.Builder clearEnableLogging()
Optional. Determines whether this agent should log conversation queries.
bool enable_logging = 8;@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.Builder setMatchModeValue(int value)
Optional. Determines how intents are detected from user queries.
.google.cloud.dialogflow.v2beta1.Agent.MatchMode match_mode = 9 [deprecated = true];
value - The enum numeric value on the wire for matchMode to set.@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 AgentOrBuilder@Deprecated public Agent.Builder setMatchMode(Agent.MatchMode value)
Optional. Determines how intents are detected from user queries.
.google.cloud.dialogflow.v2beta1.Agent.MatchMode match_mode = 9 [deprecated = true];
value - The matchMode to set.@Deprecated public Agent.Builder clearMatchMode()
Optional. Determines how intents are detected from user queries.
.google.cloud.dialogflow.v2beta1.Agent.MatchMode match_mode = 9 [deprecated = true];
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;getClassificationThreshold in interface AgentOrBuilderpublic Agent.Builder setClassificationThreshold(float value)
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;value - The classificationThreshold to set.public Agent.Builder clearClassificationThreshold()
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;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.v2beta1.Agent.ApiVersion api_version = 14;getApiVersionValue in interface AgentOrBuilderpublic Agent.Builder setApiVersionValue(int value)
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;value - The enum numeric value on the wire for apiVersion to set.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.v2beta1.Agent.ApiVersion api_version = 14;getApiVersion in interface AgentOrBuilderpublic Agent.Builder setApiVersion(Agent.ApiVersion value)
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;value - The apiVersion to set.public Agent.Builder clearApiVersion()
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;public 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.Builder setTierValue(int value)
Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
.google.cloud.dialogflow.v2beta1.Agent.Tier tier = 15;value - The enum numeric value on the wire for tier to set.public 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 Agent.Builder setTier(Agent.Tier value)
Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
.google.cloud.dialogflow.v2beta1.Agent.Tier tier = 15;value - The tier to set.public Agent.Builder clearTier()
Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
.google.cloud.dialogflow.v2beta1.Agent.Tier tier = 15;public final Agent.Builder setUnknownFields(UnknownFieldSet unknownFields)
setUnknownFields in interface Message.BuildersetUnknownFields in class GeneratedMessageV3.Builder<Agent.Builder>public final Agent.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
mergeUnknownFields in interface Message.BuildermergeUnknownFields in class GeneratedMessageV3.Builder<Agent.Builder>Copyright © 2022 Google LLC. All rights reserved.