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}.
Optional. The processor version to use as a base for training. This processor version must be a child ofparent. Format:projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}.
getCustomDocumentExtractionOptions
Options to control Custom Document Extraction (CDE) Processor.
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}.
Optional. The processor version to use as a base for training. This
processor version must be a child ofparent. Format:projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}.
Returns
Type
Description
string
setBaseProcessorVersion
Optional. The processor version to use as a base for training. This
processor version must be a child ofparent. Format:projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}.
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 seeDocumentProcessorServiceClient::processorName()for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Document Ai V1 Client - Class TrainProcessorVersionRequest (2.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.0 (latest)](/php/docs/reference/cloud-document-ai/latest/V1.TrainProcessorVersionRequest)\n- [2.2.2](/php/docs/reference/cloud-document-ai/2.2.2/V1.TrainProcessorVersionRequest)\n- [2.1.3](/php/docs/reference/cloud-document-ai/2.1.3/V1.TrainProcessorVersionRequest)\n- [2.0.0](/php/docs/reference/cloud-document-ai/2.0.0/V1.TrainProcessorVersionRequest)\n- [1.14.0](/php/docs/reference/cloud-document-ai/1.14.0/V1.TrainProcessorVersionRequest)\n- [1.13.1](/php/docs/reference/cloud-document-ai/1.13.1/V1.TrainProcessorVersionRequest)\n- [1.12.2](/php/docs/reference/cloud-document-ai/1.12.2/V1.TrainProcessorVersionRequest)\n- [1.9.0](/php/docs/reference/cloud-document-ai/1.9.0/V1.TrainProcessorVersionRequest)\n- [1.8.2](/php/docs/reference/cloud-document-ai/1.8.2/V1.TrainProcessorVersionRequest)\n- [1.7.0](/php/docs/reference/cloud-document-ai/1.7.0/V1.TrainProcessorVersionRequest)\n- [1.6.0](/php/docs/reference/cloud-document-ai/1.6.0/V1.TrainProcessorVersionRequest)\n- [1.5.0](/php/docs/reference/cloud-document-ai/1.5.0/V1.TrainProcessorVersionRequest)\n- [1.4.0](/php/docs/reference/cloud-document-ai/1.4.0/V1.TrainProcessorVersionRequest)\n- [1.3.0](/php/docs/reference/cloud-document-ai/1.3.0/V1.TrainProcessorVersionRequest)\n- [1.2.2](/php/docs/reference/cloud-document-ai/1.2.2/V1.TrainProcessorVersionRequest)\n- [1.1.1](/php/docs/reference/cloud-document-ai/1.1.1/V1.TrainProcessorVersionRequest)\n- [1.0.1](/php/docs/reference/cloud-document-ai/1.0.1/V1.TrainProcessorVersionRequest) \nReference documentation and code samples for the Google Cloud Document Ai V1 Client class TrainProcessorVersionRequest.\n\nRequest message for the\n[TrainProcessorVersion](/php/docs/reference/cloud-document-ai/latest/V1.Client.DocumentProcessorServiceClient#_Google_Cloud_DocumentAI_V1_Client_DocumentProcessorServiceClient__trainProcessorVersion__)\nmethod.\n\nGenerated from protobuf message `google.cloud.documentai.v1.TrainProcessorVersionRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DocumentAI \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getCustomDocumentExtractionOptions\n\nOptions to control Custom Document Extraction (CDE) Processor.\n\n### hasCustomDocumentExtractionOptions\n\n### setCustomDocumentExtractionOptions\n\nOptions to control Custom Document Extraction (CDE) Processor.\n\n### getFoundationModelTuningOptions\n\nOptions to control foundation model tuning of a processor.\n\n### hasFoundationModelTuningOptions\n\n### setFoundationModelTuningOptions\n\nOptions to control foundation model tuning of a processor.\n\n### getParent\n\nRequired. The parent (project, location and processor) to create the new\nversion for. Format:\n`projects/{project}/locations/{location}/processors/{processor}`.\n\n### setParent\n\nRequired. The parent (project, location and processor) to create the new\nversion for. Format:\n`projects/{project}/locations/{location}/processors/{processor}`.\n\n### getProcessorVersion\n\nRequired. The processor version to be created.\n\n### hasProcessorVersion\n\n### clearProcessorVersion\n\n### setProcessorVersion\n\nRequired. The processor version to be created.\n\n### getDocumentSchema\n\nOptional. The schema the processor version will be trained with.\n\n### hasDocumentSchema\n\n### clearDocumentSchema\n\n### setDocumentSchema\n\nOptional. The schema the processor version will be trained with.\n\n### getInputData\n\nOptional. The input data used to train the\n[ProcessorVersion](/php/docs/reference/cloud-document-ai/latest/V1.ProcessorVersion).\n\n### hasInputData\n\n### clearInputData\n\n### setInputData\n\nOptional. The input data used to train the\n[ProcessorVersion](/php/docs/reference/cloud-document-ai/latest/V1.ProcessorVersion).\n\n### getBaseProcessorVersion\n\nOptional. The processor version to use as a base for training. This\nprocessor version must be a child of `parent`. Format:\n`projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.\n\n### setBaseProcessorVersion\n\nOptional. The processor version to use as a base for training. This\nprocessor version must be a child of `parent`. Format:\n`projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.\n\n### getProcessorFlags\n\n### static::build"]]