Interface Intent.TrainingPhraseOrBuilder (4.52.0)

public static interface Intent.TrainingPhraseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getName()

public abstract String getName()

Output only. The unique identifier of this training phrase.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. The unique identifier of this training phrase.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParts(int index)

public abstract Intent.TrainingPhrase.Part getParts(int index)

Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase.

Note: The API does not automatically annotate training phrases like the Dialogflow Console does.

Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated.

If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set.

If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways:

  • Part.text is set to a part of the phrase that has no parameters.
  • Part.text is set to a part of the phrase that you want to annotate, and the entity_type, alias, and user_defined fields are all set.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase.Part parts = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Intent.TrainingPhrase.Part

getPartsCount()

public abstract int getPartsCount()

Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase.

Note: The API does not automatically annotate training phrases like the Dialogflow Console does.

Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated.

If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set.

If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways:

  • Part.text is set to a part of the phrase that has no parameters.
  • Part.text is set to a part of the phrase that you want to annotate, and the entity_type, alias, and user_defined fields are all set.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase.Part parts = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getPartsList()

public abstract List<Intent.TrainingPhrase.Part> getPartsList()

Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase.

Note: The API does not automatically annotate training phrases like the Dialogflow Console does.

Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated.

If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set.

If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways:

  • Part.text is set to a part of the phrase that has no parameters.
  • Part.text is set to a part of the phrase that you want to annotate, and the entity_type, alias, and user_defined fields are all set.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase.Part parts = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Part>

getPartsOrBuilder(int index)

public abstract Intent.TrainingPhrase.PartOrBuilder getPartsOrBuilder(int index)

Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase.

Note: The API does not automatically annotate training phrases like the Dialogflow Console does.

Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated.

If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set.

If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways:

  • Part.text is set to a part of the phrase that has no parameters.
  • Part.text is set to a part of the phrase that you want to annotate, and the entity_type, alias, and user_defined fields are all set.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase.Part parts = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Intent.TrainingPhrase.PartOrBuilder

getPartsOrBuilderList()

public abstract List<? extends Intent.TrainingPhrase.PartOrBuilder> getPartsOrBuilderList()

Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase.

Note: The API does not automatically annotate training phrases like the Dialogflow Console does.

Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated.

If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set.

If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways:

  • Part.text is set to a part of the phrase that has no parameters.
  • Part.text is set to a part of the phrase that you want to annotate, and the entity_type, alias, and user_defined fields are all set.

repeated .google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase.Part parts = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase.PartOrBuilder>

getTimesAddedCount()

public abstract int getTimesAddedCount()

Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.

int32 times_added_count = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The timesAddedCount.

getType()

public abstract Intent.TrainingPhrase.Type getType()

Required. The type of the training phrase.

.google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase.Type type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Intent.TrainingPhrase.Type

The type.

getTypeValue()

public abstract int getTypeValue()

Required. The type of the training phrase.

.google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase.Type type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for type.