Document AI V1 API - Class Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest (v1.4.0)

Version latest

• 1.4.0 (latest)
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.0
• 0.23.1
• 0.22.0
• 0.21.1
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.2
• 0.16.2
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.4

Reference documentation and code samples for the Document AI V1 API class Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest.

Request message for the TrainProcessorVersion method.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#base_processor_version

def base_processor_version() -> ::String

Returns

• (::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}.

#base_processor_version=

def base_processor_version=(value) -> ::String

Parameter

• value (::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}.

Returns

• (::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}.

#custom_document_extraction_options

def custom_document_extraction_options() -> ::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::CustomDocumentExtractionOptions

Returns

• (::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::CustomDocumentExtractionOptions) — Options to control Custom Document Extraction (CDE) Processor.

  Note: The following fields are mutually exclusive: custom_document_extraction_options, foundation_model_tuning_options. If a field in that set is populated, all other fields in the set will automatically be cleared.

#custom_document_extraction_options=

def custom_document_extraction_options=(value) -> ::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::CustomDocumentExtractionOptions

Parameter

• value (::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::CustomDocumentExtractionOptions) — Options to control Custom Document Extraction (CDE) Processor.

  Note: The following fields are mutually exclusive: custom_document_extraction_options, foundation_model_tuning_options. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::CustomDocumentExtractionOptions) — Options to control Custom Document Extraction (CDE) Processor.

  Note: The following fields are mutually exclusive: custom_document_extraction_options, foundation_model_tuning_options. If a field in that set is populated, all other fields in the set will automatically be cleared.

#document_schema

def document_schema() -> ::Google::Cloud::DocumentAI::V1::DocumentSchema

Returns

• (::Google::Cloud::DocumentAI::V1::DocumentSchema) — Optional. The schema the processor version will be trained with.

#document_schema=

def document_schema=(value) -> ::Google::Cloud::DocumentAI::V1::DocumentSchema

Parameter

• value (::Google::Cloud::DocumentAI::V1::DocumentSchema) — Optional. The schema the processor version will be trained with.

Returns

• (::Google::Cloud::DocumentAI::V1::DocumentSchema) — Optional. The schema the processor version will be trained with.

#foundation_model_tuning_options

def foundation_model_tuning_options() -> ::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::FoundationModelTuningOptions

Returns

• (::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::FoundationModelTuningOptions) — Options to control foundation model tuning of a processor.

  Note: The following fields are mutually exclusive: foundation_model_tuning_options, custom_document_extraction_options. If a field in that set is populated, all other fields in the set will automatically be cleared.

#foundation_model_tuning_options=

def foundation_model_tuning_options=(value) -> ::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::FoundationModelTuningOptions

Parameter

• value (::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::FoundationModelTuningOptions) — Options to control foundation model tuning of a processor.

  Note: The following fields are mutually exclusive: foundation_model_tuning_options, custom_document_extraction_options. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::FoundationModelTuningOptions) — Options to control foundation model tuning of a processor.

  Note: The following fields are mutually exclusive: foundation_model_tuning_options, custom_document_extraction_options. If a field in that set is populated, all other fields in the set will automatically be cleared.

#input_data

def input_data() -> ::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::InputData

Returns

• (::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::InputData) — Optional. The input data used to train the ProcessorVersion.

#input_data=

def input_data=(value) -> ::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::InputData

Parameter

• value (::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::InputData) — Optional. The input data used to train the ProcessorVersion.

Returns

• (::Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest::InputData) — Optional. The input data used to train the ProcessorVersion.

#parent

def parent() -> ::String

Returns

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

#parent=

def parent=(value) -> ::String

Parameter

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

Returns

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

#processor_version

def processor_version() -> ::Google::Cloud::DocumentAI::V1::ProcessorVersion

Returns

• (::Google::Cloud::DocumentAI::V1::ProcessorVersion) — Required. The processor version to be created.

#processor_version=

def processor_version=(value) -> ::Google::Cloud::DocumentAI::V1::ProcessorVersion

Parameter

• value (::Google::Cloud::DocumentAI::V1::ProcessorVersion) — Required. The processor version to be created.

Returns

• (::Google::Cloud::DocumentAI::V1::ProcessorVersion) — Required. The processor version to be created.