* $documentaiService = new Google\Service\Document(...); * $processors = $documentaiService->projects_locations_processors; * */ class ProjectsLocationsProcessors extends \Google\Service\Resource { /** * LRO endpoint to batch process many documents. The output is written to Cloud * Storage as JSON in the [Document] format. (processors.batchProcess) * * @param 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}` * @param GoogleCloudDocumentaiV1BatchProcessRequest $postBody * @param array $optParams Optional parameters. * @return GoogleLongrunningOperation * @throws \Google\Service\Exception */ public function batchProcess($name, GoogleCloudDocumentaiV1BatchProcessRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('batchProcess', [$params], GoogleLongrunningOperation::class); } /** * Creates a processor from the ProcessorType provided. The processor will be at * `ENABLED` state by default after its creation. Note that this method requires * the `documentai.processors.create` permission on the project, which is highly * privileged. A user or service account with this permission can create new * processors that can interact with any gcs bucket in your project. * (processors.create) * * @param string $parent Required. The parent (project and location) under which * to create the processor. Format: `projects/{project}/locations/{location}` * @param GoogleCloudDocumentaiV1Processor $postBody * @param array $optParams Optional parameters. * @return GoogleCloudDocumentaiV1Processor * @throws \Google\Service\Exception */ public function create($parent, GoogleCloudDocumentaiV1Processor $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], GoogleCloudDocumentaiV1Processor::class); } /** * Deletes the processor, unloads all deployed model artifacts if it was enabled * and then deletes all artifacts associated with this processor. * (processors.delete) * * @param string $name Required. The processor resource name to be deleted. * @param array $optParams Optional parameters. * @return GoogleLongrunningOperation * @throws \Google\Service\Exception */ public function delete($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('delete', [$params], GoogleLongrunningOperation::class); } /** * Disables a processor (processors.disable) * * @param string $name Required. The processor resource name to be disabled. * @param GoogleCloudDocumentaiV1DisableProcessorRequest $postBody * @param array $optParams Optional parameters. * @return GoogleLongrunningOperation * @throws \Google\Service\Exception */ public function disable($name, GoogleCloudDocumentaiV1DisableProcessorRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('disable', [$params], GoogleLongrunningOperation::class); } /** * Enables a processor (processors.enable) * * @param string $name Required. The processor resource name to be enabled. * @param GoogleCloudDocumentaiV1EnableProcessorRequest $postBody * @param array $optParams Optional parameters. * @return GoogleLongrunningOperation * @throws \Google\Service\Exception */ public function enable($name, GoogleCloudDocumentaiV1EnableProcessorRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('enable', [$params], GoogleLongrunningOperation::class); } /** * Gets a processor detail. (processors.get) * * @param string $name Required. The processor resource name. * @param array $optParams Optional parameters. * @return GoogleCloudDocumentaiV1Processor * @throws \Google\Service\Exception */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], GoogleCloudDocumentaiV1Processor::class); } /** * Lists all processors which belong to this project. * (processors.listProjectsLocationsProcessors) * * @param string $parent Required. The parent (project and location) which owns * this collection of Processors. Format: * `projects/{project}/locations/{location}` * @param array $optParams Optional parameters. * * @opt_param int pageSize The maximum number of processors to return. If * unspecified, at most `50` processors will be returned. The maximum value is * `100`. Values above `100` will be coerced to `100`. * @opt_param string pageToken We will return the processors sorted by creation * time. The page token will point to the next processor. * @return GoogleCloudDocumentaiV1ListProcessorsResponse * @throws \Google\Service\Exception */ public function listProjectsLocationsProcessors($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], GoogleCloudDocumentaiV1ListProcessorsResponse::class); } /** * Processes a single document. (processors.process) * * @param 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}` * @param GoogleCloudDocumentaiV1ProcessRequest $postBody * @param array $optParams Optional parameters. * @return GoogleCloudDocumentaiV1ProcessResponse * @throws \Google\Service\Exception */ public function process($name, GoogleCloudDocumentaiV1ProcessRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('process', [$params], GoogleCloudDocumentaiV1ProcessResponse::class); } /** * Set the default (active) version of a Processor that will be used in * ProcessDocument and BatchProcessDocuments. * (processors.setDefaultProcessorVersion) * * @param string $processor Required. The resource name of the Processor to * change default version. * @param GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest $postBody * @param array $optParams Optional parameters. * @return GoogleLongrunningOperation * @throws \Google\Service\Exception */ public function setDefaultProcessorVersion($processor, GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest $postBody, $optParams = []) { $params = ['processor' => $processor, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('setDefaultProcessorVersion', [$params], GoogleLongrunningOperation::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsLocationsProcessors::class, 'Google_Service_Document_Resource_ProjectsLocationsProcessors');