Retrieve

Retrieve Information About an Existing Evaluation Test Case

client.agents.evaluationTestCases.retrieve(, ?, ?): EvaluationTestCaseRetrieveResponse { evaluation_test_case }

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

To retrive information about an existing evaluation test case, send a GET request to /v2/gen-ai/evaluation_test_case/{test_case_uuid}.

ParametersExpand Collapse

testCaseUuid: string

query: EvaluationTestCaseRetrieveParams { evaluation_test_case_version }

evaluation_test_case_version?: number

Version of the test case.

ReturnsExpand Collapse

EvaluationTestCaseRetrieveResponse { evaluation_test_case }

evaluation_test_case?: APIEvaluationTestCase { archived_at, created_at, created_by_user_email, 15 more }

archived_at?: string

created_at?: string

created_by_user_email?: string

created_by_user_id?: string

dataset?: Dataset { created_at, dataset_name, dataset_uuid, 3 more }

created_at?: string

Time created at.

formatdate-time

dataset_name?: string

Name of the dataset.

dataset_uuid?: string

UUID of the dataset.

file_size?: string

The size of the dataset uploaded file in bytes.

formatuint64

has_ground_truth?: boolean

Does the dataset have a ground truth column?

row_count?: number

Number of rows in the dataset.

formatint64

dataset_name?: string

dataset_uuid?: string

description?: string

latest_version_number_of_runs?: number

metrics?: Array<APIEvaluationMetric { description, inverted, metric_name, 5 more } >

description?: string

inverted?: boolean

If true, the metric is inverted, meaning that a lower value is better.

metric_name?: string

metric_type?: "METRIC_TYPE_UNSPECIFIED" | "METRIC_TYPE_GENERAL_QUALITY" | "METRIC_TYPE_RAG_AND_TOOL"

Accepts one of the following:

"METRIC_TYPE_UNSPECIFIED"

"METRIC_TYPE_GENERAL_QUALITY"

"METRIC_TYPE_RAG_AND_TOOL"

metric_uuid?: string

metric_value_type?: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"

Accepts one of the following:

"METRIC_VALUE_TYPE_UNSPECIFIED"

"METRIC_VALUE_TYPE_NUMBER"

"METRIC_VALUE_TYPE_STRING"

"METRIC_VALUE_TYPE_PERCENTAGE"

range_max?: number

The maximum value for the metric.

formatfloat

range_min?: number

The minimum value for the metric.

formatfloat

name?: string

star_metric?: APIStarMetric { metric_uuid, name, success_threshold, success_threshold_pct }

metric_uuid?: string

name?: string

success_threshold?: number

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

formatfloat

success_threshold_pct?: number

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

formatint32

test_case_uuid?: string

total_runs?: number

updated_at?: string

updated_by_user_email?: string

updated_by_user_id?: string

version?: number

Retrieve Information About an Existing Evaluation Test Case

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const evaluationTestCase = await client.agents.evaluationTestCases.retrieve(
  '"123e4567-e89b-12d3-a456-426614174000"',
);

console.log(evaluationTestCase.evaluation_test_case);

{
  "evaluation_test_case": {
    "archived_at": "2023-01-01T00:00:00Z",
    "created_at": "2023-01-01T00:00:00Z",
    "created_by_user_email": "[email protected]",
    "created_by_user_id": "12345",
    "dataset": {
      "created_at": "2023-01-01T00:00:00Z",
      "dataset_name": "example name",
      "dataset_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "file_size": "12345",
      "has_ground_truth": true,
      "row_count": 123
    },
    "dataset_name": "example name",
    "dataset_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "description": "example string",
    "latest_version_number_of_runs": 123,
    "metrics": [
      {
        "description": "example string",
        "inverted": true,
        "metric_name": "example name",
        "metric_type": "METRIC_TYPE_UNSPECIFIED",
        "metric_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "metric_value_type": "METRIC_VALUE_TYPE_UNSPECIFIED",
        "range_max": 123,
        "range_min": 123
      }
    ],
    "name": "example name",
    "star_metric": {
      "metric_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "name": "example name",
      "success_threshold": 123,
      "success_threshold_pct": 123
    },
    "test_case_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "total_runs": 123,
    "updated_at": "2023-01-01T00:00:00Z",
    "updated_by_user_email": "[email protected]",
    "updated_by_user_id": "12345",
    "version": 123
  }
}

Returns Examples

{
  "evaluation_test_case": {
    "archived_at": "2023-01-01T00:00:00Z",
    "created_at": "2023-01-01T00:00:00Z",
    "created_by_user_email": "[email protected]",
    "created_by_user_id": "12345",
    "dataset": {
      "created_at": "2023-01-01T00:00:00Z",
      "dataset_name": "example name",
      "dataset_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "file_size": "12345",
      "has_ground_truth": true,
      "row_count": 123
    },
    "dataset_name": "example name",
    "dataset_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "description": "example string",
    "latest_version_number_of_runs": 123,
    "metrics": [
      {
        "description": "example string",
        "inverted": true,
        "metric_name": "example name",
        "metric_type": "METRIC_TYPE_UNSPECIFIED",
        "metric_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "metric_value_type": "METRIC_VALUE_TYPE_UNSPECIFIED",
        "range_max": 123,
        "range_min": 123
      }
    ],
    "name": "example name",
    "star_metric": {
      "metric_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "name": "example name",
      "success_threshold": 123,
      "success_threshold_pct": 123
    },
    "test_case_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "total_runs": 123,
    "updated_at": "2023-01-01T00:00:00Z",
    "updated_by_user_email": "[email protected]",
    "updated_by_user_id": "12345",
    "version": 123
  }
}