foundry_eval_run_cancel: Cancel an evaluation run

View source: R/evals.R

foundry_eval_run_cancelR Documentation

Cancel an evaluation run

Description

Cancel an evaluation run

Usage

foundry_eval_run_cancel(
  eval_id,
  run_id,
  api_key = NULL,
  token = NULL,
  endpoint = NULL,
  api_version = NULL
)

Arguments

eval_id

Character. Evaluation ID.

run_id

Character. Run ID to cancel.

api_key

Character. Optional API key. Falls back to configured auth.

token

Character. Optional bearer token. Falls back to configured auth.

endpoint

Character. Optional endpoint override.

api_version

Character. Optional api-version query value. The Foundry v1 evals surface is path-versioned, so this is usually left NULL.

Value

A one-row tibble describing the run after cancellation.

Examples

## Not run: 
# Requires a configured Azure endpoint and credentials, an evaluation ID,
# and a run ID that can be cancelled.
foundry_eval_run_cancel("eval_abc123", "evalrun_xyz")

## End(Not run)

foundryR documentation built on Sept. 25, 2026, 1:10 a.m.