- 4.58.0 (latest)
- 4.57.0
- 4.55.0
- 4.54.0
- 4.53.0
- 4.52.0
- 4.51.0
- 4.50.0
- 4.49.0
- 4.48.0
- 4.47.0
- 4.46.0
- 4.45.0
- 4.43.0
- 4.42.0
- 4.41.0
- 4.40.0
- 4.39.0
- 4.38.0
- 4.37.0
- 4.36.0
- 4.35.0
- 4.34.0
- 4.33.0
- 4.30.0
- 4.29.0
- 4.28.0
- 4.27.0
- 4.26.0
- 4.25.0
- 4.24.0
- 4.23.0
- 4.22.0
- 4.21.0
- 4.20.0
- 4.19.0
- 4.18.0
- 4.17.0
- 4.15.0
- 4.14.0
- 4.13.0
- 4.12.0
- 4.11.0
- 4.10.0
- 4.9.1
- 4.8.6
- 4.7.5
- 4.6.0
- 4.5.11
- 4.4.0
- 4.3.1
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.
Protobuf type google.cloud.dialogflow.v2beta1.Agent
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Agent.BuilderImplements
AgentOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addAllSupportedLanguageCodes(Iterable<String> values)
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;
Name | Description |
values | Iterable<String> The supportedLanguageCodes to add. |
Type | Description |
Agent.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Agent.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
Agent.Builder |
addSupportedLanguageCodes(String value)
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;
Name | Description |
value | String The supportedLanguageCodes to add. |
Type | Description |
Agent.Builder | This builder for chaining. |
addSupportedLanguageCodesBytes(ByteString value)
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;
Name | Description |
value | ByteString The bytes of the supportedLanguageCodes to add. |
Type | Description |
Agent.Builder | This builder for chaining. |
build()
public Agent build()
Type | Description |
Agent |
buildPartial()
public Agent buildPartial()
Type | Description |
Agent |
clear()
public Agent.Builder clear()
Type | Description |
Agent.Builder |
clearApiVersion()
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;
Type | Description |
Agent.Builder | This builder for chaining. |
clearAvatarUri()
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 integration.
string avatar_uri = 7;
Type | Description |
Agent.Builder | This builder for chaining. |
clearClassificationThreshold()
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;
Type | Description |
Agent.Builder | This builder for chaining. |
clearDefaultLanguageCode()
public Agent.Builder clearDefaultLanguageCode()
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;
Type | Description |
Agent.Builder | This builder for chaining. |
clearDescription()
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;
Type | Description |
Agent.Builder | This builder for chaining. |
clearDisplayName()
public Agent.Builder clearDisplayName()
Required. The name of this agent.
string display_name = 2;
Type | Description |
Agent.Builder | This builder for chaining. |
clearEnableLogging()
public Agent.Builder clearEnableLogging()
Optional. Determines whether this agent should log conversation queries.
bool enable_logging = 8;
Type | Description |
Agent.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Agent.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
Agent.Builder |
clearMatchMode()
public Agent.Builder clearMatchMode()
Optional. Determines how intents are detected from user queries.
.google.cloud.dialogflow.v2beta1.Agent.MatchMode match_mode = 9 [deprecated = true];
Type | Description |
Agent.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Agent.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
Agent.Builder |
clearParent()
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) = { ... }
Type | Description |
Agent.Builder | This builder for chaining. |
clearSupportedLanguageCodes()
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;
Type | Description |
Agent.Builder | This builder for chaining. |
clearTier()
public Agent.Builder clearTier()
Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
.google.cloud.dialogflow.v2beta1.Agent.Tier tier = 15;
Type | Description |
Agent.Builder | This builder for chaining. |
clearTimeZone()
public Agent.Builder clearTimeZone()
Required. The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
string time_zone = 5;
Type | Description |
Agent.Builder | This builder for chaining. |
clone()
public Agent.Builder clone()
Type | Description |
Agent.Builder |
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.v2beta1.Agent.ApiVersion api_version = 14;
Type | Description |
Agent.ApiVersion | The apiVersion. |
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.v2beta1.Agent.ApiVersion api_version = 14;
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;
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;
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;
Type | Description |
float | The classificationThreshold. |
getDefaultInstanceForType()
public Agent getDefaultInstanceForType()
Type | Description |
Agent |
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;
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;
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;
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;
Type | Description |
ByteString | The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
getDisplayName()
public String getDisplayName()
Required. The name of this agent.
string display_name = 2;
Type | Description |
String | The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Required. The name of this agent.
string display_name = 2;
Type | Description |
ByteString | The bytes for displayName. |
getEnableLogging()
public boolean getEnableLogging()
Optional. Determines whether this agent should log conversation queries.
bool enable_logging = 8;
Type | Description |
boolean | The enableLogging. |
getMatchMode()
public Agent.MatchMode getMatchMode()
Optional. Determines how intents are detected from user queries.
.google.cloud.dialogflow.v2beta1.Agent.MatchMode match_mode = 9 [deprecated = true];
Type | Description |
Agent.MatchMode | The matchMode. |
getMatchModeValue()
public int getMatchModeValue()
Optional. Determines how intents are detected from user queries.
.google.cloud.dialogflow.v2beta1.Agent.MatchMode match_mode = 9 [deprecated = true];
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>
or
projects/<Project ID>/locations/<Location 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>
or
projects/<Project ID>/locations/<Location ID>
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Type | Description |
ByteString | The bytes for parent. |
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;
Name | Description |
index | int The index of the element to return. |
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;
Name | Description |
index | int The index of the value to return. |
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;
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;
Type | Description |
ProtocolStringList | A list containing the supportedLanguageCodes. |
getTier()
public Agent.Tier getTier()
Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
.google.cloud.dialogflow.v2beta1.Agent.Tier tier = 15;
Type | Description |
Agent.Tier | The tier. |
getTierValue()
public int getTierValue()
Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
.google.cloud.dialogflow.v2beta1.Agent.Tier tier = 15;
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;
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;
Type | Description |
ByteString | The bytes for timeZone. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeFrom(Agent other)
public Agent.Builder mergeFrom(Agent other)
Name | Description |
other | Agent |
Type | Description |
Agent.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Agent.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
Agent.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public Agent.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
Agent.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Agent.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
Agent.Builder |
setApiVersion(Agent.ApiVersion value)
public 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;
Name | Description |
value | Agent.ApiVersion The apiVersion to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setApiVersionValue(int value)
public 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;
Name | Description |
value | int The enum numeric value on the wire for apiVersion to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setAvatarUri(String value)
public 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 integration.
string avatar_uri = 7;
Name | Description |
value | String The avatarUri to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setAvatarUriBytes(ByteString value)
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 integration.
string avatar_uri = 7;
Name | Description |
value | ByteString The bytes for avatarUri to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setClassificationThreshold(float value)
public 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;
Name | Description |
value | float The classificationThreshold to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setDefaultLanguageCode(String value)
public Agent.Builder setDefaultLanguageCode(String value)
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;
Name | Description |
value | String The defaultLanguageCode to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setDefaultLanguageCodeBytes(ByteString value)
public Agent.Builder setDefaultLanguageCodeBytes(ByteString value)
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;
Name | Description |
value | ByteString The bytes for defaultLanguageCode to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setDescription(String value)
public 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;
Name | Description |
value | String The description to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setDescriptionBytes(ByteString value)
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;
Name | Description |
value | ByteString The bytes for description to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setDisplayName(String value)
public Agent.Builder setDisplayName(String value)
Required. The name of this agent.
string display_name = 2;
Name | Description |
value | String The displayName to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Agent.Builder setDisplayNameBytes(ByteString value)
Required. The name of this agent.
string display_name = 2;
Name | Description |
value | ByteString The bytes for displayName to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setEnableLogging(boolean value)
public Agent.Builder setEnableLogging(boolean value)
Optional. Determines whether this agent should log conversation queries.
bool enable_logging = 8;
Name | Description |
value | boolean The enableLogging to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Agent.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
Agent.Builder |
setMatchMode(Agent.MatchMode value)
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];
Name | Description |
value | Agent.MatchMode The matchMode to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setMatchModeValue(int value)
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];
Name | Description |
value | int The enum numeric value on the wire for matchMode to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setParent(String value)
public 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) = { ... }
Name | Description |
value | String The parent to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setParentBytes(ByteString value)
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) = { ... }
Name | Description |
value | ByteString The bytes for parent to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Agent.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
Agent.Builder |
setSupportedLanguageCodes(int index, String value)
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;
Name | Description |
index | int The index to set the value at. |
value | String The supportedLanguageCodes to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setTier(Agent.Tier value)
public 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;
Name | Description |
value | Agent.Tier The tier to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setTierValue(int value)
public Agent.Builder setTierValue(int value)
Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
.google.cloud.dialogflow.v2beta1.Agent.Tier tier = 15;
Name | Description |
value | int The enum numeric value on the wire for tier to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setTimeZone(String value)
public Agent.Builder setTimeZone(String value)
Required. The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
string time_zone = 5;
Name | Description |
value | String The timeZone to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setTimeZoneBytes(ByteString value)
public Agent.Builder setTimeZoneBytes(ByteString value)
Required. The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
string time_zone = 5;
Name | Description |
value | ByteString The bytes for timeZone to set. |
Type | Description |
Agent.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Agent.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
Agent.Builder |