Constructor Detail

Method Detail

• withRawResponse

   abstract EvalServiceAsync.WithRawResponse withRawResponse()

  Returns a view of this service that provides access to raw HTTP responses for each method.

• withOptions

   abstract EvalServiceAsync withOptions(Consumer<ClientOptions.Builder> modifier)

  Returns a view of this service with the given option modifications applied.

  The original service is not modified.

• runs

   abstract RunServiceAsync runs()

  Manage and run evals in the OpenAI platform.

• create

   CompletableFuture<EvalCreateResponse> create(EvalCreateParams params)

  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.

• create

   abstract CompletableFuture<EvalCreateResponse> create(EvalCreateParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<EvalRetrieveResponse> retrieve(String evalId)

  Get an evaluation by ID.

• retrieve

   CompletableFuture<EvalRetrieveResponse> retrieve(String evalId, EvalRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<EvalRetrieveResponse> retrieve(String evalId, EvalRetrieveParams params)

• retrieve

   abstract CompletableFuture<EvalRetrieveResponse> retrieve(EvalRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<EvalRetrieveResponse> retrieve(EvalRetrieveParams params)

• retrieve

   CompletableFuture<EvalRetrieveResponse> retrieve(String evalId, RequestOptions requestOptions)

• update

   CompletableFuture<EvalUpdateResponse> update(String evalId)

  Update certain properties of an evaluation.

• update

   CompletableFuture<EvalUpdateResponse> update(String evalId, EvalUpdateParams params, RequestOptions requestOptions)

• update

   CompletableFuture<EvalUpdateResponse> update(String evalId, EvalUpdateParams params)

• update

   abstract CompletableFuture<EvalUpdateResponse> update(EvalUpdateParams params, RequestOptions requestOptions)

• update

   CompletableFuture<EvalUpdateResponse> update(EvalUpdateParams params)

• update

   CompletableFuture<EvalUpdateResponse> update(String evalId, RequestOptions requestOptions)

• list

   CompletableFuture<EvalListPageAsync> list()

  List evaluations for a project.

• list

   abstract CompletableFuture<EvalListPageAsync> list(EvalListParams params, RequestOptions requestOptions)

• list

   CompletableFuture<EvalListPageAsync> list(EvalListParams params)

• list

   CompletableFuture<EvalListPageAsync> list(RequestOptions requestOptions)

• delete

   CompletableFuture<EvalDeleteResponse> delete(String evalId)

  Delete an evaluation.

• delete

   CompletableFuture<EvalDeleteResponse> delete(String evalId, EvalDeleteParams params, RequestOptions requestOptions)

• delete

   CompletableFuture<EvalDeleteResponse> delete(String evalId, EvalDeleteParams params)

• delete

   abstract CompletableFuture<EvalDeleteResponse> delete(EvalDeleteParams params, RequestOptions requestOptions)

• delete

   CompletableFuture<EvalDeleteResponse> delete(EvalDeleteParams params)

• delete

   CompletableFuture<EvalDeleteResponse> delete(String evalId, RequestOptions requestOptions)