Interface IntentOrBuilder (0.47.0)

public interface IntentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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;

Parameter
Name Description
key String
Returns
Type Description
boolean

getDescription()

public abstract 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
Type Description
String

The description.

getDescriptionBytes()

public abstract 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
Type Description
ByteString

The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Required. The human-readable name of the intent, unique within the agent.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. The human-readable name of the intent, unique within the agent.

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

Returns
Type Description
ByteString

The bytes for displayName.

getIsFallback()

public abstract 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
Type Description
boolean

The isFallback.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract 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;

Returns
Type Description
int

getLabelsMap()

public abstract 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;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract 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;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract 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;

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public abstract String getName()

The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParameters(int index)

public abstract Intent.Parameter getParameters(int index)

The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.cx.v3beta1.Intent.Parameter parameters = 4;

Parameter
Name Description
index int
Returns
Type Description
Intent.Parameter

getParametersCount()

public abstract int getParametersCount()

The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.cx.v3beta1.Intent.Parameter parameters = 4;

Returns
Type Description
int

getParametersList()

public abstract List<Intent.Parameter> getParametersList()

The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.cx.v3beta1.Intent.Parameter parameters = 4;

Returns
Type Description
List<Parameter>

getParametersOrBuilder(int index)

public abstract Intent.ParameterOrBuilder getParametersOrBuilder(int index)

The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.cx.v3beta1.Intent.Parameter parameters = 4;

Parameter
Name Description
index int
Returns
Type Description
Intent.ParameterOrBuilder

getParametersOrBuilderList()

public abstract List<? extends Intent.ParameterOrBuilder> getParametersOrBuilderList()

The collection of parameters associated with the intent.

repeated .google.cloud.dialogflow.cx.v3beta1.Intent.Parameter parameters = 4;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.Intent.ParameterOrBuilder>

getPriority()

public abstract 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
Type Description
int

The priority.

getTrainingPhrases(int index)

public abstract Intent.TrainingPhrase getTrainingPhrases(int index)

The collection of training phrases the agent is trained on to identify the intent.

repeated .google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhrase training_phrases = 3;

Parameter
Name Description
index int
Returns
Type Description
Intent.TrainingPhrase

getTrainingPhrasesCount()

public abstract int getTrainingPhrasesCount()

The collection of training phrases the agent is trained on to identify the intent.

repeated .google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhrase training_phrases = 3;

Returns
Type Description
int

getTrainingPhrasesList()

public abstract List<Intent.TrainingPhrase> getTrainingPhrasesList()

The collection of training phrases the agent is trained on to identify the intent.

repeated .google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhrase training_phrases = 3;

Returns
Type Description
List<TrainingPhrase>

getTrainingPhrasesOrBuilder(int index)

public abstract Intent.TrainingPhraseOrBuilder getTrainingPhrasesOrBuilder(int index)

The collection of training phrases the agent is trained on to identify the intent.

repeated .google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhrase training_phrases = 3;

Parameter
Name Description
index int
Returns
Type Description
Intent.TrainingPhraseOrBuilder

getTrainingPhrasesOrBuilderList()

public abstract List<? extends Intent.TrainingPhraseOrBuilder> getTrainingPhrasesOrBuilderList()

The collection of training phrases the agent is trained on to identify the intent.

repeated .google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhrase training_phrases = 3;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhraseOrBuilder>