Create Score — Scorecard AI

Create a score

Path parameters

run_idintegerRequired

The ID of the run that created the testrecord to be scored.

testrecord_idintegerRequired

The ID of the testrecord to be scored.

Request

This endpoint expects an object.

metric_idintegerRequired

The ID of the metric

int_scoreintegerOptional

Specify integer scores.

binary_scorebooleanOptional

Specify boolean scores.

reasoningstringOptional

The reasoning for the assigned score.

Response

This endpoint returns an object

user_idstringOptional

idintegerOptional

The ID of the grade.

run_idintegerOptional

The ID of the run that created the grade.

testcase_idintegerOptional

The ID of the testcase associated with the grade.

testrecord_idintegerOptional

The ID of the testrecord for which the grade was created.

metric_idintegerOptional

The ID of the metric used to compute the grade.

binary_scorebooleanOptional

The binary score assigned to the grade.

int_scoreintegerOptional

The integer score assigned to the grade.

reasoningstringOptional

The reasoning for the assigned score.

human_evalbooleanOptional

Indicates if a human should assign a grade.

statusenumOptional

Allowed values: pendingerrorcompleted

The status of the grade.

error_messagestringOptional

The error message if the grade was not created successfully.

created_atdatetimeOptional

when the grade was created.

updated_atdatetimeOptional

when the grade was last updated.

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

1	{
2	"user_id": "user_id",
3	"id": 1,
4	"run_id": 1,
5	"testcase_id": 1,
6	"testrecord_id": 1,
7	"metric_id": 1,
8	"binary_score": true,
9	"int_score": 1,
10	"reasoning": "reasoning",
11	"human_eval": true,
12	"status": "pending",
13	"error_message": "error_message",
14	"created_at": "2024-01-15T09:30:00Z",
15	"updated_at": "2024-01-15T09:30:00Z"
16	}

Path parameters

Request

Response

Errors