run

List Rules

Changed on

List all run rules.

get/api/v1/runs/rules

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/runs/rules
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer

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
is_managed_evaluatorboolean
is_tracing_disabledboolean
extend_evaluator_trace_retentionboolean nullable
extend_dataset_trace_retentionboolean nullable
extend_annotation_queue_trace_retentionboolean nullable
extend_webhook_trace_retentionboolean nullable
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
evaluator_namestring nullable
evaluator_typestring nullable
alignment_annotation_queue_idstring uuid nullable
group_by'thread_id' | 'trajectory_id' nullable
trace_countinteger nullable
spend_usdnumber nullable

Changes

  • 4e648664140aRevision changes
    • info

      added the optional property / to the response with the status

  • ec156df8da3aRevision changes
    • warning

      added the new trajectory enum value to the ///// response property for the response status