- 4.53.0 (latest)
- 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 final class Intent extends GeneratedMessageV3 implements IntentOrBuilder
An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification.
For more information, see the intent guide.
Protobuf type google.cloud.dialogflow.v2.Intent
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > IntentImplements
IntentOrBuilderStatic Fields
ACTION_FIELD_NUMBER
public static final int ACTION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DEFAULT_RESPONSE_PLATFORMS_FIELD_NUMBER
public static final int DEFAULT_RESPONSE_PLATFORMS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
END_INTERACTION_FIELD_NUMBER
public static final int END_INTERACTION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
EVENTS_FIELD_NUMBER
public static final int EVENTS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
FOLLOWUP_INTENT_INFO_FIELD_NUMBER
public static final int FOLLOWUP_INTENT_INFO_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
INPUT_CONTEXT_NAMES_FIELD_NUMBER
public static final int INPUT_CONTEXT_NAMES_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
IS_FALLBACK_FIELD_NUMBER
public static final int IS_FALLBACK_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
LIVE_AGENT_HANDOFF_FIELD_NUMBER
public static final int LIVE_AGENT_HANDOFF_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
MESSAGES_FIELD_NUMBER
public static final int MESSAGES_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
ML_DISABLED_FIELD_NUMBER
public static final int ML_DISABLED_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
OUTPUT_CONTEXTS_FIELD_NUMBER
public static final int OUTPUT_CONTEXTS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
PARAMETERS_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
PARENT_FOLLOWUP_INTENT_NAME_FIELD_NUMBER
public static final int PARENT_FOLLOWUP_INTENT_NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
PRIORITY_FIELD_NUMBER
public static final int PRIORITY_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
RESET_CONTEXTS_FIELD_NUMBER
public static final int RESET_CONTEXTS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
ROOT_FOLLOWUP_INTENT_NAME_FIELD_NUMBER
public static final int ROOT_FOLLOWUP_INTENT_NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
TRAINING_PHRASES_FIELD_NUMBER
public static final int TRAINING_PHRASES_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
WEBHOOK_STATE_FIELD_NUMBER
public static final int WEBHOOK_STATE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static Intent getDefaultInstance()
Returns | |
---|---|
Type | Description |
Intent |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static Intent.Builder newBuilder()
Returns | |
---|---|
Type | Description |
Intent.Builder |
newBuilder(Intent prototype)
public static Intent.Builder newBuilder(Intent prototype)
Parameter | |
---|---|
Name | Description |
prototype |
Intent |
Returns | |
---|---|
Type | Description |
Intent.Builder |
parseDelimitedFrom(InputStream input)
public static Intent parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
Intent |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Intent parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Intent |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static Intent parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
Intent |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Intent parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Intent |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static Intent parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
Intent |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Intent parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Intent |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static Intent parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
Intent |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Intent parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Intent |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static Intent parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
Intent |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Intent parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Intent |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static Intent parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
Intent |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Intent parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Intent |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<Intent> parser()
Returns | |
---|---|
Type | Description |
Parser<Intent> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
getAction()
public String getAction()
Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.
string action = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String |
The action. |
getActionBytes()
public ByteString getActionBytes()
Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.
string action = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for action. |
getDefaultInstanceForType()
public Intent getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Intent |
getDefaultResponsePlatforms(int index)
public Intent.Message.Platform getDefaultResponsePlatforms(int index)
Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
repeated .google.cloud.dialogflow.v2.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int The index of the element to return. |
Returns | |
---|---|
Type | Description |
Intent.Message.Platform |
The defaultResponsePlatforms at the given index. |
getDefaultResponsePlatformsCount()
public int getDefaultResponsePlatformsCount()
Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
repeated .google.cloud.dialogflow.v2.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
The count of defaultResponsePlatforms. |
getDefaultResponsePlatformsList()
public List<Intent.Message.Platform> getDefaultResponsePlatformsList()
Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
repeated .google.cloud.dialogflow.v2.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<Platform> |
A list containing the defaultResponsePlatforms. |
getDefaultResponsePlatformsValue(int index)
public int getDefaultResponsePlatformsValue(int index)
Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
repeated .google.cloud.dialogflow.v2.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int The index of the value to return. |
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire of defaultResponsePlatforms at the given index. |
getDefaultResponsePlatformsValueList()
public List<Integer> getDefaultResponsePlatformsValueList()
Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
repeated .google.cloud.dialogflow.v2.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for defaultResponsePlatforms. |
getDisplayName()
public String getDisplayName()
Required. The name of this intent.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Required. The name of this intent.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for displayName. |
getEndInteraction()
public boolean getEndInteraction()
Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.
bool end_interaction = 21 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
The endInteraction. |
getEvents(int index)
public String getEvents(int index)
Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.
repeated string events = 8 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String |
The events at the given index. |
getEventsBytes(int index)
public ByteString getEventsBytes(int index)
Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.
repeated string events = 8 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString |
The bytes of the events at the given index. |
getEventsCount()
public int getEventsCount()
Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.
repeated string events = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
The count of events. |
getEventsList()
public ProtocolStringList getEventsList()
Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.
repeated string events = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ProtocolStringList |
A list containing the events. |
getFollowupIntentInfo(int index)
public Intent.FollowupIntentInfo getFollowupIntentInfo(int index)
Output only. Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.
repeated .google.cloud.dialogflow.v2.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Intent.FollowupIntentInfo |
getFollowupIntentInfoCount()
public int getFollowupIntentInfoCount()
Output only. Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.
repeated .google.cloud.dialogflow.v2.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int |
getFollowupIntentInfoList()
public List<Intent.FollowupIntentInfo> getFollowupIntentInfoList()
Output only. Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.
repeated .google.cloud.dialogflow.v2.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
List<FollowupIntentInfo> |
getFollowupIntentInfoOrBuilder(int index)
public Intent.FollowupIntentInfoOrBuilder getFollowupIntentInfoOrBuilder(int index)
Output only. Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.
repeated .google.cloud.dialogflow.v2.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Intent.FollowupIntentInfoOrBuilder |
getFollowupIntentInfoOrBuilderList()
public List<? extends Intent.FollowupIntentInfoOrBuilder> getFollowupIntentInfoOrBuilderList()
Output only. Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.
repeated .google.cloud.dialogflow.v2.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.dialogflow.v2.Intent.FollowupIntentInfoOrBuilder> |
getInputContextNames(int index)
public String getInputContextNames(int index)
Optional. The list of context names required for this intent to be
triggered.
Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
.
repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String |
The inputContextNames at the given index. |
getInputContextNamesBytes(int index)
public ByteString getInputContextNamesBytes(int index)
Optional. The list of context names required for this intent to be
triggered.
Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
.
repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString |
The bytes of the inputContextNames at the given index. |
getInputContextNamesCount()
public int getInputContextNamesCount()
Optional. The list of context names required for this intent to be
triggered.
Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
.
repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
The count of inputContextNames. |
getInputContextNamesList()
public ProtocolStringList getInputContextNamesList()
Optional. The list of context names required for this intent to be
triggered.
Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
.
repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ProtocolStringList |
A list containing the inputContextNames. |
getIsFallback()
public boolean getIsFallback()
Optional. Indicates whether this is a fallback intent.
bool is_fallback = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
The isFallback. |
getLiveAgentHandoff()
public boolean getLiveAgentHandoff()
Optional. Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false.
bool live_agent_handoff = 20 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
The liveAgentHandoff. |
getMessages(int index)
public Intent.Message getMessages(int index)
Optional. The collection of rich messages corresponding to the
Response
field in the Dialogflow console.
repeated .google.cloud.dialogflow.v2.Intent.Message messages = 14 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Intent.Message |
getMessagesCount()
public int getMessagesCount()
Optional. The collection of rich messages corresponding to the
Response
field in the Dialogflow console.
repeated .google.cloud.dialogflow.v2.Intent.Message messages = 14 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
getMessagesList()
public List<Intent.Message> getMessagesList()
Optional. The collection of rich messages corresponding to the
Response
field in the Dialogflow console.
repeated .google.cloud.dialogflow.v2.Intent.Message messages = 14 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<Message> |
getMessagesOrBuilder(int index)
public Intent.MessageOrBuilder getMessagesOrBuilder(int index)
Optional. The collection of rich messages corresponding to the
Response
field in the Dialogflow console.
repeated .google.cloud.dialogflow.v2.Intent.Message messages = 14 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Intent.MessageOrBuilder |
getMessagesOrBuilderList()
public List<? extends Intent.MessageOrBuilder> getMessagesOrBuilderList()
Optional. The collection of rich messages corresponding to the
Response
field in the Dialogflow console.
repeated .google.cloud.dialogflow.v2.Intent.Message messages = 14 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.dialogflow.v2.Intent.MessageOrBuilder> |
getMlDisabled()
public boolean getMlDisabled()
Optional. Indicates whether Machine Learning is disabled for the intent.
Note: If ml_disabled
setting is set to true, then this intent is not
taken into account during inference in ML ONLY
match mode. Also,
auto-markup in the UI is turned off.
bool ml_disabled = 19 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
The mlDisabled. |
getName()
public String getName()
Optional. The unique identifier of this intent.
Required for
Intents.UpdateIntent and
Intents.BatchUpdateIntents
methods.
Format: projects/<Project ID>/agent/intents/<Intent ID>
.
string name = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
Optional. The unique identifier of this intent.
Required for
Intents.UpdateIntent and
Intents.BatchUpdateIntents
methods.
Format: projects/<Project ID>/agent/intents/<Intent ID>
.
string name = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
getOutputContexts(int index)
public Context getOutputContexts(int index)
Optional. The collection of contexts that are activated when the intent
is matched. Context messages in this collection should not set the
parameters field. Setting the lifespan_count
to 0 will reset the context
when the intent is matched.
Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
.
repeated .google.cloud.dialogflow.v2.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Context |
getOutputContextsCount()
public int getOutputContextsCount()
Optional. The collection of contexts that are activated when the intent
is matched. Context messages in this collection should not set the
parameters field. Setting the lifespan_count
to 0 will reset the context
when the intent is matched.
Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
.
repeated .google.cloud.dialogflow.v2.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
getOutputContextsList()
public List<Context> getOutputContextsList()
Optional. The collection of contexts that are activated when the intent
is matched. Context messages in this collection should not set the
parameters field. Setting the lifespan_count
to 0 will reset the context
when the intent is matched.
Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
.
repeated .google.cloud.dialogflow.v2.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<Context> |
getOutputContextsOrBuilder(int index)
public ContextOrBuilder getOutputContextsOrBuilder(int index)
Optional. The collection of contexts that are activated when the intent
is matched. Context messages in this collection should not set the
parameters field. Setting the lifespan_count
to 0 will reset the context
when the intent is matched.
Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
.
repeated .google.cloud.dialogflow.v2.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
ContextOrBuilder |
getOutputContextsOrBuilderList()
public List<? extends ContextOrBuilder> getOutputContextsOrBuilderList()
Optional. The collection of contexts that are activated when the intent
is matched. Context messages in this collection should not set the
parameters field. Setting the lifespan_count
to 0 will reset the context
when the intent is matched.
Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>
.
repeated .google.cloud.dialogflow.v2.Context output_contexts = 11 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.dialogflow.v2.ContextOrBuilder> |
getParameters(int index)
public Intent.Parameter getParameters(int index)
Optional. The collection of parameters associated with the intent.
repeated .google.cloud.dialogflow.v2.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Intent.Parameter |
getParametersCount()
public int getParametersCount()
Optional. The collection of parameters associated with the intent.
repeated .google.cloud.dialogflow.v2.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
getParametersList()
public List<Intent.Parameter> getParametersList()
Optional. The collection of parameters associated with the intent.
repeated .google.cloud.dialogflow.v2.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<Parameter> |
getParametersOrBuilder(int index)
public Intent.ParameterOrBuilder getParametersOrBuilder(int index)
Optional. The collection of parameters associated with the intent.
repeated .google.cloud.dialogflow.v2.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Intent.ParameterOrBuilder |
getParametersOrBuilderList()
public List<? extends Intent.ParameterOrBuilder> getParametersOrBuilderList()
Optional. The collection of parameters associated with the intent.
repeated .google.cloud.dialogflow.v2.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.dialogflow.v2.Intent.ParameterOrBuilder> |
getParentFollowupIntentName()
public String getParentFollowupIntentName()
Read-only after creation. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent.
It identifies the parent followup intent.
Format: projects/<Project ID>/agent/intents/<Intent ID>
.
string parent_followup_intent_name = 17;
Returns | |
---|---|
Type | Description |
String |
The parentFollowupIntentName. |
getParentFollowupIntentNameBytes()
public ByteString getParentFollowupIntentNameBytes()
Read-only after creation. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent.
It identifies the parent followup intent.
Format: projects/<Project ID>/agent/intents/<Intent ID>
.
string parent_followup_intent_name = 17;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for parentFollowupIntentName. |
getParserForType()
public Parser<Intent> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<Intent> |
getPriority()
public int getPriority()
Optional. The priority of this intent. Higher numbers represent higher priorities.
- If the supplied value is unspecified or 0, the service
translates the value to 500,000, which corresponds to the
Normal
priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.
int32 priority = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
The priority. |
getResetContexts()
public boolean getResetContexts()
Optional. Indicates whether to delete all contexts in the current session when this intent is matched.
bool reset_contexts = 12 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
The resetContexts. |
getRootFollowupIntentName()
public String getRootFollowupIntentName()
Output only. Read-only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. We populate this field only in the output.
Format: projects/<Project ID>/agent/intents/<Intent ID>
.
string root_followup_intent_name = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String |
The rootFollowupIntentName. |
getRootFollowupIntentNameBytes()
public ByteString getRootFollowupIntentNameBytes()
Output only. Read-only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. We populate this field only in the output.
Format: projects/<Project ID>/agent/intents/<Intent ID>
.
string root_followup_intent_name = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for rootFollowupIntentName. |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getTrainingPhrases(int index)
public Intent.TrainingPhrase getTrainingPhrases(int index)
Optional. The collection of examples that the agent is trained on.
repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Intent.TrainingPhrase |
getTrainingPhrasesCount()
public int getTrainingPhrasesCount()
Optional. The collection of examples that the agent is trained on.
repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
getTrainingPhrasesList()
public List<Intent.TrainingPhrase> getTrainingPhrasesList()
Optional. The collection of examples that the agent is trained on.
repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<TrainingPhrase> |
getTrainingPhrasesOrBuilder(int index)
public Intent.TrainingPhraseOrBuilder getTrainingPhrasesOrBuilder(int index)
Optional. The collection of examples that the agent is trained on.
repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Intent.TrainingPhraseOrBuilder |
getTrainingPhrasesOrBuilderList()
public List<? extends Intent.TrainingPhraseOrBuilder> getTrainingPhrasesOrBuilderList()
Optional. The collection of examples that the agent is trained on.
repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.dialogflow.v2.Intent.TrainingPhraseOrBuilder> |
getWebhookState()
public Intent.WebhookState getWebhookState()
Optional. Indicates whether webhooks are enabled for the intent.
.google.cloud.dialogflow.v2.Intent.WebhookState webhook_state = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Intent.WebhookState |
The webhookState. |
getWebhookStateValue()
public int getWebhookStateValue()
Optional. Indicates whether webhooks are enabled for the intent.
.google.cloud.dialogflow.v2.Intent.WebhookState webhook_state = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for webhookState. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public Intent.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
Intent.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Intent.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
Intent.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public Intent.Builder toBuilder()
Returns | |
---|---|
Type | Description |
Intent.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |