For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.genai.update_custom_evaluation_metric(
    metric_uuid="\"123e4567-e89b-12d3-a456-426614174000\"",
    body={
        "config": {...},
        "description": "example string",
        "metric_name": "\"My domain tone metric\"",
        ...,
    },
)

Description

To update a custom metric (issuing a new metric UUID), send a PUT request to /v2/gen-ai/custom_evaluation_metrics/{metric_uuid}.

Parameters

metric_uuid string required

UUID of the custom metric to update.

config object optional

Configuration for a custom model-evaluation metric scored by an LLM judge.
Prompt and model response are always included in the judge context.

Show child properties

created_at string optional

Example: 2023-01-01T00:00:00Z

deleted_at string optional

Example: 2023-01-01T00:00:00Z

When set, the custom metric is soft-deleted and must not appear in pickers.

requires_ground_truth boolean optional

Example: True

When true, each row must provide ground truth and it is included in the judge context.
When false, ground truth is not required and is not sent to the judge.

scoring_prompt string optional

Example: example string

Instructions for the judge model (multi-line).

updated_at string optional

Example: 2023-01-01T00:00:00Z

description string optional

Example: example string

metric_name string optional

Example: "My domain tone metric"

metric_uuid string optional

Example: "12345678-1234-1234-1234-123456789012"

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

req = {
  "config": {
    "created_at": "2023-01-01T00:00:00Z",
    "deleted_at": "2023-01-01T00:00:00Z",
    "requires_ground_truth": True,
    "scoring_prompt": "example string",
    "updated_at": "2023-01-01T00:00:00Z"
  },
  "description": "example string",
  "metric_name": "\"My domain tone metric\"",
  "metric_uuid": "\"12345678-1234-1234-1234-123456789012\""
}

resp = client.genai.update_custom_evaluation_metric(metric_uuid="\"123e4567-e89b-12d3-a456-426614174000\"", body=req)

Response Example

{
  "metric": {
    "associated_presets": [],
    "category": "METRIC_CATEGORY_UNSPECIFIED",
    "custom_eval_config": {
      "created_at": "2023-01-01T00:00:00Z",
      "deleted_at": "2023-01-01T00:00:00Z",
      "requires_ground_truth": true,
      "scoring_prompt": "example string",
      "updated_at": "2023-01-01T00:00:00Z"
    },
    "description": "example string",
    "evaluation_scope": "EVALUATION_SCOPE_UNSPECIFIED",
    "inverted": true,
    "is_metric_goal": true,
    "metric_name": "example name",
    "metric_rank": 123,
    "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,
    "source": "EVALUATION_METRIC_SOURCE_UNSPECIFIED"
  }
}

More Information

See /v2/gen-ai/custom_evaluation_metrics/{metric_uuid} in the API reference for additional detail on responses, headers, parameters, and more.