Skip to main content
← back to extensions

@swamp/gcp/documentai

v2026.04.23.1

Google Cloud documentai infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

gcpgoogle-clouddocumentaicloudinfrastructure

Contents

models

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/documentai

@swamp/gcp/documentai/locationsv2026.04.23.1locations.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a locations
ArgumentTypeDescription
identifierstringThe name of the locations
syncSync locations state from GCP
fetch_processor_typesfetch processor types

Resources

state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/documentai/processorsv2026.04.23.1processors.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
activeSchemaVersion?stringOptional. 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}
defaultProcessorVersion?stringThe default processor version.
displayName?stringThe display name of the processor.
kmsKeyName?stringThe [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.
type?stringThe processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a processors
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a processors
ArgumentTypeDescription
identifierstringThe name of the processors
deleteDelete the processors
ArgumentTypeDescription
identifierstringThe name of the processors
syncSync processors state from GCP
batch_processbatch process
ArgumentTypeDescription
documentOutputConfig?any
inputDocuments?any
labels?any
processOptions?any
skipHumanReview?any
disabledisable
enableenable
processprocess
ArgumentTypeDescription
documentOutputConfig?any
inputDocuments?any
labels?any
processOptions?any
skipHumanReview?any
set_default_processor_versionset default processor version
ArgumentTypeDescription
defaultProcessorVersion?any

Resources

state(infinite)— The first-class citizen for Document AI. Each processor defines how to extrac...
@swamp/gcp/documentai/processors-processorversionsv2026.04.23.1processors_processorversions.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a processorVersions
ArgumentTypeDescription
identifierstringThe name of the processorVersions
deleteDelete the processorVersions
ArgumentTypeDescription
identifierstringThe name of the processorVersions
syncSync processorVersions state from GCP
batch_processbatch process
ArgumentTypeDescription
documentOutputConfig?any
inputDocuments?any
labels?any
processOptions?any
skipHumanReview?any
deploydeploy
evaluate_processor_versionevaluate processor version
ArgumentTypeDescription
evaluationDocuments?any
processprocess
ArgumentTypeDescription
documentOutputConfig?any
inputDocuments?any
labels?any
processOptions?any
skipHumanReview?any
traintrain
ArgumentTypeDescription
baseProcessorVersion?any
customDocumentExtractionOptions?any
documentSchema?any
foundationModelTuningOptions?any
inputData?any
processorVersion?any
undeployundeploy

Resources

state(infinite)— A processor version is an implementation of a processor. Each processor can h...
@swamp/gcp/documentai/processors-processorversions-evaluationsv2026.04.23.1processors_processorversions_evaluations.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a evaluations
ArgumentTypeDescription
identifierstringThe name of the evaluations
syncSync evaluations state from GCP

Resources

state(infinite)— An evaluation of a ProcessorVersion's performance.
@swamp/gcp/documentai/processortypesv2026.04.23.1processortypes.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a processorTypes
ArgumentTypeDescription
identifierstringThe name of the processorTypes
syncSync processorTypes state from GCP

Resources

state(infinite)— A processor type is responsible for performing a certain document understandi...
@swamp/gcp/documentai/schemasv2026.04.23.1schemas.ts

Global Arguments

ArgumentTypeDescription
displayName?stringRequired. The user-defined name of the Schema.
labels?recordOptional. The {{gcp_name_short}} labels for the Schema.
name?stringIdentifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a schemas
getGet a schemas
ArgumentTypeDescription
identifierstringThe name of the schemas
updateUpdate schemas attributes
deleteDelete the schemas
ArgumentTypeDescription
identifierstringThe name of the schemas
syncSync schemas state from GCP

Resources

state(infinite)— NextSchema is a collection of SchemaVersions.
@swamp/gcp/documentai/schemas-schemaversionsv2026.04.23.1schemas_schemaversions.ts

Global Arguments

ArgumentTypeDescription
displayName?stringRequired. The user-defined name of the SchemaVersion.
labels?recordOptional. The {{gcp_name_short}} labels for the SchemaVersion.
name?stringIdentifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
schema?objectThe schema defines the output of the processed document by a processor.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a schemaVersions
getGet a schemaVersions
ArgumentTypeDescription
identifierstringThe name of the schemaVersions
updateUpdate schemaVersions attributes
deleteDelete the schemaVersions
ArgumentTypeDescription
identifierstringThe name of the schemaVersions
syncSync schemaVersions state from GCP
generategenerate
ArgumentTypeDescription
baseSchemaVersion?any
gcsDocuments?any
gcsPrefix?any
generateSchemaVersionParams?any
inlineDocuments?any
rawDocuments?any

Resources

state(infinite)— SchemaVersion is a version of the Schema which is created in SchemaGroup.