Google Cloud Dialogflow V2 Client - Class TrainingPhrase (1.11.0)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class TrainingPhrase.

Represents an example that the agent is trained on.

Generated from protobuf message google.cloud.dialogflow.v2.Intent.TrainingPhrase

Namespace

Google \ Cloud \ Dialogflow \ V2 \ Intent

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The unique identifier of this training phrase.

↳ type int

Required. The type of the training phrase.

↳ parts array<Google\Cloud\Dialogflow\V2\Intent\TrainingPhrase\Part>

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.

↳ times_added_count int

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.

getName

Output only. The unique identifier of this training phrase.

Returns
TypeDescription
string

setName

Output only. The unique identifier of this training phrase.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getType

Required. The type of the training phrase.

Returns
TypeDescription
int

setType

Required. The type of the training phrase.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getParts

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.
Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setParts

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.
Parameter
NameDescription
var array<Google\Cloud\Dialogflow\V2\Intent\TrainingPhrase\Part>
Returns
TypeDescription
$this

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.

Returns
TypeDescription
int

setTimesAddedCount

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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this