evaluation_metrics
Creates, updates, deletes, gets or lists an evaluation_metrics resource.
Overview
| Name | evaluation_metrics |
| Type | Resource |
| Id | digitalocean.genai.evaluation_metrics |
Fields
The following fields are returned by SELECT queries:
- genai_list_evaluation_metrics
A successful response.
| Name | Datatype | Description |
|---|---|---|
metric_name | string | (example: example name) |
description | string | (example: example string) |
inverted | boolean | If true, the metric is inverted, meaning that a lower value is better. |
metric_type | string | (default: METRIC_TYPE_UNSPECIFIED, example: METRIC_TYPE_UNSPECIFIED) |
metric_uuid | string | (example: 123e4567-e89b-12d3-a456-426614174000) |
metric_value_type | string | (default: METRIC_VALUE_TYPE_UNSPECIFIED, example: METRIC_VALUE_TYPE_UNSPECIFIED) |
range_max | number (float) | The maximum value for the metric. |
range_min | number (float) | The minimum value for the metric. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
genai_list_evaluation_metrics | select | To list all evaluation metrics, send a GET request to /v2/gen-ai/evaluation_metrics. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|
SELECT examples
- genai_list_evaluation_metrics
To list all evaluation metrics, send a GET request to /v2/gen-ai/evaluation_metrics.
SELECT
metric_name,
description,
inverted,
metric_type,
metric_uuid,
metric_value_type,
range_max,
range_min
FROM digitalocean.genai.evaluation_metrics;