Skip to content

Commit 4b4eb2b

Browse files
author
Stainless Bot
committed
chore(types): improve type name for embedding models (#1730)
1 parent 21b0c00 commit 4b4eb2b

File tree

6 files changed

+17
-8
lines changed

6 files changed

+17
-8
lines changed

.stats.yml

+1-1
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

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Methods:
7070
Types:
7171

7272
```python
73-
from openai.types import CreateEmbeddingResponse, Embedding
73+
from openai.types import CreateEmbeddingResponse, Embedding, EmbeddingModel
7474
```
7575

7676
Methods:

src/openai/resources/embeddings.py

+4-5
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,8 @@
1616
from .._extras import numpy as np, has_numpy
1717
from .._resource import SyncAPIResource, AsyncAPIResource
1818
from .._response import to_streamed_response_wrapper, async_to_streamed_response_wrapper
19-
from .._base_client import (
20-
make_request_options,
21-
)
19+
from .._base_client import make_request_options
20+
from ..types.embedding_model import EmbeddingModel
2221
from ..types.create_embedding_response import CreateEmbeddingResponse
2322

2423
__all__ = ["Embeddings", "AsyncEmbeddings"]
@@ -48,7 +47,7 @@ def create(
4847
self,
4948
*,
5049
input: Union[str, List[str], Iterable[int], Iterable[Iterable[int]]],
51-
model: Union[str, Literal["text-embedding-ada-002", "text-embedding-3-small", "text-embedding-3-large"]],
50+
model: Union[str, EmbeddingModel],
5251
dimensions: int | NotGiven = NOT_GIVEN,
5352
encoding_format: Literal["float", "base64"] | NotGiven = NOT_GIVEN,
5453
user: str | NotGiven = NOT_GIVEN,
@@ -160,7 +159,7 @@ async def create(
160159
self,
161160
*,
162161
input: Union[str, List[str], Iterable[int], Iterable[Iterable[int]]],
163-
model: Union[str, Literal["text-embedding-ada-002", "text-embedding-3-small", "text-embedding-3-large"]],
162+
model: Union[str, EmbeddingModel],
164163
dimensions: int | NotGiven = NOT_GIVEN,
165164
encoding_format: Literal["float", "base64"] | NotGiven = NOT_GIVEN,
166165
user: str | NotGiven = NOT_GIVEN,

src/openai/types/__init__.py

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
from .file_deleted import FileDeleted as FileDeleted
2727
from .file_purpose import FilePurpose as FilePurpose
2828
from .model_deleted import ModelDeleted as ModelDeleted
29+
from .embedding_model import EmbeddingModel as EmbeddingModel
2930
from .images_response import ImagesResponse as ImagesResponse
3031
from .completion_usage import CompletionUsage as CompletionUsage
3132
from .file_list_params import FileListParams as FileListParams

src/openai/types/embedding_create_params.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
from typing import List, Union, Iterable
66
from typing_extensions import Literal, Required, TypedDict
77

8+
from .embedding_model import EmbeddingModel
9+
810
__all__ = ["EmbeddingCreateParams"]
911

1012

@@ -20,7 +22,7 @@ class EmbeddingCreateParams(TypedDict, total=False):
2022
for counting tokens.
2123
"""
2224

23-
model: Required[Union[str, Literal["text-embedding-ada-002", "text-embedding-3-small", "text-embedding-3-large"]]]
25+
model: Required[Union[str, EmbeddingModel]]
2426
"""ID of the model to use.
2527
2628
You can use the

src/openai/types/embedding_model.py

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2+
3+
from typing_extensions import Literal, TypeAlias
4+
5+
__all__ = ["EmbeddingModel"]
6+
7+
EmbeddingModel: TypeAlias = Literal["text-embedding-ada-002", "text-embedding-3-small", "text-embedding-3-large"]

0 commit comments

Comments
 (0)