Evaluation Set Endpoints

Create Evaluation Set

Evaluation sets are collections of files and expected outputs that are used to evaluate the performance of a given processor in Extend. This endpoint will create a new evaluation set in Extend, which items can be added to using the Create Evaluation Set Item endpoint.

Note: it is not necessary to create an evaluation set via API. You can also create an evaluation set via the Extend dashboard and take the ID from there.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-extend-api-versionenumOptional

API version to use for the request. If you do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.

Allowed values:

Request

This endpoint expects an object.
namestringRequired

The name of the evaluation set.

Example: "Invoice Processing Test Set"

descriptionstringRequired

A description of what this evaluation set is used for.

Example: "Q4 2023 vendor invoices"

processorIdstringRequired

The ID of the processor to create an evaluation set for. Evaluation sets can in theory be run against any processor, but it is required to associate the evaluation set with a primary processor.

Example: "dp_Xj8mK2pL9nR4vT7qY5wZ"

Response

Successfully created evaluation set

successboolean
evaluationSetobject

The EvaluationSet object represents an evaluation set in Extend. Evaluation sets are collections of files and expected outputs that are used to evaluate the performance of a given processor in Extend.

Errors