run

Update Rule

Update a run rule.

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

Path parameters

rule_idstring uuid required

Request body

display_namestring required
session_idstring uuid nullable
is_enabledboolean
dataset_idstring uuid nullable
sampling_ratenumber required
filterstring nullable
trace_filterstring nullable
tree_filterstring nullable
backfill_fromstring date-time nullable
use_corrections_datasetboolean
num_few_shot_examplesinteger nullable
extend_onlyboolean
transientboolean
add_to_annotation_queue_idstring uuid nullable
add_to_dataset_idstring uuid nullable
add_to_dataset_prefer_correctionboolean
evaluator_idstring uuid nullable
evaluator_versioninteger nullable
create_alignment_queueboolean
include_extended_statsboolean
group_by'thread_id' nullable

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.149

  • a0acb3a6a10113See the full diff
    • removed RunRuleSpendLimitSchema from the spend_limit request property anyOf list

      request-property-any-of-removed

    • added the new optional request property group_by

      new-optional-request-property

    • added RunRuleSpendLimitSchema-Input to the spend_limit request property anyOf list

      request-property-any-of-added

    • added the optional property 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 request property spend_limit

      new-optional-request-property

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

      response-optional-property-added

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

      response-optional-property-removed

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

      response-optional-property-removed

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

      response-optional-property-removed

    • removed the optional property 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 optional property backfill_completed_at to the response with the 200 status

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added