Package com.google.cloud.dialogflow.v2beta1

Interface IntentOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Intent, Intent.Builder
    public interface IntentOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Optional. The unique identifier of this intent.
 Required for
 [Intents.UpdateIntent][google.cloud.dialogflow.v2beta1.Intents.UpdateIntent]
 and
 [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2beta1.Intents.BatchUpdateIntents]
 methods.
 Supported formats:

 - `projects/<Project ID>/agent/intents/<Intent ID>`
 - `projects/<Project ID>/locations/<Location ID>/agent/intents/<Intent ID>`
        string name = 1 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Optional. The unique identifier of this intent.
 Required for
 [Intents.UpdateIntent][google.cloud.dialogflow.v2beta1.Intents.UpdateIntent]
 and
 [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2beta1.Intents.BatchUpdateIntents]
 methods.
 Supported formats:

 - `projects/<Project ID>/agent/intents/<Intent ID>`
 - `projects/<Project ID>/locations/<Location ID>/agent/intents/<Intent ID>`
        string name = 1 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for name.

      • getDisplayName

        String getDisplayName()
         Required. The name of this intent.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.ByteString getDisplayNameBytes()
         Required. The name of this intent.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for displayName.

      • getWebhookStateValue

        int getWebhookStateValue()
         Optional. Indicates whether webhooks are enabled for the intent.
        .google.cloud.dialogflow.v2beta1.Intent.WebhookState webhook_state = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enum numeric value on the wire for webhookState.

      • getWebhookState

        Intent.WebhookState getWebhookState()
         Optional. Indicates whether webhooks are enabled for the intent.
        .google.cloud.dialogflow.v2beta1.Intent.WebhookState webhook_state = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The webhookState.

      • getPriority

        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:
        The priority.

      • getIsFallback

        boolean getIsFallback()
         Optional. Indicates whether this is a fallback intent.
        bool is_fallback = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The isFallback.

      • getMlEnabled

        @Deprecated
boolean getMlEnabled()
        Deprecated.
        google.cloud.dialogflow.v2beta1.Intent.ml_enabled is deprecated. See google/cloud/dialogflow/v2beta1/intent.proto;l=1154
         Optional. Indicates whether Machine Learning is enabled for the intent.
 Note: If `ml_enabled` setting is set to false, then this intent is not
 taken into account during inference in `ML ONLY` match mode. Also,
 auto-markup in the UI is turned off.
 DEPRECATED! Please use `ml_disabled` field instead.
 NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false,
 then the default value is determined as follows:

 - Before April 15th, 2018 the default is:
   ml_enabled = false / ml_disabled = true.
 - After April 15th, 2018 the default is:
   ml_enabled = true / ml_disabled = false.
        bool ml_enabled = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
        Returns:
        The mlEnabled.

      • getMlDisabled

        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:
        The mlDisabled.

      • getLiveAgentHandoff

        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:
        The liveAgentHandoff.

      • getEndInteraction

        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:
        The endInteraction.

      • getInputContextNamesList

        List<String> getInputContextNamesList()
         Optional. The list of context names required for this intent to be
 triggered.
 Formats:

 - `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`
 - `projects/<Project ID>/locations/<Location
   ID>/agent/sessions/-/contexts/<Context ID>`
        repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        A list containing the inputContextNames.

      • getInputContextNamesCount

        int getInputContextNamesCount()
         Optional. The list of context names required for this intent to be
 triggered.
 Formats:

 - `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`
 - `projects/<Project ID>/locations/<Location
   ID>/agent/sessions/-/contexts/<Context ID>`
        repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The count of inputContextNames.

      • getInputContextNames

        String getInputContextNames​(int index)
         Optional. The list of context names required for this intent to be
 triggered.
 Formats:

 - `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`
 - `projects/<Project ID>/locations/<Location
   ID>/agent/sessions/-/contexts/<Context ID>`
        repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the element to return.
        Returns:
        The inputContextNames at the given index.

      • getInputContextNamesBytes

        com.google.protobuf.ByteString getInputContextNamesBytes​(int index)
         Optional. The list of context names required for this intent to be
 triggered.
 Formats:

 - `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`
 - `projects/<Project ID>/locations/<Location
   ID>/agent/sessions/-/contexts/<Context ID>`
        repeated string input_context_names = 7 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the inputContextNames at the given index.

      • getEventsList

        List<String> 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:
        A list containing the events.

      • getEventsCount

        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:
        The count of events.

      • getEvents

        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];
        Parameters:
        index - The index of the element to return.
        Returns:
        The events at the given index.

      • getEventsBytes

        com.google.protobuf.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];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the events at the given index.

      • getTrainingPhrasesList

        List<Intent.TrainingPhrase> getTrainingPhrasesList()
         Optional. The collection of examples that the agent is
 trained on.
        repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

      • getTrainingPhrases

        Intent.TrainingPhrase getTrainingPhrases​(int index)
         Optional. The collection of examples that the agent is
 trained on.
        repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

      • getTrainingPhrasesCount

        int getTrainingPhrasesCount()
         Optional. The collection of examples that the agent is
 trained on.
        repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

      • getTrainingPhrasesOrBuilderList

        List<? extends Intent.TrainingPhraseOrBuilder> getTrainingPhrasesOrBuilderList()
         Optional. The collection of examples that the agent is
 trained on.
        repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

      • getTrainingPhrasesOrBuilder

        Intent.TrainingPhraseOrBuilder getTrainingPhrasesOrBuilder​(int index)
         Optional. The collection of examples that the agent is
 trained on.
        repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase training_phrases = 9 [(.google.api.field_behavior) = OPTIONAL];

      • getAction

        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:
        The action.

      • getActionBytes

        com.google.protobuf.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:
        The bytes for action.

      • getOutputContextsList

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

      • getOutputContexts

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

      • getOutputContextsCount

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

      • getOutputContextsOrBuilderList

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

      • getOutputContextsOrBuilder

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

      • getResetContexts

        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:
        The resetContexts.

      • getParametersList

        List<Intent.Parameter> getParametersList()
         Optional. The collection of parameters associated with the intent.
        repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

      • getParameters

        Intent.Parameter getParameters​(int index)
         Optional. The collection of parameters associated with the intent.
        repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

      • getParametersCount

        int getParametersCount()
         Optional. The collection of parameters associated with the intent.
        repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

      • getParametersOrBuilderList

        List<? extends Intent.ParameterOrBuilder> getParametersOrBuilderList()
         Optional. The collection of parameters associated with the intent.
        repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

      • getParametersOrBuilder

        Intent.ParameterOrBuilder getParametersOrBuilder​(int index)
         Optional. The collection of parameters associated with the intent.
        repeated .google.cloud.dialogflow.v2beta1.Intent.Parameter parameters = 13 [(.google.api.field_behavior) = OPTIONAL];

      • getMessagesList

        List<Intent.Message> getMessagesList()
         Optional. The collection of rich messages corresponding to the
 `Response` field in the Dialogflow console.
        repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

      • getMessages

        Intent.Message getMessages​(int index)
         Optional. The collection of rich messages corresponding to the
 `Response` field in the Dialogflow console.
        repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

      • getMessagesCount

        int getMessagesCount()
         Optional. The collection of rich messages corresponding to the
 `Response` field in the Dialogflow console.
        repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

      • getMessagesOrBuilderList

        List<? extends Intent.MessageOrBuilder> getMessagesOrBuilderList()
         Optional. The collection of rich messages corresponding to the
 `Response` field in the Dialogflow console.
        repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

      • getMessagesOrBuilder

        Intent.MessageOrBuilder getMessagesOrBuilder​(int index)
         Optional. The collection of rich messages corresponding to the
 `Response` field in the Dialogflow console.
        repeated .google.cloud.dialogflow.v2beta1.Intent.Message messages = 14;

      • getDefaultResponsePlatformsList

        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.v2beta1.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        A list containing the defaultResponsePlatforms.

      • getDefaultResponsePlatformsCount

        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.v2beta1.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The count of defaultResponsePlatforms.

      • getDefaultResponsePlatforms

        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.v2beta1.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the element to return.
        Returns:
        The defaultResponsePlatforms at the given index.

      • getDefaultResponsePlatformsValueList

        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.v2beta1.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        A list containing the enum numeric values on the wire for defaultResponsePlatforms.

      • getDefaultResponsePlatformsValue

        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.v2beta1.Intent.Message.Platform default_response_platforms = 15 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of defaultResponsePlatforms at the given index.

      • getRootFollowupIntentName

        String getRootFollowupIntentName()
         Output only. 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 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The rootFollowupIntentName.

      • getRootFollowupIntentNameBytes

        com.google.protobuf.ByteString getRootFollowupIntentNameBytes()
         Output only. 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 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for rootFollowupIntentName.

      • getParentFollowupIntentName

        String getParentFollowupIntentName()
         Optional. 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][google.cloud.dialogflow.v2beta1.Intents.CreateIntent] or
 [BatchUpdateIntents][google.cloud.dialogflow.v2beta1.Intents.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 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The parentFollowupIntentName.

      • getParentFollowupIntentNameBytes

        com.google.protobuf.ByteString getParentFollowupIntentNameBytes()
         Optional. 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][google.cloud.dialogflow.v2beta1.Intents.CreateIntent] or
 [BatchUpdateIntents][google.cloud.dialogflow.v2beta1.Intents.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 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for parentFollowupIntentName.

      • getFollowupIntentInfoList

        List<Intent.FollowupIntentInfo> getFollowupIntentInfoList()
         Output 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.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getFollowupIntentInfo

        Intent.FollowupIntentInfo getFollowupIntentInfo​(int index)
         Output 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.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getFollowupIntentInfoCount

        int getFollowupIntentInfoCount()
         Output 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.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getFollowupIntentInfoOrBuilderList

        List<? extends Intent.FollowupIntentInfoOrBuilder> getFollowupIntentInfoOrBuilderList()
         Output 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.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getFollowupIntentInfoOrBuilder

        Intent.FollowupIntentInfoOrBuilder getFollowupIntentInfoOrBuilder​(int index)
         Output 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.v2beta1.Intent.FollowupIntentInfo followup_intent_info = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];