2022-11-12
▼ ▲ documentai.projects.locations.processors.processorVersions.evaluateProcessorVersion
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:evaluateProcessorVersion
HTTP Method: POST
Parameter Order: processorVersion
Description: Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.
Path: v1beta3/{+processorVersion}:evaluateProcessorVersion
Parameters:
processorVersion
Location: path
Description: Required. The resource name of the ProcessorVersion to evaluate. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/processors/[^/]+/processorVersions/[^/]+$
Type: string
▼ ▲ documentai.projects.locations.processors.processorVersions.train
Parameter Order: parent
HTTP Method: POST
Flat Path: v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions:train
Description: Trains a new processor version. Operation metadata is returned as cloud_documentai_core.TrainProcessorVersionMetadata.
Parameters:
parent
Type: string
Description: Required. The parent (project, location and processor) to create the new version for. Format: `projects/{project}/locations/{location}/processors/{processor}`.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/processors/[^/]+$
Path: v1beta3/{+parent}/processorVersions:train
▼ ▲ documentai.projects.locations.processors.processorVersions.evaluations.get
Description: Retrieves a specific evaluation.
Path: v1beta3/{+name}
Parameter Order: name
HTTP Method: GET
Flat Path: v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations/{evaluationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/processors/[^/]+/processorVersions/[^/]+/evaluations/[^/]+$
Required: Yes
Type: string
Location: path
Description: Required. The resource name of the Evaluation to get. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}`
▼ ▲ documentai.projects.locations.processors.processorVersions.evaluations.list
Flat Path: v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Description: Retrieves a set of evaluations for a given processor version.
Parameters:
pageToken
Location: query
Type: string
Description: A page token, received from a previous `ListEvaluations` call. Provide this to retrieve the subsequent page.
parent
Pattern: ^projects/[^/]+/locations/[^/]+/processors/[^/]+/processorVersions/[^/]+$
Location: path
Description: Required. The resource name of the ProcessorVersion to list evaluations for. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
Type: string
Required: Yes
pageSize
Format: int32
Type: integer
Location: query
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.
HTTP Method: GET
Path: v1beta3/{+parent}/evaluations