Skip to content

Commit

Permalink
Add new struct filed dimensions for embedding API (#645)
Browse files Browse the repository at this point in the history
* add new struct filed dimensions for embedding API

* docs: remove long single-line comments

* change embedding request param Dimensions type to int
  • Loading branch information
chenhhA committed Jan 29, 2024
1 parent 4c41f24 commit 06ff541
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions embeddings.go
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,9 @@ type EmbeddingRequest struct {
Model EmbeddingModel `json:"model"`
User string `json:"user"`
EncodingFormat EmbeddingEncodingFormat `json:"encoding_format,omitempty"`
// Dimensions The number of dimensions the resulting output embeddings should have.
// Only supported in text-embedding-3 and later models.
Dimensions int `json:"dimensions,omitempty"`
}

func (r EmbeddingRequest) Convert() EmbeddingRequest {
Expand All @@ -181,6 +184,9 @@ type EmbeddingRequestStrings struct {
// Currently, only "float" and "base64" are supported, however, "base64" is not officially documented.
// If not specified OpenAI will use "float".
EncodingFormat EmbeddingEncodingFormat `json:"encoding_format,omitempty"`
// Dimensions The number of dimensions the resulting output embeddings should have.
// Only supported in text-embedding-3 and later models.
Dimensions int `json:"dimensions,omitempty"`
}

func (r EmbeddingRequestStrings) Convert() EmbeddingRequest {
Expand All @@ -189,6 +195,7 @@ func (r EmbeddingRequestStrings) Convert() EmbeddingRequest {
Model: r.Model,
User: r.User,
EncodingFormat: r.EncodingFormat,
Dimensions: r.Dimensions,
}
}

Expand All @@ -209,6 +216,9 @@ type EmbeddingRequestTokens struct {
// Currently, only "float" and "base64" are supported, however, "base64" is not officially documented.
// If not specified OpenAI will use "float".
EncodingFormat EmbeddingEncodingFormat `json:"encoding_format,omitempty"`
// Dimensions The number of dimensions the resulting output embeddings should have.
// Only supported in text-embedding-3 and later models.
Dimensions int `json:"dimensions,omitempty"`
}

func (r EmbeddingRequestTokens) Convert() EmbeddingRequest {
Expand All @@ -217,6 +227,7 @@ func (r EmbeddingRequestTokens) Convert() EmbeddingRequest {
Model: r.Model,
User: r.User,
EncodingFormat: r.EncodingFormat,
Dimensions: r.Dimensions,
}
}

Expand Down

0 comments on commit 06ff541

Please sign in to comment.