Skip to content

Commit

Permalink
chore(types): improve type name for embedding models (#57)
Browse files Browse the repository at this point in the history
  • Loading branch information
stainless-app[bot] committed Sep 20, 2024
1 parent 8b08683 commit 57736f9
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 19 deletions.
2 changes: 1 addition & 1 deletion .stats.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
configured_endpoints: 68
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-ff407aa10917e62f2b0c12d1ad2c4f1258ed083bd45753c70eaaf5b1cf8356ae.yml
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-de1981b64ac229493473670d618500c6362c195f1057eb7de00bd1bc9184fbd5.yml
4 changes: 4 additions & 0 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ Methods:

# Embeddings

Params Types:

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

Response Types:

- <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>
Expand Down
26 changes: 9 additions & 17 deletions embedding.go
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,14 @@ func (r EmbeddingObject) IsKnown() bool {
return false
}

type EmbeddingModel = string

const (
EmbeddingModelTextEmbeddingAda002 EmbeddingModel = "text-embedding-ada-002"
EmbeddingModelTextEmbedding3Small EmbeddingModel = "text-embedding-3-small"
EmbeddingModelTextEmbedding3Large EmbeddingModel = "text-embedding-3-large"
)

type EmbeddingNewParams struct {
// Input text to embed, encoded as a string or array of tokens. To embed multiple
// inputs in a single request, pass an array of strings or array of token arrays.
Expand All @@ -170,7 +178,7 @@ type EmbeddingNewParams struct {
// see all of your available models, or see our
// [Model overview](https://platform.openai.com/docs/models/overview) for
// descriptions of them.
Model param.Field[EmbeddingNewParamsModel] `json:"model,required"`
Model param.Field[EmbeddingModel] `json:"model,required"`
// The number of dimensions the resulting output embeddings should have. Only
// supported in `text-embedding-3` and later models.
Dimensions param.Field[int64] `json:"dimensions"`
Expand Down Expand Up @@ -214,22 +222,6 @@ type EmbeddingNewParamsInputArrayOfTokenArrays [][]int64

func (r EmbeddingNewParamsInputArrayOfTokenArrays) ImplementsEmbeddingNewParamsInputUnion() {}

type EmbeddingNewParamsModel string

const (
EmbeddingNewParamsModelTextEmbeddingAda002 EmbeddingNewParamsModel = "text-embedding-ada-002"
EmbeddingNewParamsModelTextEmbedding3Small EmbeddingNewParamsModel = "text-embedding-3-small"
EmbeddingNewParamsModelTextEmbedding3Large EmbeddingNewParamsModel = "text-embedding-3-large"
)

func (r EmbeddingNewParamsModel) IsKnown() bool {
switch r {
case EmbeddingNewParamsModelTextEmbeddingAda002, EmbeddingNewParamsModelTextEmbedding3Small, EmbeddingNewParamsModelTextEmbedding3Large:
return true
}
return false
}

// The format to return the embeddings in. Can be either `float` or
// [`base64`](https://pypi.org/project/pybase64/).
type EmbeddingNewParamsEncodingFormat string
Expand Down
2 changes: 1 addition & 1 deletion embedding_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ func TestEmbeddingNewWithOptionalParams(t *testing.T) {
)
_, err := client.Embeddings.New(context.TODO(), openai.EmbeddingNewParams{
Input: openai.F[openai.EmbeddingNewParamsInputUnion](shared.UnionString("The quick brown fox jumped over the lazy dog")),
Model: openai.F(openai.EmbeddingNewParamsModelTextEmbeddingAda002),
Model: openai.F(openai.EmbeddingModelTextEmbeddingAda002),
Dimensions: openai.F(int64(1)),
EncodingFormat: openai.F(openai.EmbeddingNewParamsEncodingFormatFloat),
User: openai.F("user-1234"),
Expand Down

0 comments on commit 57736f9

Please sign in to comment.