Update Rule

Update a run rule.

PATCH /api/v1/runs/rules/{rule_id}

Error

A valid request URL is required to generate request examples

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "display_name": "<string>",
  "sampling_rate": 123,
  "webhooks": [
    {
      "url": "<string>",
      "headers": {}
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "evaluator_version": 123,
  "is_enabled": true,
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "session_name": "<string>",
  "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dataset_name": "<string>",
  "filter": "<string>",
  "trace_filter": "<string>",
  "tree_filter": "<string>",
  "add_to_annotation_queue_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "add_to_annotation_queue_name": "<string>",
  "add_to_dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "add_to_dataset_name": "<string>",
  "add_to_dataset_prefer_correction": false,
  "corrections_dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "use_corrections_dataset": false,
  "num_few_shot_examples": 123,
  "evaluators": [
    {
      "structured": {
        "hub_ref": "<string>",
        "prompt": [
          [
            "<string>",
            "<string>"
          ]
        ],
        "template_format": "<string>",
        "schema": {},
        "variable_mapping": {},
        "model": {},
        "playground_settings_id": "<string>"
      }
    }
  ],
  "code_evaluators": [
    {
      "code": "<string>",
      "language": "python"
    }
  ],
  "alerts": [
    {
      "routing_key": "<string>",
      "type": "pagerduty",
      "summary": "<string>",
      "severity": "warning"
    }
  ],
  "extend_only": false,
  "is_managed_evaluator": false,
  "is_tracing_disabled": false,
  "extend_evaluator_trace_retention": true,
  "extend_dataset_trace_retention": true,
  "extend_annotation_queue_trace_retention": true,
  "extend_webhook_trace_retention": true,
  "include_extended_stats": false,
  "backfill_from": "2023-11-07T05:31:56Z",
  "backfill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "backfill_status": "<string>",
  "backfill_progress": 123,
  "backfill_error": "<string>",
  "backfill_completed_at": "2023-11-07T05:31:56Z",
  "transient": false,
  "evaluator_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "alignment_annotation_queue_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "group_by": "<string>",
  "spend_limit": {
    "limit_usd": "<string>",
    "window": "weekly"
  },
  "trace_count": 123,
  "spend_usd": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Path Parameters

rule_id · string<uuid> · required

Body

application/json

display_name · string · required

sampling_rate · number · required

session_id · string<uuid> | null

is_enabled · boolean · default: true

dataset_id · string<uuid> | null

filter · string | null

trace_filter · string | null

tree_filter · string | null

backfill_from · string<date-time> | null

use_corrections_dataset · boolean · default: false

num_few_shot_examples · integer | null

extend_only · boolean · default: false

is_tracing_disabled · boolean | null

extend_evaluator_trace_retention · boolean | null

extend_dataset_trace_retention · boolean | null

extend_annotation_queue_trace_retention · boolean | null

extend_webhook_trace_retention · boolean | null

transient · boolean · default: false

add_to_annotation_queue_id · string<uuid> | null

add_to_dataset_id · string<uuid> | null

add_to_dataset_prefer_correction · boolean · default: false

evaluators · EvaluatorTopLevel · object[] | null

Show child attributes

code_evaluators · CodeEvaluatorTopLevel · object[] | null

Show child attributes

evaluator_id · string<uuid> | null

alerts · RunRulesPagerdutyAlertSchema · object[] | null

Show child attributes

webhooks · RunRulesWebhookSchema · object[] | null

Show child attributes

evaluator_version · integer | null

create_alignment_queue · boolean · default: false

include_extended_stats · boolean · default: false

group_by · string | null

Allowed value: "thread_id"

spend_limit · RunRuleSpendLimitSchema · object | null

Show child attributes

Response

200

application/json

Successful Response

Run rules schema.

id · string<uuid> · required

tenant_id · string<uuid> · required

display_name · string · required

sampling_rate · number · required

webhooks · RunRulesWebhookSchema · object[] | null · required

Show child attributes

created_at · string<date-time> · required

updated_at · string<date-time> · required

evaluator_version · integer · required

is_enabled · boolean · default: true

session_id · string<uuid> | null

session_name · string | null

dataset_id · string<uuid> | null

dataset_name · string | null

filter · string | null

trace_filter · string | null

tree_filter · string | null

add_to_annotation_queue_id · string<uuid> | null

add_to_annotation_queue_name · string | null

add_to_dataset_id · string<uuid> | null

add_to_dataset_name · string | null

add_to_dataset_prefer_correction · boolean · default: false

corrections_dataset_id · string<uuid> | null

use_corrections_dataset · boolean · default: false

num_few_shot_examples · integer | null

evaluators · EvaluatorTopLevel · object[] | null

Show child attributes

code_evaluators · CodeEvaluatorTopLevel · object[] | null

Show child attributes

alerts · RunRulesPagerdutyAlertSchema · object[] | null

Show child attributes

extend_only · boolean · default: false

is_managed_evaluator · boolean · default: false

is_tracing_disabled · boolean · default: false

extend_evaluator_trace_retention · boolean | null

extend_dataset_trace_retention · boolean | null

extend_annotation_queue_trace_retention · boolean | null

extend_webhook_trace_retention · boolean | null

include_extended_stats · boolean · default: false

backfill_from · string<date-time> | null

backfill_id · string<uuid> | null

backfill_status · string | null

backfill_progress · number | null

backfill_error · string | null

backfill_completed_at · string<date-time> | null

transient · boolean · default: false

evaluator_id · string<uuid> | null

alignment_annotation_queue_id · string<uuid> | null

group_by · string | null

Allowed value: "thread_id"

spend_limit · RunRuleSpendLimitSchema · object | null

Show child attributes

trace_count · integer | null

spend_usd · number | null