Create Testset — Scorecard AI

Create a new Testset

This endpoint expects an object.

namestringRequired

descriptionstringOptional

A description for the testset.

using_retrievalbooleanOptional

Whether or not the testset uses retrieval.

custom_schemaobjectOptional

Custom schema model with an ordered list of custom variables.

project_idintegerOptional

The ID of the project to create the testset in. Omitting this optional argument will create the testset inside your Organization's default project.

ingestion_method"csv" or "logging"Optional

Allowed values: csvlogging

The method of ingestion for the testset.

publishedbooleanOptional

Whether or not the testset is published.

This endpoint returns an object

idintegerOptional

The ID of the testset.

created_atdatetimeOptional

The creation date and time of the testset.

namestringOptional

A human-readable name for the testset. This will be displayed in the UI.

descriptionstringOptional

A description for the testset.

using_retrievalbooleanOptional

Whether or not the testset uses retrieval.

ingestion_methodstringOptional

The method used to ingest the testset.

num_testcasesintegerOptional

The number of testcases in the testset.

publishedbooleanOptional

Whether or not the testset is published.

updated_atdatetimeOptional

The last time the testset was updated.

is_archivedbooleanOptional

Whether or not the testset is archived.

project_idintegerOptional

The ID of the project the testset belongs to.

custom_schemaobjectOptional

Custom schema model with an ordered list of custom variables.

1	curl -X POST https://api.getscorecard.ai/v1/testset \
2	-H "X-API-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "name"
6	}'

1	{
2	"id": 1,
3	"created_at": "2024-01-15T09:30:00Z",
4	"name": "name",
5	"description": "description",
6	"using_retrieval": true,
7	"ingestion_method": "ingestion_method",
8	"num_testcases": 1,
9	"published": true,
10	"updated_at": "2024-01-15T09:30:00Z",
11	"is_archived": true,
12	"project_id": 1,
13	"custom_schema": {
14	"variables": [
15	{
16	"name": "name",
17	"role": "input",
18	"data_type": "text"
19	}
20	]
21	}
22	}