List

API Reference

Agents

Evaluation Metrics

List Evaluation Metrics

agents.evaluation_metrics.list() -> EvaluationMetricListResponse

get/v2/gen-ai/evaluation_metrics

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

ReturnsExpand Collapse

class EvaluationMetricListResponse: …

metrics: Optional[List[APIEvaluationMetric]]

description: Optional[str]

inverted: Optional[bool]

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

metric_name: Optional[str]

metric_type: Optional[Literal["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: Optional[str]

metric_value_type: Optional[Literal["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: Optional[float]

The maximum value for the metric.

formatfloat

range_min: Optional[float]

The minimum value for the metric.

formatfloat

HTTPPython

from gradient import Gradient

client = Gradient()
evaluation_metrics = client.agents.evaluation_metrics.list()
print(evaluation_metrics.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
    }
  ]
}