Skip to content

Commit 9a3ad4c

Browse files
chore(types): improve type name for embedding models (#1730)
1 parent 4601581 commit 9a3ad4c

File tree

6 files changed

+16
-5
lines changed

6 files changed

+16
-5
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 & 1 deletion
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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
from .._resource import SyncAPIResource, AsyncAPIResource
1919
from .._response import to_streamed_response_wrapper, async_to_streamed_response_wrapper
2020
from .._base_client import make_request_options
21+
from ..types.embedding_model import EmbeddingModel
2122
from ..types.create_embedding_response import CreateEmbeddingResponse
2223

2324
__all__ = ["Embeddings", "AsyncEmbeddings"]
@@ -47,7 +48,7 @@ def create(
4748
self,
4849
*,
4950
input: Union[str, List[str], Iterable[int], Iterable[Iterable[int]]],
50-
model: Union[str, Literal["text-embedding-ada-002", "text-embedding-3-small", "text-embedding-3-large"]],
51+
model: Union[str, EmbeddingModel],
5152
dimensions: int | NotGiven = NOT_GIVEN,
5253
encoding_format: Literal["float", "base64"] | NotGiven = NOT_GIVEN,
5354
user: str | NotGiven = NOT_GIVEN,
@@ -137,7 +138,7 @@ async def create(
137138
self,
138139
*,
139140
input: Union[str, List[str], Iterable[int], Iterable[Iterable[int]]],
140-
model: Union[str, Literal["text-embedding-ada-002", "text-embedding-3-small", "text-embedding-3-large"]],
141+
model: Union[str, EmbeddingModel],
141142
dimensions: int | NotGiven = NOT_GIVEN,
142143
encoding_format: Literal["float", "base64"] | NotGiven = NOT_GIVEN,
143144
user: str | NotGiven = NOT_GIVEN,

src/openai/types/__init__.py

Lines changed: 1 addition & 0 deletions
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

Lines changed: 3 additions & 1 deletion
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
Lines changed: 7 additions & 0 deletions
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)