Class Intent.TrainingPhrase (4.4.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.v2.Intent.TrainingPhrase

Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PARTS_FIELD_NUMBER

public static final int PARTS_FIELD_NUMBER
Field Value
TypeDescription
int

TIMES_ADDED_COUNT_FIELD_NUMBER

public static final int TIMES_ADDED_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstance()

public static Intent.TrainingPhrase getDefaultInstance()
Returns
TypeDescription
Intent.TrainingPhrase

getDefaultInstanceForType()

public Intent.TrainingPhrase getDefaultInstanceForType()
Returns
TypeDescription
Intent.TrainingPhrase

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getName()

public String getName()

Output only. The unique identifier of this training phrase.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The unique identifier of this training phrase.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Intent.TrainingPhrase> getParserForType()
Returns
TypeDescription
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.v2.Intent.TrainingPhrase.Part parts = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v2.Intent.TrainingPhrase.Part parts = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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.v2.Intent.TrainingPhrase.Part parts = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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.v2.Intent.TrainingPhrase.Part parts = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v2.Intent.TrainingPhrase.Part parts = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<? extends com.google.cloud.dialogflow.v2.Intent.TrainingPhrase.PartOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
int

The timesAddedCount.

getType()

public Intent.TrainingPhrase.Type getType()

Required. The type of the training phrase.

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

Returns
TypeDescription
Intent.TrainingPhrase.Type

The type.

getTypeValue()

public int getTypeValue()

Required. The type of the training phrase.

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

Returns
TypeDescription
int

The enum numeric value on the wire for type.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static Intent.TrainingPhrase.Builder newBuilder()
Returns
TypeDescription
Intent.TrainingPhrase.Builder

newBuilder(Intent.TrainingPhrase prototype)

public static Intent.TrainingPhrase.Builder newBuilder(Intent.TrainingPhrase prototype)
Parameter
NameDescription
prototypeIntent.TrainingPhrase
Returns
TypeDescription
Intent.TrainingPhrase.Builder

newBuilderForType()

public Intent.TrainingPhrase.Builder newBuilderForType()
Returns
TypeDescription
Intent.TrainingPhrase.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Intent.TrainingPhrase.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Intent.TrainingPhrase.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static Intent.TrainingPhrase parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Intent.TrainingPhrase
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Intent.TrainingPhrase parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Intent.TrainingPhrase
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Intent.TrainingPhrase parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Intent.TrainingPhrase
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Intent.TrainingPhrase parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Intent.TrainingPhrase
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Intent.TrainingPhrase parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Intent.TrainingPhrase
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Intent.TrainingPhrase parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Intent.TrainingPhrase
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Intent.TrainingPhrase parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Intent.TrainingPhrase
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Intent.TrainingPhrase parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Intent.TrainingPhrase
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Intent.TrainingPhrase parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Intent.TrainingPhrase
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Intent.TrainingPhrase parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Intent.TrainingPhrase
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Intent.TrainingPhrase parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Intent.TrainingPhrase
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Intent.TrainingPhrase parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Intent.TrainingPhrase
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

toBuilder()

public Intent.TrainingPhrase.Builder toBuilder()
Returns
TypeDescription
Intent.TrainingPhrase.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException