com.google.cloud.dialogflow.v2

Class Agent

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dialogflow.v2.Agent

All Implemented Interfaces:

AgentOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class Agent
extends GeneratedMessageV3
implements AgentOrBuilder

 A Dialogflow agent is a virtual agent that handles conversations with your
 end-users. It is a natural language understanding module that understands the
 nuances of human language. Dialogflow translates end-user text or audio
 during a conversation to structured data that your apps and services can
 understand. You design and build a Dialogflow agent to handle the types of
 conversations required for your system.
 For more information about agents, see the
 [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).
 

Protobuf type google.cloud.dialogflow.v2.Agent

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Agent.ApiVersion API version for the agent.
static class	Agent.Builder A Dialogflow agent is a virtual agent that handles conversations with your end-users.
static class	Agent.MatchMode Match mode determines how intents are detected from user queries.
static class	Agent.Tier Represents the agent tier.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	API_VERSION_FIELD_NUMBER
static int	AVATAR_URI_FIELD_NUMBER
static int	CLASSIFICATION_THRESHOLD_FIELD_NUMBER
static int	DEFAULT_LANGUAGE_CODE_FIELD_NUMBER
static int	DESCRIPTION_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	ENABLE_LOGGING_FIELD_NUMBER
static int	MATCH_MODE_FIELD_NUMBER
static int	PARENT_FIELD_NUMBER
static int	SUPPORTED_LANGUAGE_CODES_FIELD_NUMBER
static int	TIER_FIELD_NUMBER
static int	TIME_ZONE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Agent.ApiVersion	getApiVersion() Optional.
int	getApiVersionValue() Optional.
String	getAvatarUri() Optional.
ByteString	getAvatarUriBytes() Optional.
float	getClassificationThreshold() Optional.
static Agent	getDefaultInstance()
Agent	getDefaultInstanceForType()
String	getDefaultLanguageCode() Required.
ByteString	getDefaultLanguageCodeBytes() Required.
String	getDescription() Optional.
ByteString	getDescriptionBytes() Optional.
static Descriptors.Descriptor	getDescriptor()
String	getDisplayName() Required.
ByteString	getDisplayNameBytes() Required.
boolean	getEnableLogging() Optional.
Agent.MatchMode	getMatchMode() Deprecated. google.cloud.dialogflow.v2.Agent.match_mode is deprecated. See google/cloud/dialogflow/v2/agent.proto;l=349
int	getMatchModeValue() Deprecated. google.cloud.dialogflow.v2.Agent.match_mode is deprecated. See google/cloud/dialogflow/v2/agent.proto;l=349
String	getParent() Required.
ByteString	getParentBytes() Required.
Parser<Agent>	getParserForType()
int	getSerializedSize()
String	getSupportedLanguageCodes(int index) Optional.
ByteString	getSupportedLanguageCodesBytes(int index) Optional.
int	getSupportedLanguageCodesCount() Optional.
ProtocolStringList	getSupportedLanguageCodesList() Optional.
Agent.Tier	getTier() Optional.
int	getTierValue() Optional.
String	getTimeZone() Required.
ByteString	getTimeZoneBytes() Required.
UnknownFieldSet	getUnknownFields()
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Agent.Builder	newBuilder()
static Agent.Builder	newBuilder(Agent prototype)
Agent.Builder	newBuilderForType()
protected Agent.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static Agent	parseDelimitedFrom(InputStream input)
static Agent	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Agent	parseFrom(byte[] data)
static Agent	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Agent	parseFrom(ByteBuffer data)
static Agent	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Agent	parseFrom(ByteString data)
static Agent	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static Agent	parseFrom(CodedInputStream input)
static Agent	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static Agent	parseFrom(InputStream input)
static Agent	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<Agent>	parser()
Agent.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

DEFAULT_LANGUAGE_CODE_FIELD_NUMBER

public static final int DEFAULT_LANGUAGE_CODE_FIELD_NUMBER

See Also:

Constant Field Values

SUPPORTED_LANGUAGE_CODES_FIELD_NUMBER

public static final int SUPPORTED_LANGUAGE_CODES_FIELD_NUMBER

See Also:

Constant Field Values

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER

See Also:

Constant Field Values

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

AVATAR_URI_FIELD_NUMBER

public static final int AVATAR_URI_FIELD_NUMBER

See Also:

Constant Field Values

ENABLE_LOGGING_FIELD_NUMBER

public static final int ENABLE_LOGGING_FIELD_NUMBER

See Also:

Constant Field Values

MATCH_MODE_FIELD_NUMBER

public static final int MATCH_MODE_FIELD_NUMBER

See Also:

Constant Field Values

CLASSIFICATION_THRESHOLD_FIELD_NUMBER

public static final int CLASSIFICATION_THRESHOLD_FIELD_NUMBER

See Also:

Constant Field Values

API_VERSION_FIELD_NUMBER

public static final int API_VERSION_FIELD_NUMBER

See Also:

Constant Field Values

TIER_FIELD_NUMBER

public static final int TIER_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getParent

public String getParent()

 Required. The project of this agent.
 Format: `projects/<Project ID>`.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getParent in interface AgentOrBuilder

Returns:

The parent.

getParentBytes

public ByteString getParentBytes()

 Required. The project of this agent.
 Format: `projects/<Project ID>`.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getParentBytes in interface AgentOrBuilder

Returns:

The bytes for parent.

getDisplayName

public String getDisplayName()

 Required. The name of this agent.
 

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

Specified by:

getDisplayName in interface AgentOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public ByteString getDisplayNameBytes()

 Required. The name of this agent.
 

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

Specified by:

getDisplayNameBytes in interface AgentOrBuilder

Returns:

The bytes for displayName.

getDefaultLanguageCode

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 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDefaultLanguageCode in interface AgentOrBuilder

Returns:

The defaultLanguageCode.

getDefaultLanguageCodeBytes

public 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 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDefaultLanguageCodeBytes in interface AgentOrBuilder

Returns:

The bytes for defaultLanguageCode.

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 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSupportedLanguageCodesList in interface AgentOrBuilder

Returns:

A list containing the supportedLanguageCodes.

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 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSupportedLanguageCodesCount in interface AgentOrBuilder

Returns:

The count of supportedLanguageCodes.

getSupportedLanguageCodes

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 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSupportedLanguageCodes in interface AgentOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The supportedLanguageCodes at the given index.

getSupportedLanguageCodesBytes

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 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSupportedLanguageCodesBytes in interface AgentOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the supportedLanguageCodes at the given index.

getTimeZone

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 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getTimeZone in interface AgentOrBuilder

Returns:

The timeZone.

getTimeZoneBytes

public 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 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getTimeZoneBytes in interface AgentOrBuilder

Returns:

The bytes for timeZone.

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 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDescription in interface AgentOrBuilder

Returns:

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 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDescriptionBytes in interface AgentOrBuilder

Returns:

The bytes for description.

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](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
 integration.
 

string avatar_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getAvatarUri in interface AgentOrBuilder

Returns:

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](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
 integration.
 

string avatar_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getAvatarUriBytes in interface AgentOrBuilder

Returns:

The bytes for avatarUri.

getEnableLogging

public boolean getEnableLogging()

 Optional. Determines whether this agent should log conversation queries.
 

bool enable_logging = 8 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getEnableLogging in interface AgentOrBuilder

Returns:

The enableLogging.

getMatchModeValue

@Deprecated
public int getMatchModeValue()

Deprecated. google.cloud.dialogflow.v2.Agent.match_mode is deprecated. See google/cloud/dialogflow/v2/agent.proto;l=349

 Optional. Determines how intents are detected from user queries.
 

.google.cloud.dialogflow.v2.Agent.MatchMode match_mode = 9 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Specified by:

getMatchModeValue in interface AgentOrBuilder

Returns:

The enum numeric value on the wire for matchMode.

getMatchMode

@Deprecated
public Agent.MatchMode getMatchMode()

Deprecated. google.cloud.dialogflow.v2.Agent.match_mode is deprecated. See google/cloud/dialogflow/v2/agent.proto;l=349

 Optional. Determines how intents are detected from user queries.
 

.google.cloud.dialogflow.v2.Agent.MatchMode match_mode = 9 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Specified by:

getMatchMode in interface AgentOrBuilder

Returns:

The matchMode.

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 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getClassificationThreshold in interface AgentOrBuilder

Returns:

The classificationThreshold.

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.v2.Agent.ApiVersion api_version = 14 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getApiVersionValue in interface AgentOrBuilder

Returns:

The enum numeric value on the wire for apiVersion.

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.v2.Agent.ApiVersion api_version = 14 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getApiVersion in interface AgentOrBuilder

Returns:

The apiVersion.

getTierValue

public int getTierValue()

 Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
 

.google.cloud.dialogflow.v2.Agent.Tier tier = 15 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getTierValue in interface AgentOrBuilder

Returns:

The enum numeric value on the wire for tier.

getTier

public Agent.Tier getTier()

 Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
 

.google.cloud.dialogflow.v2.Agent.Tier tier = 15 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getTier in interface AgentOrBuilder

Returns:

The tier.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static Agent parseFrom(ByteBuffer data)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Agent parseFrom(ByteBuffer data,
                              ExtensionRegistryLite extensionRegistry)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Agent parseFrom(ByteString data)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Agent parseFrom(ByteString data,
                              ExtensionRegistryLite extensionRegistry)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Agent parseFrom(byte[] data)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Agent parseFrom(byte[] data,
                              ExtensionRegistryLite extensionRegistry)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Agent parseFrom(InputStream input)
                       throws IOException

Throws:

IOException

parseFrom

public static Agent parseFrom(InputStream input,
                              ExtensionRegistryLite extensionRegistry)
                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static Agent parseDelimitedFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static Agent parseDelimitedFrom(InputStream input,
                                       ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseFrom

public static Agent parseFrom(CodedInputStream input)
                       throws IOException

Throws:

IOException

parseFrom

public static Agent parseFrom(CodedInputStream input,
                              ExtensionRegistryLite extensionRegistry)
                       throws IOException

Throws:

IOException

newBuilderForType

public Agent.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Agent.Builder newBuilder()

newBuilder

public static Agent.Builder newBuilder(Agent prototype)

toBuilder

public Agent.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Agent.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Agent getDefaultInstance()

parser

public static Parser<Agent> parser()

getParserForType

public Parser<Agent> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public Agent getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder