com.google.cloud.dialogflow.v2.IntentOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dialogflow-v2 Show documentation
Show all versions of proto-google-cloud-dialogflow-v2 Show documentation
PROTO library for proto-google-cloud-dialogflow-v2
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dialogflow/v2/intent.proto
package com.google.cloud.dialogflow.v2;
public interface IntentOrBuilder extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2.Intent)
com.google.protobuf.MessageOrBuilder {
/**
*
* Required for all methods except `create` (`create` populates the name
* automatically.
* The unique identifier of this intent.
* Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*
*
* string name = 1;
*/
java.lang.String getName();
/**
*
* Required for all methods except `create` (`create` populates the name
* automatically.
* The unique identifier of this intent.
* Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*
*
* string name = 1;
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
* Required. The name of this intent.
*
*
* string display_name = 2;
*/
java.lang.String getDisplayName();
/**
*
* Required. The name of this intent.
*
*
* string display_name = 2;
*/
com.google.protobuf.ByteString
getDisplayNameBytes();
/**
*
* Required. Indicates whether webhooks are enabled for the intent.
*
*
* .google.cloud.dialogflow.v2.Intent.WebhookState webhook_state = 6;
*/
int getWebhookStateValue();
/**
*
* Required. Indicates whether webhooks are enabled for the intent.
*
*
* .google.cloud.dialogflow.v2.Intent.WebhookState webhook_state = 6;
*/
com.google.cloud.dialogflow.v2.Intent.WebhookState getWebhookState();
/**
*
* Optional. The priority of this intent. Higher numbers represent higher
* priorities. Zero or negative numbers mean that the intent is disabled.
*
*
* int32 priority = 3;
*/
int getPriority();
/**
*
* Optional. Indicates whether this is a fallback intent.
*
*
* bool is_fallback = 4;
*/
boolean getIsFallback();
/**
*
* Optional. Indicates whether Machine Learning is disabled for the intent.
* Note: If `ml_diabled` 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;
*/
boolean getMlDisabled();
/**
*
* 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;
*/
java.util.List
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;
*/
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;
*/
java.lang.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;
*/
com.google.protobuf.ByteString
getInputContextNamesBytes(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.
*
*
* repeated string events = 8;
*/
java.util.List
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.
*
*
* repeated string events = 8;
*/
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.
*
*
* repeated string events = 8;
*/
java.lang.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.
*
*
* repeated string events = 8;
*/
com.google.protobuf.ByteString
getEventsBytes(int index);
/**
*
* Optional. The collection of examples/templates that the agent is
* trained on.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9;
*/
java.util.List
getTrainingPhrasesList();
/**
*
* Optional. The collection of examples/templates that the agent is
* trained on.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9;
*/
com.google.cloud.dialogflow.v2.Intent.TrainingPhrase getTrainingPhrases(int index);
/**
*
* Optional. The collection of examples/templates that the agent is
* trained on.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9;
*/
int getTrainingPhrasesCount();
/**
*
* Optional. The collection of examples/templates that the agent is
* trained on.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9;
*/
java.util.List extends com.google.cloud.dialogflow.v2.Intent.TrainingPhraseOrBuilder>
getTrainingPhrasesOrBuilderList();
/**
*
* Optional. The collection of examples/templates that the agent is
* trained on.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.TrainingPhrase training_phrases = 9;
*/
com.google.cloud.dialogflow.v2.Intent.TrainingPhraseOrBuilder getTrainingPhrasesOrBuilder(
int index);
/**
*
* Optional. The name of the action associated with the intent.
*
*
* string action = 10;
*/
java.lang.String getAction();
/**
*
* Optional. The name of the action associated with the intent.
*
*
* string action = 10;
*/
com.google.protobuf.ByteString
getActionBytes();
/**
*
* 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;
*/
java.util.List
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;
*/
com.google.cloud.dialogflow.v2.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;
*/
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;
*/
java.util.List extends com.google.cloud.dialogflow.v2.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;
*/
com.google.cloud.dialogflow.v2.ContextOrBuilder getOutputContextsOrBuilder(
int index);
/**
*
* Optional. Indicates whether to delete all contexts in the current
* session when this intent is matched.
*
*
* bool reset_contexts = 12;
*/
boolean getResetContexts();
/**
*
* Optional. The collection of parameters associated with the intent.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Parameter parameters = 13;
*/
java.util.List
getParametersList();
/**
*
* Optional. The collection of parameters associated with the intent.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Parameter parameters = 13;
*/
com.google.cloud.dialogflow.v2.Intent.Parameter getParameters(int index);
/**
*
* Optional. The collection of parameters associated with the intent.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Parameter parameters = 13;
*/
int getParametersCount();
/**
*
* Optional. The collection of parameters associated with the intent.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Parameter parameters = 13;
*/
java.util.List extends com.google.cloud.dialogflow.v2.Intent.ParameterOrBuilder>
getParametersOrBuilderList();
/**
*
* Optional. The collection of parameters associated with the intent.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Parameter parameters = 13;
*/
com.google.cloud.dialogflow.v2.Intent.ParameterOrBuilder getParametersOrBuilder(
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;
*/
java.util.List
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;
*/
com.google.cloud.dialogflow.v2.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;
*/
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;
*/
java.util.List extends com.google.cloud.dialogflow.v2.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;
*/
com.google.cloud.dialogflow.v2.Intent.MessageOrBuilder getMessagesOrBuilder(
int index);
/**
*
* Optional. The list of platforms for which the first response will be
* taken from among the messages assigned to the DEFAULT_PLATFORM.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message.Platform default_response_platforms = 15;
*/
java.util.List getDefaultResponsePlatformsList();
/**
*
* Optional. The list of platforms for which the first response will be
* taken from among the messages assigned to the DEFAULT_PLATFORM.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message.Platform default_response_platforms = 15;
*/
int getDefaultResponsePlatformsCount();
/**
*
* Optional. The list of platforms for which the first response will be
* taken from among the messages assigned to the DEFAULT_PLATFORM.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message.Platform default_response_platforms = 15;
*/
com.google.cloud.dialogflow.v2.Intent.Message.Platform getDefaultResponsePlatforms(int index);
/**
*
* Optional. The list of platforms for which the first response will be
* taken from among the messages assigned to the DEFAULT_PLATFORM.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message.Platform default_response_platforms = 15;
*/
java.util.List
getDefaultResponsePlatformsValueList();
/**
*
* Optional. The list of platforms for which the first response will be
* taken from among the messages assigned to the DEFAULT_PLATFORM.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.Message.Platform default_response_platforms = 15;
*/
int getDefaultResponsePlatformsValue(int index);
/**
*
* The unique identifier of the root intent in the chain of followup intents.
* It identifies the correct followup intents chain for this intent.
* Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*
*
* string root_followup_intent_name = 16;
*/
java.lang.String getRootFollowupIntentName();
/**
*
* The unique identifier of the root intent in the chain of followup intents.
* It identifies the correct followup intents chain for this intent.
* Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*
*
* string root_followup_intent_name = 16;
*/
com.google.protobuf.ByteString
getRootFollowupIntentNameBytes();
/**
*
* The unique identifier of the parent intent in the chain of followup
* intents.
* It identifies the parent followup intent.
* Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*
*
* string parent_followup_intent_name = 17;
*/
java.lang.String getParentFollowupIntentName();
/**
*
* The unique identifier of the parent intent in the chain of followup
* intents.
* It identifies the parent followup intent.
* Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
*
*
* string parent_followup_intent_name = 17;
*/
com.google.protobuf.ByteString
getParentFollowupIntentNameBytes();
/**
*
* Optional. Collection of information about all followup intents that have
* name of this intent as a root_name.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.FollowupIntentInfo followup_intent_info = 18;
*/
java.util.List
getFollowupIntentInfoList();
/**
*
* Optional. Collection of information about all followup intents that have
* name of this intent as a root_name.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.FollowupIntentInfo followup_intent_info = 18;
*/
com.google.cloud.dialogflow.v2.Intent.FollowupIntentInfo getFollowupIntentInfo(int index);
/**
*
* Optional. Collection of information about all followup intents that have
* name of this intent as a root_name.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.FollowupIntentInfo followup_intent_info = 18;
*/
int getFollowupIntentInfoCount();
/**
*
* Optional. Collection of information about all followup intents that have
* name of this intent as a root_name.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.FollowupIntentInfo followup_intent_info = 18;
*/
java.util.List extends com.google.cloud.dialogflow.v2.Intent.FollowupIntentInfoOrBuilder>
getFollowupIntentInfoOrBuilderList();
/**
*
* Optional. Collection of information about all followup intents that have
* name of this intent as a root_name.
*
*
* repeated .google.cloud.dialogflow.v2.Intent.FollowupIntentInfo followup_intent_info = 18;
*/
com.google.cloud.dialogflow.v2.Intent.FollowupIntentInfoOrBuilder getFollowupIntentInfoOrBuilder(
int index);
}