Cloud Document AI API (documentai:v1)

Additions

Methods


• ▼ ▲ documentai.projects.locations.processors.processorVersions.evaluations.list

  Description: Retrieves a set of evaluations for a given processor version.

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations

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

  HTTP Method: GET

  Parameter Order: parent

  Parameters:

  pageToken

  Location: query

  Description: A page token, received from a previous `ListEvaluations` call. Provide this to retrieve the subsequent page.

  Type: string

  pageSize

  Description: The standard list page size. If unspecified, at most 5 evaluations will be returned. The maximum value is 100; values above 100 will be coerced to 100.

  Location: query

  Type: integer

  Format: int32

  parent

  Description: Required. The resource name of the ProcessorVersion to list evaluations for. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`

  Required: Yes

  Location: path

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

  Type: string

  Path: v1/{+parent}/evaluations

• ▼ ▲ documentai.projects.locations.processors.processorVersions.evaluations.get

  HTTP Method: GET

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations/{evaluationsId}

  Description: Retrieves a specific evaluation.

  Parameter Order: name

  Path: v1/{+name}

  Parameters:

  name

  Pattern: ^projects/[^/]+/locations/[^/]+/processors/[^/]+/processorVersions/[^/]+/evaluations/[^/]+$

  Description: Required. The resource name of the Evaluation to get. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}`

  Location: path

  Type: string

  Required: Yes

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

• ▼ ▲ documentai.projects.locations.processors.processorVersions.train

  Path: v1/{+parent}/processorVersions:train

  Parameter Order: parent

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions:train

  HTTP Method: POST

  Description: Trains a new processor version. Operation metadata is returned as cloud_documentai_core.TrainProcessorVersionMetadata.

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

  Parameters:

  parent

  Location: path

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

  Description: Required. The parent (project, location and processor) to create the new version for. Format: `projects/{project}/locations/{location}/processors/{processor}`.

  Required: Yes

  Type: string

• ▼ ▲ documentai.projects.locations.processors.processorVersions.evaluateProcessorVersion

  Description: Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:evaluateProcessorVersion

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

  Parameter Order: processorVersion

  Parameters:

  processorVersion

  Required: Yes

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

  Description: Required. The resource name of the ProcessorVersion to evaluate. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`

  Type: string

  Location: path

  Path: v1/{+processorVersion}:evaluateProcessorVersion

  HTTP Method: POST