Get Evaluation Set

Retrieve a specific evaluation set by ID. This returns an evaluation set object, but does not include the items in the evaluation set. You can use the List Evaluation Set Items endpoint to get the items in an evaluation set.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The ID of the evaluation set.

Example: "ev_2LcgeY_mp2T5yPaEuq5Lw"

Response

Successfully retrieved evaluation set

objectenum

The type of object. In this case, it will always be "evaluation_set".

Allowed values:

idstring

The ID of the evaluation set.

Example: "ev_2LcgeY_mp2T5yPaEuq5Lw"

namestring

The name of the evaluation set.

Example: "Invoice Processing Test Set"

descriptionstring

A description of the evaluation set.

Example: "Q4 2023 vendor invoices for accuracy testing"

entityobject

The extractor, classifier, or splitter associated with this evaluation set.

createdAtstringformat: "date-time"

The time (in UTC) at which the object was created. Will follow the RFC 3339 format.

Example: "2024-03-21T16:45:00Z"

updatedAtstringformat: "date-time"

The time (in UTC) at which the object was last updated. Will follow the RFC 3339 format.

Example: "2024-03-21T16:45:00Z"

1	import { ExtendClient, ExtendEnvironment } from "extend-ai";
2
3	async function main() {
4	const client = new ExtendClient({
5	environment: ExtendEnvironment.Production,
6	token: "YOUR_TOKEN_HERE",
7	});
8	await client.evaluationSets.retrieve("evaluation_set_id_here");
9	}
10	main();

1	{
2	"object": "evaluation_set",
3	"id": "ev_2LcgeY_mp2T5yPaEuq5Lw",
4	"name": "Invoice Processing Test Set",
5	"description": "Q4 2023 vendor invoices for accuracy testing",
6	"entity": {
7	"object": "extractor",
8	"id": "ex_Xj8mK2pL9nR4vT7qY5wZ",
9	"name": "Invoice Extractor",
10	"createdAt": "2024-03-21T16:45:00Z",
11	"updatedAt": "2024-03-21T16:45:00Z"
12	},
13	"createdAt": "2024-03-21T16:45:00Z",
14	"updatedAt": "2024-03-21T16:45:00Z"
15	}

Get Evaluation Set

Authentication

Path parameters

Headers

Response

Errors