List

API Reference

Agents

Evaluation Metrics

List Evaluation Metrics

client.agents.evaluationMetrics.list(RequestOptionsoptions?): EvaluationMetricListResponse { metrics }

get/v2/gen-ai/evaluation_metrics

To list all evaluation metrics, send a GET request to /v2/gen-ai/evaluation_metrics.

ReturnsExpand Collapse

EvaluationMetricListResponse { metrics }

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

List Evaluation Metrics

typescript

• http
• typescript
• python

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const evaluationMetrics = await client.agents.evaluationMetrics.list();

console.log(evaluationMetrics.metrics);

200 example

{
  "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
    }
  ]
}

Returns Examples

200 example

{
  "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
    }
  ]
}