Class Runs

constructor

• new Runs(client): OpenAIClient.Evals.Runs

• Parameters

  • client: OpenAI

  Returns OpenAIClient.Evals.Runs

outputItems

cancel

• cancel(evalId, runId, options?): APIPromise<RunCancelResponse>

• Cancel an ongoing evaluation run.

  Parameters

  • evalId: string
  • runId: string
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<RunCancelResponse>

create

• create(evalId, body, options?): APIPromise<RunCreateResponse>

• Create a new evaluation run. This is the endpoint that will kick off grading.

  Parameters

  • evalId: string
  • body: OpenAIClient.Evals.Runs.RunCreateParams
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<RunCreateResponse>

del

• del(evalId, runId, options?): APIPromise<RunDeleteResponse>

• Delete an eval run.

  Parameters

  • evalId: string
  • runId: string
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<RunDeleteResponse>

list

• list(evalId, query?, options?): PagePromise<RunListResponsesPage, RunListResponse>

• Get a list of runs for an evaluation.

  Parameters

  • evalId: string
  • Optionalquery: OpenAIClient.Evals.Runs.RunListParams
  • Optionaloptions: RequestOptions<unknown>

  Returns PagePromise<RunListResponsesPage, RunListResponse>
• list(evalId, options?): PagePromise<RunListResponsesPage, RunListResponse>

• Parameters

  • evalId: string
  • Optionaloptions: RequestOptions<unknown>

  Returns PagePromise<RunListResponsesPage, RunListResponse>

retrieve

• retrieve(evalId, runId, options?): APIPromise<RunRetrieveResponse>

• Get an evaluation run by ID.

  Parameters

  • evalId: string
  • runId: string
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<RunRetrieveResponse>