Package com.google.cloud.dialogflow.cx.v3

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()
         The unique identifier of the intent.
 Required for the
 [Intents.UpdateIntent][google.cloud.dialogflow.cx.v3.Intents.UpdateIntent]
 method.
 [Intents.CreateIntent][google.cloud.dialogflow.cx.v3.Intents.CreateIntent]
 populates the name automatically.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/intents/<Intent ID>`.
        string name = 1;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         The unique identifier of the intent.
 Required for the
 [Intents.UpdateIntent][google.cloud.dialogflow.cx.v3.Intents.UpdateIntent]
 method.
 [Intents.CreateIntent][google.cloud.dialogflow.cx.v3.Intents.CreateIntent]
 populates the name automatically.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/intents/<Intent ID>`.
        string name = 1;
        Returns:
        The bytes for name.

      • getDisplayName

        String getDisplayName()
         Required. The human-readable name of the intent, unique within the agent.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.ByteString getDisplayNameBytes()
         Required. The human-readable name of the intent, unique within the agent.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for displayName.

      • getTrainingPhrasesList

        List<Intent.TrainingPhrase> getTrainingPhrasesList()
         The collection of training phrases the agent is trained on to identify the
 intent.
        repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase training_phrases = 3;

      • getTrainingPhrases

        Intent.TrainingPhrase getTrainingPhrases​(int index)
         The collection of training phrases the agent is trained on to identify the
 intent.
        repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase training_phrases = 3;

      • getTrainingPhrasesCount

        int getTrainingPhrasesCount()
         The collection of training phrases the agent is trained on to identify the
 intent.
        repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase training_phrases = 3;

      • getTrainingPhrasesOrBuilderList

        List<? extends Intent.TrainingPhraseOrBuilder> getTrainingPhrasesOrBuilderList()
         The collection of training phrases the agent is trained on to identify the
 intent.
        repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase training_phrases = 3;

      • getTrainingPhrasesOrBuilder

        Intent.TrainingPhraseOrBuilder getTrainingPhrasesOrBuilder​(int index)
         The collection of training phrases the agent is trained on to identify the
 intent.
        repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase training_phrases = 3;

      • getParametersList

        List<Intent.Parameter> getParametersList()
         The collection of parameters associated with the intent.
        repeated .google.cloud.dialogflow.cx.v3.Intent.Parameter parameters = 4;

      • getParameters

        Intent.Parameter getParameters​(int index)
         The collection of parameters associated with the intent.
        repeated .google.cloud.dialogflow.cx.v3.Intent.Parameter parameters = 4;

      • getParametersCount

        int getParametersCount()
         The collection of parameters associated with the intent.
        repeated .google.cloud.dialogflow.cx.v3.Intent.Parameter parameters = 4;

      • getParametersOrBuilderList

        List<? extends Intent.ParameterOrBuilder> getParametersOrBuilderList()
         The collection of parameters associated with the intent.
        repeated .google.cloud.dialogflow.cx.v3.Intent.Parameter parameters = 4;

      • getParametersOrBuilder

        Intent.ParameterOrBuilder getParametersOrBuilder​(int index)
         The collection of parameters associated with the intent.
        repeated .google.cloud.dialogflow.cx.v3.Intent.Parameter parameters = 4;

      • getPriority

        int getPriority()
         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 = 5;
        Returns:
        The priority.

      • getIsFallback

        boolean getIsFallback()
         Indicates whether this is a fallback intent. Currently only default
 fallback intent is allowed in the agent, which is added upon agent
 creation.
 Adding training phrases to fallback intent is useful in the case of
 requests that are mistakenly matched, since training phrases assigned to
 fallback intents act as negative examples that triggers no-match event.
        bool is_fallback = 6;
        Returns:
        The isFallback.

      • getLabelsCount

        int getLabelsCount()
         The key/value metadata to label an intent. Labels can contain
 lowercase letters, digits and the symbols '-' and '_'. International
 characters are allowed, including letters from unicase alphabets. Keys must
 start with a letter. Keys and values can be no longer than 63 characters
 and no more than 128 bytes.

 Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed
 Dialogflow defined labels include:
 * sys-head
 * sys-contextual
 The above labels do not require value. "sys-head" means the intent is a
 head intent. "sys.contextual" means the intent is a contextual intent.
        map<string, string> labels = 7;

      • containsLabels

        boolean containsLabels​(String key)
         The key/value metadata to label an intent. Labels can contain
 lowercase letters, digits and the symbols '-' and '_'. International
 characters are allowed, including letters from unicase alphabets. Keys must
 start with a letter. Keys and values can be no longer than 63 characters
 and no more than 128 bytes.

 Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed
 Dialogflow defined labels include:
 * sys-head
 * sys-contextual
 The above labels do not require value. "sys-head" means the intent is a
 head intent. "sys.contextual" means the intent is a contextual intent.
        map<string, string> labels = 7;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         The key/value metadata to label an intent. Labels can contain
 lowercase letters, digits and the symbols '-' and '_'. International
 characters are allowed, including letters from unicase alphabets. Keys must
 start with a letter. Keys and values can be no longer than 63 characters
 and no more than 128 bytes.

 Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed
 Dialogflow defined labels include:
 * sys-head
 * sys-contextual
 The above labels do not require value. "sys-head" means the intent is a
 head intent. "sys.contextual" means the intent is a contextual intent.
        map<string, string> labels = 7;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         The key/value metadata to label an intent. Labels can contain
 lowercase letters, digits and the symbols '-' and '_'. International
 characters are allowed, including letters from unicase alphabets. Keys must
 start with a letter. Keys and values can be no longer than 63 characters
 and no more than 128 bytes.

 Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed
 Dialogflow defined labels include:
 * sys-head
 * sys-contextual
 The above labels do not require value. "sys-head" means the intent is a
 head intent. "sys.contextual" means the intent is a contextual intent.
        map<string, string> labels = 7;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         The key/value metadata to label an intent. Labels can contain
 lowercase letters, digits and the symbols '-' and '_'. International
 characters are allowed, including letters from unicase alphabets. Keys must
 start with a letter. Keys and values can be no longer than 63 characters
 and no more than 128 bytes.

 Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed
 Dialogflow defined labels include:
 * sys-head
 * sys-contextual
 The above labels do not require value. "sys-head" means the intent is a
 head intent. "sys.contextual" means the intent is a contextual intent.
        map<string, string> labels = 7;

      • getDescription

        String getDescription()
         Human readable description for better understanding an intent like its
 scope, content, result etc. Maximum character limit: 140 characters.
        string description = 8;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         Human readable description for better understanding an intent like its
 scope, content, result etc. Maximum character limit: 140 characters.
        string description = 8;
        Returns:
        The bytes for description.