Class Intent.TrainingPhrase (4.46.0)

public static final class Intent.TrainingPhrase extends GeneratedMessageV3 implements Intent.TrainingPhraseOrBuilder

Represents an example that the agent is trained on.

Protobuf type google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PARTS_FIELD_NUMBER

public static final int PARTS_FIELD_NUMBER
Field Value
Type Description
int

TIMES_ADDED_COUNT_FIELD_NUMBER

public static final int TIMES_ADDED_COUNT_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Intent.TrainingPhrase getDefaultInstance()
Returns
Type Description
Intent.TrainingPhrase

getDescriptor()

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

newBuilder()

public static Intent.TrainingPhrase.Builder newBuilder()
Returns
Type Description
Intent.TrainingPhrase.Builder

newBuilder(Intent.TrainingPhrase prototype)

public static Intent.TrainingPhrase.Builder newBuilder(Intent.TrainingPhrase prototype)
Parameter
Name Description
prototype Intent.TrainingPhrase
Returns
Type Description
Intent.TrainingPhrase.Builder

parseDelimitedFrom(InputStream input)

public static Intent.TrainingPhrase parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Intent.TrainingPhrase
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Intent.TrainingPhrase parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Intent.TrainingPhrase
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Intent.TrainingPhrase parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Intent.TrainingPhrase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Intent.TrainingPhrase parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Intent.TrainingPhrase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Intent.TrainingPhrase parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Intent.TrainingPhrase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Intent.TrainingPhrase parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Intent.TrainingPhrase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Intent.TrainingPhrase parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Intent.TrainingPhrase
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Intent.TrainingPhrase parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Intent.TrainingPhrase
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Intent.TrainingPhrase parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Intent.TrainingPhrase
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Intent.TrainingPhrase parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Intent.TrainingPhrase
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Intent.TrainingPhrase parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Intent.TrainingPhrase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Intent.TrainingPhrase parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Intent.TrainingPhrase
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Intent.TrainingPhrase> parser()
Returns
Type Description
Parser<TrainingPhrase>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

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

getName()

public String getName()

Output only. The unique identifier of this training phrase.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The unique identifier of this training phrase.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Intent.TrainingPhrase> getParserForType()
Returns
Type Description
Parser<TrainingPhrase>
Overrides

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 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 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 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 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 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>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTimesAddedCount()

public 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Intent.TrainingPhrase.Builder newBuilderForType()
Returns
Type Description
Intent.TrainingPhrase.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Intent.TrainingPhrase.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Intent.TrainingPhrase.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Intent.TrainingPhrase.Builder toBuilder()
Returns
Type Description
Intent.TrainingPhrase.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException