Skip to main content
GET
/
api
/
v1
/
runs
/
rules
Error
A valid request URL is required to generate request examples
[
  {
    "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": {}
        }
      }
    ],
    "code_evaluators": [
      {
        "code": "<string>",
        "language": "python"
      }
    ],
    "alerts": [
      {
        "routing_key": "<string>",
        "type": "pagerduty",
        "summary": "<string>",
        "severity": "warning"
      }
    ],
    "extend_only": false,
    "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>"
    }
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.langchain.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
dataset_id
string<uuid> | null
​
session_id
string<uuid> | null
​
type
enum<string> | null
Available options:
session,
dataset
​
name_contains
string | null
​
id
string<uuid>[] | null
​
evaluator_id
string<uuid> | null
​
tag_value_id
string<uuid>[] | null
​
include_backfill_progress
boolean
default:false

Response

Successful Response

​
id
string<uuid>
required
​
tenant_id
string<uuid>
required
​
display_name
string
required
​
sampling_rate
number
required
​
webhooks
RunRulesWebhookSchema · object[] | null
required
​
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
​
code_evaluators
CodeEvaluatorTopLevel · object[] | null
​
alerts
RunRulesPagerdutyAlertSchema · object[] | null
​
extend_only
boolean
default:false
​
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