Method: evaluations.list

Full name: projects.locations.processors.processorVersions.evaluations.list

Retrieves a set of evaluations for a given processor version.

HTTP request

GET https://{endpoint}/v1/{parent}/evaluations

Where {endpoint} is one of the supported service endpoints.

Path parameters

Parameters
parent

string

Required. The resource name of the ProcessorVersion to list evaluations for. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion} It takes the form projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorversion}.

Authorization requires the following IAM permission on the specified resource parent:

  • documentai.evaluations.list

Query parameters

Parameters
pageSize

integer

The standard list page size. If unspecified, at most 5 evaluations are returned. The maximum value is 100. Values above 100 are coerced to 100.
pageToken

string

A page token, received from a previous evaluations.list call. Provide this to retrieve the subsequent page.

Request body

The request body must be empty.

Response body

The response from evaluations.list.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "evaluations": [
    {
      object (Evaluation)
    }
  ],
  "nextPageToken": string
}
Fields
evaluations[]

object (Evaluation)

The evaluations requested.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • documentai.evaluations.list

For more information, see the IAM documentation.