Cloud Document AI API (documentai:v1beta3)

Additions

Methods


• ▼ ▲ documentai.projects.locations.processors.dataset.getDocument

  HTTP Method: GET

  Flat Path: v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/dataset:getDocument

  Path: v1beta3/{+dataset}:getDocument

  Parameters:

  documentId.gcsManagedDocId.cwDocId

  Deprecated: Yes

  Description: Id of the document (indexed) managed by Content Warehouse.

  Type: string

  Location: query

  documentId.revisionRef.revisionId

  Description: Reads the revision given by the id.

  Location: query

  Type: string

  documentId.revisionRef.latestProcessorVersion

  Description: Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`

  Type: string

  Location: query

  documentId.revisionRef.revisionCase

  Description: Reads the revision by the predefined case.

  Enum:

  • REVISION_CASE_UNSPECIFIED
  • LATEST_HUMAN_REVIEW
  • LATEST_TIMESTAMP
  • BASE_OCR_REVISION

  Location: query

  Enum Descriptions:

  • Unspecified case, fallback to read the LATEST_HUMAN_REVIEW.
  • The latest revision made by a human.
  • The latest revision based on timestamp.
  • The first (OCR) revision.

  Type: string

  documentId.gcsManagedDocId.gcsUri

  Location: query

  Description: Required. The Cloud Storage URI where the actual document is stored.

  Type: string

  documentId.unmanagedDocId.docId

  Description: Required. The id of the document.

  Type: string

  Location: query

  dataset

  Type: string

  Required: Yes

  Pattern: ^projects/[^/]+/locations/[^/]+/processors/[^/]+/dataset$

  Description: Required. The resource name of the dataset that the document belongs to . Format: projects/{project}/locations/{location}/processors/{processor}/dataset

  Location: path

  readMask

  Location: query

  Description: If set, only fields listed here will be returned. Otherwise, all fields will be returned by default.

  Type: string

  Format: google-fieldmask

  pageRange.start

  Type: integer

  Description: First page number (one-based index) to be returned.

  Format: int32

  Location: query

  pageRange.end

  Type: integer

  Description: Last page number (one-based index) to be returned.

  Format: int32

  Location: query

  Description: Returns relevant fields present in the requested document.

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Parameter Order: dataset

• ▼ ▲ documentai.projects.locations.processors.dataset.batchDeleteDocuments

  Parameters:

  dataset

  Description: Required. The dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

  Type: string

  Required: Yes

  Location: path

  Pattern: ^projects/[^/]+/locations/[^/]+/processors/[^/]+/dataset$

  Flat Path: v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/dataset:batchDeleteDocuments

  Path: v1beta3/{+dataset}:batchDeleteDocuments

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Deletes a set of documents.

  Parameter Order: dataset

  HTTP Method: POST

• ▼ ▲ documentai.projects.locations.processors.dataset.importDocuments

  Path: v1beta3/{+dataset}:importDocuments

  Flat Path: v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/dataset:importDocuments

  Parameters:

  dataset

  Description: Required. The dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

  Location: path

  Required: Yes

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+/processors/[^/]+/dataset$

  Parameter Order: dataset

  HTTP Method: POST

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Import documents into a dataset.