Create Testrecord

POST

Create a new Testrecord

Path parameters

run_idintegerRequired

The ID of the Run to create the Testrecord in.

Request

This endpoint expects an object.

testset_idintegerOptional

testcase_idintegerOptional

user_querystringOptional

The user query that was executed for the testrecord.

contextstringOptional

The context that was used while generating the testrecord.

responsestringOptional

The response generated by the model.

idealstringOptional

The ideal response.

custom_inputsmap from strings to optional strings or objectsOptional

custom_outputsmap from strings to optional strings or objectsOptional

custom_labelsmap from strings to optional strings or objectsOptional

promptstringOptional

The prompt used to generate the response.

model_paramsmap from strings to optional integers or doubles or stringsOptional

The model parameters used to generate the response.

model_debug_infomap from strings to optional integers or doubles or stringsOptional

Debug information generated by Scorecard during the execution of the testrecord.

error_messagestringOptional

The error message for the testrecord.

Response

This endpoint returns an object

idintegerOptional

created_atdatetimeOptional

The creation date and time of the testrecord.

run_idintegerOptional

The ID of the run the testrecord belongs to.

testset_idintegerOptional

The ID of the testset the testrecord belongs to.

testcase_idintegerOptional

The ID of the testcase the testrecord belongs to.

user_querystringOptional

The user query for the testrecord.

contextstringOptional

The context for the testrecord.

model_responsestringOptional

The actual response of the model for the testrecord.

idealstringOptional

The ideal response for the testrecord.

custom_inputsmap from strings to optional strings or objectsOptional

custom_labelsmap from strings to optional strings or objectsOptional

custom_outputsmap from strings to optional strings or objectsOptional

statusstringOptional

The current status of the testrecord.

promptstringOptional

The prompt used to generate the testrecord.

model_paramsmap from strings to optional integers or doubles or stringsOptional

The model parameters used when generating the testrecord.

model_debug_infomap from strings to optional integers or doubles or stringsOptional

Debug information produced during the testrecord's generation.

error_messagestringOptional

The error message for the testrecord.

Errors

Built with

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

1	{
2	"id": 1,
3	"created_at": "2024-01-15T09:30:00Z",
4	"run_id": 1,
5	"testset_id": 1,
6	"testcase_id": 1,
7	"user_query": "user_query",
8	"context": "context",
9	"model_response": "model_response",
10	"ideal": "ideal",
11	"custom_inputs": {
12	"key": "value"
13	},
14	"custom_labels": {
15	"key": "value"
16	},
17	"custom_outputs": {
18	"key": "value"
19	},
20	"status": "status",
21	"prompt": "prompt",
22	"model_params": {
23	"key": 1
24	},
25	"model_debug_info": {
26	"key": 1
27	},
28	"error_message": "error_message"
29	}