1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Document
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsProcessorsProcessorVersions

ProjectsLocationsProcessorsProcessorVersions

class ProjectsLocationsProcessorsProcessorVersions extends Resource (View source)

The "processorVersions" collection of methods.

Typical usage is:

 $documentaiService = new Google\Service\Document(...);
 $processorVersions = $documentaiService->projects_locations_processors_processorVersions;

Methods

GoogleLongrunningOperation
batchProcess(string $name, GoogleCloudDocumentaiV1BatchProcessRequest $postBody, array $optParams = [])

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format. (processorVersions.batchProcess)

GoogleLongrunningOperation
delete(string $name, array $optParams = [])

Deletes the processor version, all artifacts under the processor version will be deleted. (processorVersions.delete)

GoogleLongrunningOperation
deploy(string $name, GoogleCloudDocumentaiV1DeployProcessorVersionRequest $postBody, array $optParams = [])

Deploys the processor version. (processorVersions.deploy)

GoogleLongrunningOperation
evaluateProcessorVersion(string $processorVersion, GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest $postBody, array $optParams = [])

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation. (processorVersions.evaluateProcessorVersion)

GoogleCloudDocumentaiV1ProcessorVersion
get(string $name, array $optParams = [])

Gets a processor version detail. (processorVersions.get)

GoogleCloudDocumentaiV1ListProcessorVersionsResponse
listProjectsLocationsProcessorsProcessorVersions(string $parent, array $optParams = [])

Lists all versions of a processor.

GoogleCloudDocumentaiV1ProcessResponse
process(string $name, GoogleCloudDocumentaiV1ProcessRequest $postBody, array $optParams = [])

Processes a single document. (processorVersions.process)

GoogleLongrunningOperation
train(string $parent, GoogleCloudDocumentaiV1TrainProcessorVersionRequest $postBody, array $optParams = [])

Trains a new processor version. Operation metadata is returned as TrainProcessorVersionMetadata. (processorVersions.train)

GoogleLongrunningOperation
undeploy(string $name, GoogleCloudDocumentaiV1UndeployProcessorVersionRequest $postBody, array $optParams = [])

Undeploys the processor version. (processorVersions.undeploy)

Details

at line 55
GoogleLongrunningOperation batchProcess(string $name, GoogleCloudDocumentaiV1BatchProcessRequest $postBody, array $optParams = [])

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format. (processorVersions.batchProcess)

Parameters

string $name

Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or project s/{project}/locations/{location}/processors/{processor}/processorVersions/{pr ocessorVersion}
GoogleCloudDocumentaiV1BatchProcessRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 71
GoogleLongrunningOperation delete(string $name, array $optParams = [])

Deletes the processor version, all artifacts under the processor version will be deleted. (processorVersions.delete)

Parameters

string $name

Required. The processor version resource name to be deleted.
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 87
GoogleLongrunningOperation deploy(string $name, GoogleCloudDocumentaiV1DeployProcessorVersionRequest $postBody, array $optParams = [])

Deploys the processor version. (processorVersions.deploy)

Parameters

string $name

Required. The processor version resource name to be deployed.
GoogleCloudDocumentaiV1DeployProcessorVersionRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 105
GoogleLongrunningOperation evaluateProcessorVersion(string $processorVersion, GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest $postBody, array $optParams = [])

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation. (processorVersions.evaluateProcessorVersion)

Parameters

string $processorVersion

Required. The resource name of the ProcessorVersion to evaluate. projects/{project}/locations/{location}/proces sors/{processor}/processorVersions/{processorVersion}
GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 119
GoogleCloudDocumentaiV1ProcessorVersion get(string $name, array $optParams = [])

Gets a processor version detail. (processorVersions.get)

Parameters

string $name

Required. The processor resource name.
array $optParams

Optional parameters.

Return Value

GoogleCloudDocumentaiV1ProcessorVersion

Exceptions

Exception

at line 142
GoogleCloudDocumentaiV1ListProcessorVersionsResponse listProjectsLocationsProcessorsProcessorVersions(string $parent, array $optParams = [])

Lists all versions of a processor.

(processorVersions.listProjectsLocationsProcessorsProcessorVersions)

Parameters

string $parent

Required. The parent (project, location and processor) to list all versions. Format: projects/{project}/locations/{location}/processors/{processor}
array $optParams

Optional parameters.

Return Value

GoogleCloudDocumentaiV1ListProcessorVersionsResponse

Exceptions

Exception

at line 162
GoogleCloudDocumentaiV1ProcessResponse process(string $name, GoogleCloudDocumentaiV1ProcessRequest $postBody, array $optParams = [])

Processes a single document. (processorVersions.process)

Parameters

string $name

Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: projects/{project}/locations/{location}/processors/{processor}, or project s/{project}/locations/{location}/processors/{processor}/processorVersions/{pr ocessorVersion}
GoogleCloudDocumentaiV1ProcessRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDocumentaiV1ProcessResponse

Exceptions

Exception

at line 180
GoogleLongrunningOperation train(string $parent, GoogleCloudDocumentaiV1TrainProcessorVersionRequest $postBody, array $optParams = [])

Trains a new processor version. Operation metadata is returned as TrainProcessorVersionMetadata. (processorVersions.train)

Parameters

string $parent

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

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 196
GoogleLongrunningOperation undeploy(string $name, GoogleCloudDocumentaiV1UndeployProcessorVersionRequest $postBody, array $optParams = [])

Undeploys the processor version. (processorVersions.undeploy)

Parameters

string $name

Required. The processor version resource name to be undeployed.
GoogleCloudDocumentaiV1UndeployProcessorVersionRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception