Skip to content

Commit 57736f9

Browse files
chore(types): improve type name for embedding models (openai#57)
1 parent 8b08683 commit 57736f9

File tree

4 files changed

+15
-19
lines changed

4 files changed

+15
-19
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: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,10 @@ Methods:
6565

6666
# Embeddings
6767

68+
Params Types:
69+
70+
- <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#EmbeddingModel">EmbeddingModel</a>
71+
6872
Response Types:
6973

7074
- <a href="https://pkg.go.dev/github.com/openai/openai-go">openai</a>.<a href="https://pkg.go.dev/github.com/openai/openai-go#CreateEmbeddingResponse">CreateEmbeddingResponse</a>

embedding.go

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,14 @@ func (r EmbeddingObject) IsKnown() bool {
156156
return false
157157
}
158158

159+
type EmbeddingModel = string
160+
161+
const (
162+
EmbeddingModelTextEmbeddingAda002 EmbeddingModel = "text-embedding-ada-002"
163+
EmbeddingModelTextEmbedding3Small EmbeddingModel = "text-embedding-3-small"
164+
EmbeddingModelTextEmbedding3Large EmbeddingModel = "text-embedding-3-large"
165+
)
166+
159167
type EmbeddingNewParams struct {
160168
// Input text to embed, encoded as a string or array of tokens. To embed multiple
161169
// inputs in a single request, pass an array of strings or array of token arrays.
@@ -170,7 +178,7 @@ type EmbeddingNewParams struct {
170178
// see all of your available models, or see our
171179
// [Model overview](https://platform.openai.com/docs/models/overview) for
172180
// descriptions of them.
173-
Model param.Field[EmbeddingNewParamsModel] `json:"model,required"`
181+
Model param.Field[EmbeddingModel] `json:"model,required"`
174182
// The number of dimensions the resulting output embeddings should have. Only
175183
// supported in `text-embedding-3` and later models.
176184
Dimensions param.Field[int64] `json:"dimensions"`
@@ -214,22 +222,6 @@ type EmbeddingNewParamsInputArrayOfTokenArrays [][]int64
214222

215223
func (r EmbeddingNewParamsInputArrayOfTokenArrays) ImplementsEmbeddingNewParamsInputUnion() {}
216224

217-
type EmbeddingNewParamsModel string
218-
219-
const (
220-
EmbeddingNewParamsModelTextEmbeddingAda002 EmbeddingNewParamsModel = "text-embedding-ada-002"
221-
EmbeddingNewParamsModelTextEmbedding3Small EmbeddingNewParamsModel = "text-embedding-3-small"
222-
EmbeddingNewParamsModelTextEmbedding3Large EmbeddingNewParamsModel = "text-embedding-3-large"
223-
)
224-
225-
func (r EmbeddingNewParamsModel) IsKnown() bool {
226-
switch r {
227-
case EmbeddingNewParamsModelTextEmbeddingAda002, EmbeddingNewParamsModelTextEmbedding3Small, EmbeddingNewParamsModelTextEmbedding3Large:
228-
return true
229-
}
230-
return false
231-
}
232-
233225
// The format to return the embeddings in. Can be either `float` or
234226
// [`base64`](https://pypi.org/project/pybase64/).
235227
type EmbeddingNewParamsEncodingFormat string

embedding_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ func TestEmbeddingNewWithOptionalParams(t *testing.T) {
2828
)
2929
_, err := client.Embeddings.New(context.TODO(), openai.EmbeddingNewParams{
3030
Input: openai.F[openai.EmbeddingNewParamsInputUnion](shared.UnionString("The quick brown fox jumped over the lazy dog")),
31-
Model: openai.F(openai.EmbeddingNewParamsModelTextEmbeddingAda002),
31+
Model: openai.F(openai.EmbeddingModelTextEmbeddingAda002),
3232
Dimensions: openai.F(int64(1)),
3333
EncodingFormat: openai.F(openai.EmbeddingNewParamsEncodingFormatFloat),
3434
User: openai.F("user-1234"),

0 commit comments

Comments
 (0)