run

List Rules

List all run rules.

get/api/v1/runs/rules

Query parameters

dataset_idstring uuid nullable
session_idstring uuid nullable
type'session' | 'dataset' nullable
name_containsstring nullable
idstring[] nullable
evaluator_idstring uuid nullable
tag_value_idstring[] nullable
include_backfill_progressboolean

Response

Successful Response

idstring uuid required
tenant_idstring uuid required
is_enabledboolean
session_idstring uuid nullable
session_namestring nullable
dataset_idstring uuid nullable
dataset_namestring nullable
display_namestring required
sampling_ratenumber required
filterstring nullable
trace_filterstring nullable
tree_filterstring nullable
add_to_annotation_queue_idstring uuid nullable
add_to_annotation_queue_namestring nullable
add_to_dataset_idstring uuid nullable
add_to_dataset_namestring nullable
add_to_dataset_prefer_correctionboolean
corrections_dataset_idstring uuid nullable
use_corrections_datasetboolean
num_few_shot_examplesinteger nullable
extend_onlyboolean
include_extended_statsboolean
created_atstring date-time required
updated_atstring date-time required
backfill_fromstring date-time nullable
backfill_idstring uuid nullable
backfill_statusstring nullable
backfill_progressnumber nullable
backfill_errorstring nullable
backfill_completed_atstring date-time nullable
transientboolean
evaluator_versioninteger required
evaluator_idstring uuid nullable
alignment_annotation_queue_idstring uuid nullable
group_by'thread_id' nullable

Changes

Changed in 5 of the 48 revisions of this API.69

    • added the optional property items/spend_limit to the response with the 200 status

      response-optional-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional query request parameter tag_value_id

      new-optional-request-parameter

    • added the optional property items/backfill_id to the response with the 200 status

      response-optional-property-added

    • deleted the query request parameter evaluator_id

      request-parameter-removed

    • deleted the query request parameter include_backfill_progress

      request-parameter-removed

    • removed the optional property items/backfill_completed_at from the response with the 200 status

      response-optional-property-removed

    • removed the optional property items/backfill_error from the response with the 200 status

      response-optional-property-removed

    • removed the optional property items/backfill_progress from the response with the 200 status

      response-optional-property-removed

    • removed the optional property items/backfill_status from the response with the 200 status

      response-optional-property-removed

    This revision also has 25 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional query request parameter include_backfill_progress

      new-optional-request-parameter

    • added the optional property items/backfill_completed_at to the response with the 200 status

      response-optional-property-added

    • added the optional property items/backfill_error to the response with the 200 status

      response-optional-property-added

    • added the optional property items/backfill_progress to the response with the 200 status

      response-optional-property-added

    • added the optional property items/backfill_status to the response with the 200 status

      response-optional-property-added

    • added the new optional query request parameter evaluator_id

      new-optional-request-parameter