Get Evaluation Set Run

Get details of an evaluation set run.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The ID of the evaluation set run.

Example: "evr_Xj8mK2pL9nR4vT7qY5wZ"

Response

Successfully retrieved evaluation set run

objectenum

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

Allowed values:

idstring

The unique identifier for this evaluation set run.

Example: "eval_set_run_Xj8mK2pL9nR4vT7qY5wZ"

evaluationSetIdstring

The ID of the evaluation set that was run.

Example: "ev_2LcgeY_mp2T5yPaEuq5Lw"

entityobject

The extractor, classifier, or splitter that was run.

entityVersionobject

The version of the extractor, classifier, or splitter that was run.

metricsobject

statusenum

The status of a run:

"PENDING" - The run has not started yet
"PROCESSING" - The run is in progress
"PROCESSED" - The run completed successfully
"FAILED" - The run failed

The status of a run: * `"PENDING"` - The run has not started yet * `"PROCESSING"` - The run is in progress * `"PROCESSED"` - The run completed successfully * `"FAILED"` - The run failed

Allowed values:

optionsobject

The options for the evaluation set run.

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.evaluationSetRuns.retrieve("evaluation_set_run_id_here");
9	}
10	main();

1	{
2	"object": "evaluation_set_run",
3	"id": "eval_set_run_Xj8mK2pL9nR4vT7qY5wZ",
4	"evaluationSetId": "ev_2LcgeY_mp2T5yPaEuq5Lw",
5	"entity": {
6	"object": "extractor",
7	"id": "ex_Xj8mK2pL9nR4vT7qY5wZ",
8	"name": "Invoice Extractor",
9	"createdAt": "2024-03-21T16:45:00Z",
10	"updatedAt": "2024-03-21T16:45:00Z"
11	},
12	"entityVersion": {
13	"object": "extractor_version",
14	"id": "exv_xK9mLPqRtN3vS8wF5hB2cQ",
15	"description": "Updated extraction fields for new invoice format",
16	"version": "draft",
17	"extractorId": "ex_Xj8mK2pL9nR4vT7qY5wZ",
18	"createdAt": "2024-03-21T16:45:00Z"
19	},
20	"metrics": {
21	"numFiles": 1.1,
22	"numPages": 1.1
23	},
24	"status": "PROCESSING",
25	"options": {
26	"fuzzyMatchFields": [
27	"string"
28	],
29	"excludeFields": [
30	"string"
31	]
32	},
33	"createdAt": "2024-03-21T16:45:00Z",
34	"updatedAt": "2024-03-21T16:45:00Z"
35	}

Get Evaluation Set Run

Authentication

Path parameters

Headers

Response

Errors