Retrieve Testset metadata without Testcase data

Read Testset

Delete

Update Testset

Create Testset

The ID of the Testset to retrieve the schema from.

Read Testset Schema

The Testset ID to retrieve testcases from.

Read Testcases

Testset

The ID of the Testset to create the Testcase in.

Create Testcase

The ID of the Testset to retrieve the Testcase from.

Read Testcase

The ID of the Testset to delete the Testcase from.

Delete Testcase

Update Testcase

Batch Copy Testcases

The ID of the Testset from which the Testcases will be deleted.

Batch Delete Testcases

Testcase

Read Testrecord

The ID of the Run to create the Testrecord in.

Create Testrecord

Testrecord

Create Run

Read Run

Update Run Status

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

Create Score

The run ID that created the test record to be scored.

The ID of the testrecord whose score will be updated.

Update Score

Score

Read Run Metrics

Run Metric

Get Traces

The ID of the trace to retrieve spans from.

Get Trace

The ID of the trace which the span is a part of.

Get Trace Span

Tracing

Get Prompt By Name

Create a root prompt

Create a child prompt (aka Prompt Version)

Create Prompt

Get Prompt By Id

Delete Scoring Config

Update the prompt version to prod.

Update Prompt

Prompt

Create a root scoring config

Create Scoring Config

Get Scoring Config

Scoring Config

CreateGithubWorkflowParams

CreateRunParams

Custom schema model with an ordered list of custom variables.

CustomSchema

Custom variable model with name, description, role and data type.

CustomVariable

DataTypeEnum

FileUrl

Grade

The ID of the run that created the grade.

The ID of the testcase associated with the grade.

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

The ID of the metric used to compute the grade.

Indicates if a human should assign a grade.

The error message if the grade was not created successfully.

HTTPValidationError

IngestionMethod

JSONObject

The value of the JSON object, which can be a dictionary, list, string, integer, float, boolean, or None.

JsonObjectInputValue

JsonObjectOutputValue

NotFoundErrorBody

PaginatedTestcaseResponse

The URL to fetch the next page of testcases.

The URL to fetch the previous page of testcases.

The list of Testcases retrieved in this page.

The organization this resource belongs to.

PromptModelParamsValue

RoleEnum

The testset that was executed in this run.

The model parameters used when generating the run.

The ID of the scoring configuration the run uses.

The prompt template to be used while executing the run.

The start time of scoring the run's results.

The end time of scoring the run's results.

RunMetric

RunStatus

ScoreStatus

ScoringConfig

Span

TestCase

The creation date and time of the testcase.

The ID of the testset the testcase belongs to.

TestCaseCustomInputsValue

TestCaseCustomLabelsValue

TestRecordCreate

TestSetCreate

TestcaseBatchDeletionResponse

The IDs of the testcases that were deleted.

The message indicating the testcases were deleted.

TestcaseDeletionResponse

The message indicating the testcase was deleted.

The creation date and time of the testrecord.

The ID of the run the testrecord belongs to.

The ID of the testset the testrecord belongs to.

The ID of the testcase the testrecord belongs to.

The actual response of the model for the testrecord.

The prompt used to generate the testrecord.

The model parameters used when generating the testrecord.

Debug information produced during the testrecord's generation.

TestrecordCustomInputsValue

TestrecordCustomLabelsValue

TestrecordCustomOutputsValue

TestrecordModelDebugInfoValue

TestrecordModelParamsValue

The creation date and time of the testset.

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

Whether or not the testset uses retrieval.

The ID of the project the testset belongs to.

1	[
2	{
3	"id": 1,
4	"run_id": 1,
5	"metric_id": 1,
6	"created_at": "2024-01-15T09:30:00Z"
7	}
8	]

Read Run Metrics

Path parameters

Response

Errors

1	curl https://api.getscorecard.ai/v1/run_metric/1 \
2	-H "X-API-Key: <apiKey>"