Class Runs

constructor

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

• Parameters

  • client: OpenAIClient

  Returns OpenAIClient.Evals.Runs

outputItems

cancel

• cancel(runID, params, options?): APIPromise<RunCancelResponse>

• Cancel an ongoing evaluation run.

  Parameters

  • runID: string
  • params: OpenAIClient.Evals.Runs.RunCancelParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<RunCancelResponse>

create

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

• Kicks off a new run for a given evaluation, specifying the data source, and what model configuration to use to test. The datasource will be validated against the schema specified in the config of the evaluation.

  Parameters

  • evalID: string
  • body: OpenAIClient.Evals.Runs.RunCreateParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<RunCreateResponse>

delete

• delete(runID, params, options?): APIPromise<RunDeleteResponse>

• Delete an eval run.

  Parameters

  • runID: string
  • params: RunDeleteParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<RunDeleteResponse>

list

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

• Get a list of runs for an evaluation.

  Parameters

  • evalID: string
  • Optionalquery: null | OpenAIClient.Evals.Runs.RunListParams
  • Optionaloptions: RequestOptions

  Returns PagePromise<RunListResponsesPage, RunListResponse>

retrieve

• retrieve(runID, params, options?): APIPromise<RunRetrieveResponse>

• Get an evaluation run by ID.

  Parameters

  • runID: string
  • params: OpenAIClient.Evals.Runs.RunRetrieveParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<RunRetrieveResponse>