Class Evals

constructor

• new Evals(client): Evals

• Parameters

  • client: OpenAIClient

  Returns Evals

runs

create

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

• Create the structure of an evaluation that can be used to test a model's performance. An evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources. For more information, see the Evals guide.

  Parameters

  • body: EvalCreateParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<EvalCreateResponse>

delete

• delete(evalID, options?): APIPromise<EvalDeleteResponse>

• Delete an evaluation.

  Parameters

  • evalID: string
  • Optionaloptions: RequestOptions

  Returns APIPromise<EvalDeleteResponse>

list

• list(query?, options?): PagePromise<EvalListResponsesPage, EvalListResponse>

• List evaluations for a project.

  Parameters

  • Optionalquery: null | EvalListParams
  • Optionaloptions: RequestOptions

  Returns PagePromise<EvalListResponsesPage, EvalListResponse>

retrieve

• retrieve(evalID, options?): APIPromise<EvalRetrieveResponse>

• Get an evaluation by ID.

  Parameters

  • evalID: string
  • Optionaloptions: RequestOptions

  Returns APIPromise<EvalRetrieveResponse>

update

• update(evalID, body, options?): APIPromise<EvalUpdateResponse>

• Update certain properties of an evaluation.

  Parameters

  • evalID: string
  • body: EvalUpdateParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<EvalUpdateResponse>