Google Cloud Document Ai V1 Client - Class TrainProcessorVersionRequest (2.5.0)

Reference documentation and code samples for the Google Cloud Document Ai V1 Client class TrainProcessorVersionRequest.

Request message for the TrainProcessorVersion method.

Generated from protobuf message google.cloud.documentai.v1.TrainProcessorVersionRequest

Namespace

Google \ Cloud \ DocumentAI \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ custom_document_extraction_options`	`TrainProcessorVersionRequest\CustomDocumentExtractionOptions` Options to control Custom Document Extraction (CDE) Processor.
`↳ foundation_model_tuning_options`	`TrainProcessorVersionRequest\FoundationModelTuningOptions` Options to control foundation model tuning of a processor.
`↳ parent`	`string` Required. The parent (project, location and processor) to create the new version for. Format: `projects/{project}/locations/{location}/processors/{processor}`.
`↳ processor_version`	`ProcessorVersion` Required. The processor version to be created.
`↳ document_schema`	`DocumentSchema` Optional. The schema the processor version will be trained with.
`↳ input_data`	`TrainProcessorVersionRequest\InputData` Optional. The input data used to train the ProcessorVersion.
`↳ base_processor_version`	`string` Optional. The processor version to use as a base for training. This processor version must be a child of `parent`. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.

getCustomDocumentExtractionOptions

Options to control Custom Document Extraction (CDE) Processor.

Returns
Type	Description
`TrainProcessorVersionRequest\CustomDocumentExtractionOptions\|null`

hasCustomDocumentExtractionOptions

setCustomDocumentExtractionOptions

Options to control Custom Document Extraction (CDE) Processor.

Parameter
Name	Description
`var`	`TrainProcessorVersionRequest\CustomDocumentExtractionOptions`

Returns
Type	Description
`$this`

getFoundationModelTuningOptions

Options to control foundation model tuning of a processor.

Returns
Type	Description
`TrainProcessorVersionRequest\FoundationModelTuningOptions\|null`

hasFoundationModelTuningOptions

setFoundationModelTuningOptions

Options to control foundation model tuning of a processor.

Parameter
Name	Description
`var`	`TrainProcessorVersionRequest\FoundationModelTuningOptions`

Returns
Type	Description
`$this`

getParent

Required. The parent (project, location and processor) to create the new version for. Format: projects/{project}/locations/{location}/processors/{processor}.

Returns
Type	Description
`string`

setParent

Required. The parent (project, location and processor) to create the new version for. Format: projects/{project}/locations/{location}/processors/{processor}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getProcessorVersion

Required. The processor version to be created.

Returns
Type	Description
`ProcessorVersion\|null`

hasProcessorVersion

clearProcessorVersion

setProcessorVersion

Required. The processor version to be created.

Parameter
Name	Description
`var`	`ProcessorVersion`

Returns
Type	Description
`$this`

getDocumentSchema

Optional. The schema the processor version will be trained with.

Returns
Type	Description
`DocumentSchema\|null`

hasDocumentSchema

clearDocumentSchema

setDocumentSchema

Optional. The schema the processor version will be trained with.

Parameter
Name	Description
`var`	`DocumentSchema`

Returns
Type	Description
`$this`

getInputData

Optional. The input data used to train the ProcessorVersion.

Returns
Type	Description
`TrainProcessorVersionRequest\InputData\|null`

hasInputData

clearInputData

setInputData

Optional. The input data used to train the ProcessorVersion.

Parameter
Name	Description
`var`	`TrainProcessorVersionRequest\InputData`

Returns
Type	Description
`$this`

getBaseProcessorVersion

Optional. The processor version to use as a base for training. This processor version must be a child of parent. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}.

Returns
Type	Description
`string`

setBaseProcessorVersion

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getProcessorFlags

Returns
Type	Description
`string`

static::build

Parameters
Name	Description
`parent`	`string` Required. The parent (project, location and processor) to create the new version for. Format: `projects/{project}/locations/{location}/processors/{processor}`. Please see DocumentProcessorServiceClient::processorName() for help formatting this field.
`processorVersion`	`ProcessorVersion` Required. The processor version to be created.

Returns
Type	Description
`TrainProcessorVersionRequest`