Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1326324236.0 KB
projects

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.

post/v1/{+parent}/processors

Path parameters

parentstring required

Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location}

Request body

defaultProcessorVersionstring

The default processor version.

satisfiesPzsboolean

Output only. Reserved for future use.

activeSchemaVersionstring

Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}.

state'STATE_UNSPECIFIED' | 'ENABLED' | 'DISABLED' | 'ENABLING' | 'DISABLING' | 'CREATING' | 'FAILED' | 'DELETING'

Output only. The state of the processor.

createTimestring google-datetime

Output only. The time the processor was created.

kmsKeyNamestring

The KMS key used for encryption and decryption in CMEK scenarios.

displayNamestring

The display name of the processor.

processEndpointstring

Output only. Immutable. The http endpoint that can be called to invoke processing.

satisfiesPziboolean

Output only. Reserved for future use.

namestring

Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}

typestring

The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see FetchProcessorTypes.

Response

Successful response