Google Cloud Ai Platform V1 Client - Class GenerateSyntheticDataRequest (1.36.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class GenerateSyntheticDataRequest.

Request message for DataFoundryService.GenerateSyntheticData.

Generated from protobuf message google.cloud.aiplatform.v1.GenerateSyntheticDataRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ task_description TaskDescriptionStrategy

Generate data from a high-level task description.

↳ location string

Required. The resource name of the Location to run the job. Format: projects/{project}/locations/{location}

↳ count int

Required. The number of synthetic examples to generate. For this stateless API, the count is limited to a small number.

↳ output_field_specs array<OutputFieldSpec>

Required. The schema of the desired output, defined by a list of fields.

↳ examples array<SyntheticExample>

Optional. A list of few-shot examples to guide the model's output style and format.

getTaskDescription

Generate data from a high-level task description.

Returns
Type Description
TaskDescriptionStrategy|null

hasTaskDescription

setTaskDescription

Generate data from a high-level task description.

Parameter
Name Description
var TaskDescriptionStrategy
Returns
Type Description
$this

getLocation

Required. The resource name of the Location to run the job.

Format: projects/{project}/locations/{location}

Returns
Type Description
string

setLocation

Required. The resource name of the Location to run the job.

Format: projects/{project}/locations/{location}

Parameter
Name Description
var string
Returns
Type Description
$this

getCount

Required. The number of synthetic examples to generate.

For this stateless API, the count is limited to a small number.

Returns
Type Description
int

setCount

Required. The number of synthetic examples to generate.

For this stateless API, the count is limited to a small number.

Parameter
Name Description
var int
Returns
Type Description
$this

getOutputFieldSpecs

Required. The schema of the desired output, defined by a list of fields.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setOutputFieldSpecs

Required. The schema of the desired output, defined by a list of fields.

Parameter
Name Description
var array<OutputFieldSpec>
Returns
Type Description
$this

getExamples

Optional. A list of few-shot examples to guide the model's output style and format.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setExamples

Optional. A list of few-shot examples to guide the model's output style and format.

Parameter
Name Description
var array<SyntheticExample>
Returns
Type Description
$this

getStrategy

Returns
Type Description
string