Evaluation Test Cases

Evaluation Test Cases

Evaluation Test Cases

Create Evaluation Test Case.

post/v2/gen-ai/evaluation_test_cases

List Evaluation Test Cases

get/v2/gen-ai/evaluation_test_cases

List Evaluation Runs by Test Case

get/v2/gen-ai/evaluation_test_cases/{evaluation_test_case_uuid}/evaluation_runs

Retrieve Information About an Existing Evaluation Test Case

get/v2/gen-ai/evaluation_test_cases/{test_case_uuid}

Update an Evaluation Test Case.

put/v2/gen-ai/evaluation_test_cases/{test_case_uuid}

API Evaluation Test Case

APIEvaluationTestCaseobject

ShowShow

archived_atstring

optional

formatdate-time

created_atstring

optional

formatdate-time

created_by_user_emailstring

optional

created_by_user_idstring

optional

formatuint64

datasetobject

optional

Hide ParametersShow Parameters

created_atstring

optional

Time created at.

formatdate-time

dataset_namestring

optional

Name of the dataset.

dataset_uuidstring

optional

UUID of the dataset.

file_sizestring

optional

The size of the dataset uploaded file in bytes.

formatuint64

has_ground_truthboolean

optional

Does the dataset have a ground truth column?

row_countnumber

optional

Number of rows in the dataset.

formatint64

dataset_namestring

optional

dataset_uuidstring

optional

descriptionstring

optional

latest_version_number_of_runsnumber

optional

formatint32

metricsarray of descriptionstringinvertedbooleanmetric_namestringmetric_typeenummetric_uuidstringmetric_value_typeenumrange_maxnumberrange_minnumberAPIEvaluationMetric

optional

namestring

optional

star_metricmetric_uuidstringnamestringsuccess_thresholdnumbersuccess_threshold_pctnumberAPIStarMetric

optional

test_case_uuidstring

optional

total_runsnumber

optional

formatint32

updated_atstring

optional

formatdate-time

updated_by_user_emailstring

optional

updated_by_user_idstring

optional

formatuint64

versionnumber

optional

formatint64

API Star Metric

APIStarMetricobject

ShowShow

metric_uuidstring

optional

namestring

optional

success_thresholdnumber

optional

The success threshold for the star metric. This is a value that the metric must reach to be considered successful.

formatfloat

success_threshold_pctnumber

optional

The success threshold for the star metric. This is a percentage value between 0 and 100.

formatint32