Class Intent.TrainingPhrase.Builder (0.62.0)

public static final class Intent.TrainingPhrase.Builder extends GeneratedMessageV3.Builder<Intent.TrainingPhrase.Builder> implements Intent.TrainingPhraseOrBuilder

Represents an example that the agent is trained on to identify the intent.

Protobuf type google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllParts(Iterable<? extends Intent.TrainingPhrase.Part> values)

public Intent.TrainingPhrase.Builder addAllParts(Iterable<? extends Intent.TrainingPhrase.Part> values)

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 parameter_id field is set.

repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part parts = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part>
Returns
Type Description
Intent.TrainingPhrase.Builder

addParts(Intent.TrainingPhrase.Part value)

public Intent.TrainingPhrase.Builder addParts(Intent.TrainingPhrase.Part value)

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 parameter_id field is set.

repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part parts = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Intent.TrainingPhrase.Part
Returns
Type Description
Intent.TrainingPhrase.Builder

addParts(Intent.TrainingPhrase.Part.Builder builderForValue)

public Intent.TrainingPhrase.Builder addParts(Intent.TrainingPhrase.Part.Builder builderForValue)

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 parameter_id field is set.

repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part parts = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Intent.TrainingPhrase.Part.Builder
Returns
Type Description
Intent.TrainingPhrase.Builder

addParts(int index, Intent.TrainingPhrase.Part value)

public Intent.TrainingPhrase.Builder addParts(int index, Intent.TrainingPhrase.Part value)

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 parameter_id field is set.

repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part parts = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value Intent.TrainingPhrase.Part
Returns
Type Description
Intent.TrainingPhrase.Builder

addParts(int index, Intent.TrainingPhrase.Part.Builder builderForValue)

public Intent.TrainingPhrase.Builder addParts(int index, Intent.TrainingPhrase.Part.Builder builderForValue)

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 parameter_id field is set.

repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part parts = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue Intent.TrainingPhrase.Part.Builder
Returns
Type Description
Intent.TrainingPhrase.Builder

addPartsBuilder()

public Intent.TrainingPhrase.Part.Builder addPartsBuilder()

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 parameter_id field is set.

repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part parts = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Intent.TrainingPhrase.Part.Builder

addPartsBuilder(int index)

public Intent.TrainingPhrase.Part.Builder addPartsBuilder(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 parameter_id field is set.

repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part parts = 2 [(.google.api.field_behavior) = REQUIRED];

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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Intent.TrainingPhrase.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Intent.TrainingPhrase.Builder
Overrides

build()

public Intent.TrainingPhrase build()
Returns
Type Description
Intent.TrainingPhrase

buildPartial()

public Intent.TrainingPhrase buildPartial()
Returns
Type Description
Intent.TrainingPhrase

clear()

public Intent.TrainingPhrase.Builder clear()
Returns
Type Description
Intent.TrainingPhrase.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Intent.TrainingPhrase.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Intent.TrainingPhrase.Builder
Overrides

clearId()

public Intent.TrainingPhrase.Builder clearId()

Output only. The unique identifier of the training phrase.

string id = 1;

Returns
Type Description
Intent.TrainingPhrase.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Intent.TrainingPhrase.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Intent.TrainingPhrase.Builder
Overrides

clearParts()

public Intent.TrainingPhrase.Builder clearParts()

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 parameter_id field is set.

repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part parts = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Intent.TrainingPhrase.Builder

clearRepeatCount()

public Intent.TrainingPhrase.Builder clearRepeatCount()

Indicates how many times this example was added to the intent.

int32 repeat_count = 3;

Returns
Type Description
Intent.TrainingPhrase.Builder

This builder for chaining.

clone()

public Intent.TrainingPhrase.Builder clone()
Returns
Type Description
Intent.TrainingPhrase.Builder
Overrides

getDefaultInstanceForType()

public Intent.TrainingPhrase getDefaultInstanceForType()
Returns
Type Description
Intent.TrainingPhrase

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getId()

public String getId()

Output only. The unique identifier of the training phrase.

string id = 1;

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

Output only. The unique identifier of the training phrase.

string id = 1;

Returns
Type Description
ByteString

The bytes for id.

getParts(int index)

public 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 parameter_id field is set.

repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part parts = 2 [(.google.api.field_behavior) = REQUIRED];

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

getPartsBuilder(int index)

public Intent.TrainingPhrase.Part.Builder getPartsBuilder(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 parameter_id field is set.

repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part parts = 2 [(.google.api.field_behavior) = REQUIRED];

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

getPartsBuilderList()

public List<Intent.TrainingPhrase.Part.Builder> getPartsBuilderList()

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 parameter_id field is set.

repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part parts = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Builder>

getPartsCount()

public 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 parameter_id field is set.

repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part parts = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getPartsList()

public 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 parameter_id field is set.

repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part parts = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Part>

getPartsOrBuilder(int index)

public 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 parameter_id field is set.

repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part parts = 2 [(.google.api.field_behavior) = REQUIRED];

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

getPartsOrBuilderList()

public 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 parameter_id field is set.

repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part parts = 2 [(.google.api.field_behavior) = REQUIRED];

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

getRepeatCount()

public int getRepeatCount()

Indicates how many times this example was added to the intent.

int32 repeat_count = 3;

Returns
Type Description
int

The repeatCount.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Intent.TrainingPhrase other)

public Intent.TrainingPhrase.Builder mergeFrom(Intent.TrainingPhrase other)
Parameter
Name Description
other Intent.TrainingPhrase
Returns
Type Description
Intent.TrainingPhrase.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Intent.TrainingPhrase.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Intent.TrainingPhrase.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Intent.TrainingPhrase.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Intent.TrainingPhrase.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Intent.TrainingPhrase.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Intent.TrainingPhrase.Builder
Overrides

removeParts(int index)

public Intent.TrainingPhrase.Builder removeParts(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 parameter_id field is set.

repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part parts = 2 [(.google.api.field_behavior) = REQUIRED];

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

setField(Descriptors.FieldDescriptor field, Object value)

public Intent.TrainingPhrase.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Intent.TrainingPhrase.Builder
Overrides

setId(String value)

public Intent.TrainingPhrase.Builder setId(String value)

Output only. The unique identifier of the training phrase.

string id = 1;

Parameter
Name Description
value String

The id to set.

Returns
Type Description
Intent.TrainingPhrase.Builder

This builder for chaining.

setIdBytes(ByteString value)

public Intent.TrainingPhrase.Builder setIdBytes(ByteString value)

Output only. The unique identifier of the training phrase.

string id = 1;

Parameter
Name Description
value ByteString

The bytes for id to set.

Returns
Type Description
Intent.TrainingPhrase.Builder

This builder for chaining.

setParts(int index, Intent.TrainingPhrase.Part value)

public Intent.TrainingPhrase.Builder setParts(int index, Intent.TrainingPhrase.Part value)

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 parameter_id field is set.

repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part parts = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value Intent.TrainingPhrase.Part
Returns
Type Description
Intent.TrainingPhrase.Builder

setParts(int index, Intent.TrainingPhrase.Part.Builder builderForValue)

public Intent.TrainingPhrase.Builder setParts(int index, Intent.TrainingPhrase.Part.Builder builderForValue)

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 parameter_id field is set.

repeated .google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part parts = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue Intent.TrainingPhrase.Part.Builder
Returns
Type Description
Intent.TrainingPhrase.Builder

setRepeatCount(int value)

public Intent.TrainingPhrase.Builder setRepeatCount(int value)

Indicates how many times this example was added to the intent.

int32 repeat_count = 3;

Parameter
Name Description
value int

The repeatCount to set.

Returns
Type Description
Intent.TrainingPhrase.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Intent.TrainingPhrase.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Intent.TrainingPhrase.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Intent.TrainingPhrase.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Intent.TrainingPhrase.Builder
Overrides