Skip to content

Commit ee917e3

Browse files
feat(api): Add evalapi to sdk (#1456)
Adding the evalsapi to the sdk.
1 parent ecabce2 commit ee917e3

File tree

21 files changed

+3377
-4
lines changed

21 files changed

+3377
-4
lines changed

.stats.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
configured_endpoints: 82
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-4bce8217a697c729ac98046d4caf2c9e826b54c427fb0ab4f98e549a2e0ce31c.yml
3-
openapi_spec_hash: 7996d2c34cc44fe2ce9ffe93c0ab774e
4-
config_hash: bcd2cacdcb9fae9938f273cd167f613c
1+
configured_endpoints: 97
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-472fe3036ea745365257fe870c0330917fb3153705c2826f49873cd631319b0a.yml
3+
openapi_spec_hash: ea86343b5e9858a74e85da8ab2c532f6
4+
config_hash: ef19d36c307306f14f2e1cd5c834a151

api.md

+72
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,22 @@ Methods:
235235

236236
- <code title="get /fine_tuning/jobs/{fine_tuning_job_id}/checkpoints">client.fineTuning.jobs.checkpoints.<a href="./src/resources/fine-tuning/jobs/checkpoints.ts">list</a>(fineTuningJobId, { ...params }) -> FineTuningJobCheckpointsPage</code>
237237

238+
## Checkpoints
239+
240+
### Permissions
241+
242+
Types:
243+
244+
- <code><a href="./src/resources/fine-tuning/checkpoints/permissions.ts">PermissionCreateResponse</a></code>
245+
- <code><a href="./src/resources/fine-tuning/checkpoints/permissions.ts">PermissionRetrieveResponse</a></code>
246+
- <code><a href="./src/resources/fine-tuning/checkpoints/permissions.ts">PermissionDeleteResponse</a></code>
247+
248+
Methods:
249+
250+
- <code title="post /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions">client.fineTuning.checkpoints.permissions.<a href="./src/resources/fine-tuning/checkpoints/permissions.ts">create</a>(fineTunedModelCheckpoint, { ...params }) -> PermissionCreateResponsesPage</code>
251+
- <code title="get /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions">client.fineTuning.checkpoints.permissions.<a href="./src/resources/fine-tuning/checkpoints/permissions.ts">retrieve</a>(fineTunedModelCheckpoint, { ...params }) -> PermissionRetrieveResponse</code>
252+
- <code title="delete /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions">client.fineTuning.checkpoints.permissions.<a href="./src/resources/fine-tuning/checkpoints/permissions.ts">del</a>(fineTunedModelCheckpoint) -> PermissionDeleteResponse</code>
253+
238254
# VectorStores
239255

240256
Types:
@@ -643,3 +659,59 @@ Types:
643659
Methods:
644660

645661
- <code title="get /responses/{response_id}/input_items">client.responses.inputItems.<a href="./src/resources/responses/input-items.ts">list</a>(responseId, { ...params }) -> ResponseItemsPage</code>
662+
663+
# Evals
664+
665+
Types:
666+
667+
- <code><a href="./src/resources/evals/evals.ts">EvalCustomDataSourceConfig</a></code>
668+
- <code><a href="./src/resources/evals/evals.ts">EvalLabelModelGrader</a></code>
669+
- <code><a href="./src/resources/evals/evals.ts">EvalStoredCompletionsDataSourceConfig</a></code>
670+
- <code><a href="./src/resources/evals/evals.ts">EvalStringCheckGrader</a></code>
671+
- <code><a href="./src/resources/evals/evals.ts">EvalTextSimilarityGrader</a></code>
672+
- <code><a href="./src/resources/evals/evals.ts">EvalCreateResponse</a></code>
673+
- <code><a href="./src/resources/evals/evals.ts">EvalRetrieveResponse</a></code>
674+
- <code><a href="./src/resources/evals/evals.ts">EvalUpdateResponse</a></code>
675+
- <code><a href="./src/resources/evals/evals.ts">EvalListResponse</a></code>
676+
- <code><a href="./src/resources/evals/evals.ts">EvalDeleteResponse</a></code>
677+
678+
Methods:
679+
680+
- <code title="post /evals">client.evals.<a href="./src/resources/evals/evals.ts">create</a>({ ...params }) -> EvalCreateResponse</code>
681+
- <code title="get /evals/{eval_id}">client.evals.<a href="./src/resources/evals/evals.ts">retrieve</a>(evalId) -> EvalRetrieveResponse</code>
682+
- <code title="post /evals/{eval_id}">client.evals.<a href="./src/resources/evals/evals.ts">update</a>(evalId, { ...params }) -> EvalUpdateResponse</code>
683+
- <code title="get /evals">client.evals.<a href="./src/resources/evals/evals.ts">list</a>({ ...params }) -> EvalListResponsesPage</code>
684+
- <code title="delete /evals/{eval_id}">client.evals.<a href="./src/resources/evals/evals.ts">del</a>(evalId) -> EvalDeleteResponse</code>
685+
686+
## Runs
687+
688+
Types:
689+
690+
- <code><a href="./src/resources/evals/runs/runs.ts">CreateEvalCompletionsRunDataSource</a></code>
691+
- <code><a href="./src/resources/evals/runs/runs.ts">CreateEvalJSONLRunDataSource</a></code>
692+
- <code><a href="./src/resources/evals/runs/runs.ts">EvalAPIError</a></code>
693+
- <code><a href="./src/resources/evals/runs/runs.ts">RunCreateResponse</a></code>
694+
- <code><a href="./src/resources/evals/runs/runs.ts">RunRetrieveResponse</a></code>
695+
- <code><a href="./src/resources/evals/runs/runs.ts">RunListResponse</a></code>
696+
- <code><a href="./src/resources/evals/runs/runs.ts">RunDeleteResponse</a></code>
697+
- <code><a href="./src/resources/evals/runs/runs.ts">RunCancelResponse</a></code>
698+
699+
Methods:
700+
701+
- <code title="post /evals/{eval_id}/runs">client.evals.runs.<a href="./src/resources/evals/runs/runs.ts">create</a>(evalId, { ...params }) -> RunCreateResponse</code>
702+
- <code title="get /evals/{eval_id}/runs/{run_id}">client.evals.runs.<a href="./src/resources/evals/runs/runs.ts">retrieve</a>(evalId, runId) -> RunRetrieveResponse</code>
703+
- <code title="get /evals/{eval_id}/runs">client.evals.runs.<a href="./src/resources/evals/runs/runs.ts">list</a>(evalId, { ...params }) -> RunListResponsesPage</code>
704+
- <code title="delete /evals/{eval_id}/runs/{run_id}">client.evals.runs.<a href="./src/resources/evals/runs/runs.ts">del</a>(evalId, runId) -> RunDeleteResponse</code>
705+
- <code title="post /evals/{eval_id}/runs/{run_id}">client.evals.runs.<a href="./src/resources/evals/runs/runs.ts">cancel</a>(evalId, runId) -> RunCancelResponse</code>
706+
707+
### OutputItems
708+
709+
Types:
710+
711+
- <code><a href="./src/resources/evals/runs/output-items.ts">OutputItemRetrieveResponse</a></code>
712+
- <code><a href="./src/resources/evals/runs/output-items.ts">OutputItemListResponse</a></code>
713+
714+
Methods:
715+
716+
- <code title="get /evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}">client.evals.runs.outputItems.<a href="./src/resources/evals/runs/output-items.ts">retrieve</a>(evalId, runId, outputItemId) -> OutputItemRetrieveResponse</code>
717+
- <code title="get /evals/{eval_id}/runs/{run_id}/output_items">client.evals.runs.outputItems.<a href="./src/resources/evals/runs/output-items.ts">list</a>(evalId, runId, { ...params }) -> OutputItemListResponsesPage</code>

src/index.ts

+38
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,23 @@ import {
6666
import { Audio, AudioModel, AudioResponseFormat } from './resources/audio/audio';
6767
import { Beta } from './resources/beta/beta';
6868
import { Chat } from './resources/chat/chat';
69+
import {
70+
EvalCreateParams,
71+
EvalCreateResponse,
72+
EvalCustomDataSourceConfig,
73+
EvalDeleteResponse,
74+
EvalLabelModelGrader,
75+
EvalListParams,
76+
EvalListResponse,
77+
EvalListResponsesPage,
78+
EvalRetrieveResponse,
79+
EvalStoredCompletionsDataSourceConfig,
80+
EvalStringCheckGrader,
81+
EvalTextSimilarityGrader,
82+
EvalUpdateParams,
83+
EvalUpdateResponse,
84+
Evals,
85+
} from './resources/evals/evals';
6986
import { FineTuning } from './resources/fine-tuning/fine-tuning';
7087
import { Responses } from './resources/responses/responses';
7188
import {
@@ -293,6 +310,7 @@ export class OpenAI extends Core.APIClient {
293310
batches: API.Batches = new API.Batches(this);
294311
uploads: API.Uploads = new API.Uploads(this);
295312
responses: API.Responses = new API.Responses(this);
313+
evals: API.Evals = new API.Evals(this);
296314

297315
protected override defaultQuery(): Core.DefaultQuery | undefined {
298316
return this._options.defaultQuery;
@@ -356,6 +374,8 @@ OpenAI.Batches = Batches;
356374
OpenAI.BatchesPage = BatchesPage;
357375
OpenAI.Uploads = UploadsAPIUploads;
358376
OpenAI.Responses = Responses;
377+
OpenAI.Evals = Evals;
378+
OpenAI.EvalListResponsesPage = EvalListResponsesPage;
359379
export declare namespace OpenAI {
360380
export type RequestOptions = Core.RequestOptions;
361381

@@ -508,6 +528,24 @@ export declare namespace OpenAI {
508528

509529
export { Responses as Responses };
510530

531+
export {
532+
Evals as Evals,
533+
type EvalCustomDataSourceConfig as EvalCustomDataSourceConfig,
534+
type EvalLabelModelGrader as EvalLabelModelGrader,
535+
type EvalStoredCompletionsDataSourceConfig as EvalStoredCompletionsDataSourceConfig,
536+
type EvalStringCheckGrader as EvalStringCheckGrader,
537+
type EvalTextSimilarityGrader as EvalTextSimilarityGrader,
538+
type EvalCreateResponse as EvalCreateResponse,
539+
type EvalRetrieveResponse as EvalRetrieveResponse,
540+
type EvalUpdateResponse as EvalUpdateResponse,
541+
type EvalListResponse as EvalListResponse,
542+
type EvalDeleteResponse as EvalDeleteResponse,
543+
EvalListResponsesPage as EvalListResponsesPage,
544+
type EvalCreateParams as EvalCreateParams,
545+
type EvalUpdateParams as EvalUpdateParams,
546+
type EvalListParams as EvalListParams,
547+
};
548+
511549
export type AllModels = API.AllModels;
512550
export type ChatModel = API.ChatModel;
513551
export type ComparisonFilter = API.ComparisonFilter;

src/resources/evals.ts

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2+
3+
export * from './evals/index';

0 commit comments

Comments
 (0)