Skip to content

Commit 8b96244

Browse files
chore(types): improve type name for embedding models (#1089)
1 parent e5b3d50 commit 8b96244

File tree

5 files changed

+14
-3
lines changed

5 files changed

+14
-3
lines changed

.stats.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
configured_endpoints: 68
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-ff407aa10917e62f2b0c12d1ad2c4f1258ed083bd45753c70eaaf5b1cf8356ae.yml
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-de1981b64ac229493473670d618500c6362c195f1057eb7de00bd1bc9184fbd5.yml

api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ Types:
6464

6565
- <code><a href="./src/resources/embeddings.ts">CreateEmbeddingResponse</a></code>
6666
- <code><a href="./src/resources/embeddings.ts">Embedding</a></code>
67+
- <code><a href="./src/resources/embeddings.ts">EmbeddingModel</a></code>
6768

6869
Methods:
6970

src/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,7 @@ export namespace OpenAI {
276276
export import Embeddings = API.Embeddings;
277277
export import CreateEmbeddingResponse = API.CreateEmbeddingResponse;
278278
export import Embedding = API.Embedding;
279+
export import EmbeddingModel = API.EmbeddingModel;
279280
export import EmbeddingCreateParams = API.EmbeddingCreateParams;
280281

281282
export import Files = API.Files;

src/resources/embeddings.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ export interface Embedding {
7777
object: 'embedding';
7878
}
7979

80+
export type EmbeddingModel = 'text-embedding-ada-002' | 'text-embedding-3-small' | 'text-embedding-3-large';
81+
8082
export interface EmbeddingCreateParams {
8183
/**
8284
* Input text to embed, encoded as a string or array of tokens. To embed multiple
@@ -96,7 +98,7 @@ export interface EmbeddingCreateParams {
9698
* [Model overview](https://platform.openai.com/docs/models/overview) for
9799
* descriptions of them.
98100
*/
99-
model: (string & {}) | 'text-embedding-ada-002' | 'text-embedding-3-small' | 'text-embedding-3-large';
101+
model: (string & {}) | EmbeddingModel;
100102

101103
/**
102104
* The number of dimensions the resulting output embeddings should have. Only
@@ -121,5 +123,6 @@ export interface EmbeddingCreateParams {
121123
export namespace Embeddings {
122124
export import CreateEmbeddingResponse = EmbeddingsAPI.CreateEmbeddingResponse;
123125
export import Embedding = EmbeddingsAPI.Embedding;
126+
export import EmbeddingModel = EmbeddingsAPI.EmbeddingModel;
124127
export import EmbeddingCreateParams = EmbeddingsAPI.EmbeddingCreateParams;
125128
}

src/resources/index.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,13 @@ export {
2222
CompletionCreateParamsStreaming,
2323
Completions,
2424
} from './completions';
25-
export { CreateEmbeddingResponse, Embedding, EmbeddingCreateParams, Embeddings } from './embeddings';
25+
export {
26+
CreateEmbeddingResponse,
27+
Embedding,
28+
EmbeddingModel,
29+
EmbeddingCreateParams,
30+
Embeddings,
31+
} from './embeddings';
2632
export {
2733
FileContent,
2834
FileDeleted,

0 commit comments

Comments
 (0)