fix: gate Azure OpenAI dimensions support

This commit is contained in:
liweixin
2026-04-08 11:43:01 +08:00
committed by lyingbug
parent bf514ff68a
commit 5233394d01
4 changed files with 166 additions and 6 deletions
+34 -2
View File
@@ -7,6 +7,7 @@ import (
"fmt"
"io"
"net/http"
"strings"
"time"
"github.com/Tencent/WeKnora/internal/logger"
@@ -26,6 +27,13 @@ type AzureOpenAIEmbedder struct {
EmbedderPooler
}
type azureOpenAIEmbedRequest struct {
Model string `json:"model"`
Input []string `json:"input"`
EncodingFormat string `json:"encoding_format,omitempty"`
Dimensions int `json:"dimensions,omitempty"`
}
// NewAzureOpenAIEmbedder creates a new Azure OpenAI embedder
func NewAzureOpenAIEmbedder(apiKey, baseURL, modelName string,
truncatePromptTokens int, dimensions int, modelID string,
@@ -72,12 +80,12 @@ func (e *AzureOpenAIEmbedder) Embed(ctx context.Context, text string) ([]float32
}
func (e *AzureOpenAIEmbedder) BatchEmbed(ctx context.Context, texts []string) ([][]float32, error) {
reqBody := OpenAIEmbedRequest{
reqBody := azureOpenAIEmbedRequest{
Model: e.modelName,
Input: texts,
EncodingFormat: "float",
}
if e.dimensions > 0 {
if e.supportsDimensionsParam() {
reqBody.Dimensions = e.dimensions
}
@@ -158,6 +166,30 @@ func (e *AzureOpenAIEmbedder) doRequestWithRetry(ctx context.Context, jsonData [
return nil, err
}
func (e *AzureOpenAIEmbedder) supportsDimensionsParam() bool {
if e.dimensions <= 0 {
return false
}
// Azure only supports the dimensions parameter on newer embeddings APIs.
if strings.TrimSpace(e.apiVersion) < "2024-10-21" {
return false
}
modelRef := strings.ToLower(strings.TrimSpace(e.modelID))
if modelRef == "" {
modelRef = strings.ToLower(strings.TrimSpace(e.modelName))
}
// Fixed-dimension legacy models reject the field entirely.
if strings.Contains(modelRef, "ada-002") {
return false
}
return strings.Contains(modelRef, "text-embedding-3-small") ||
strings.Contains(modelRef, "text-embedding-3-large")
}
func (e *AzureOpenAIEmbedder) GetModelName() string { return e.modelName }
func (e *AzureOpenAIEmbedder) GetDimensions() int { return e.dimensions }
func (e *AzureOpenAIEmbedder) GetModelID() string { return e.modelID }
+83 -3
View File
@@ -19,7 +19,7 @@ func TestAzureOpenAIEmbedderBatchEmbedSendsConfiguredDimensions(t *testing.T) {
}
if got, want := r.URL.String(),
"https://example-resource.openai.azure.com/openai/deployments/test-deployment/embeddings?api-version=2024-10-21"; got != want {
"https://example-resource.openai.azure.com/openai/deployments/text-embedding-3-large-deployment/embeddings?api-version=2024-10-21"; got != want {
t.Fatalf("unexpected request path: got %s want %s", got, want)
}
@@ -37,10 +37,10 @@ func TestAzureOpenAIEmbedderBatchEmbedSendsConfiguredDimensions(t *testing.T) {
embedder, err := NewAzureOpenAIEmbedder(
"test-key",
"https://example-resource.openai.azure.com",
"test-deployment",
"text-embedding-3-large-deployment",
511,
256,
"model-id",
"text-embedding-3-large",
"2024-10-21",
nil,
)
@@ -63,6 +63,86 @@ func TestAzureOpenAIEmbedderBatchEmbedSendsConfiguredDimensions(t *testing.T) {
}
}
func TestAzureOpenAIEmbedderBatchEmbedOmitsDimensionsForFixedSizeModels(t *testing.T) {
t.Parallel()
var requestBody map[string]any
transport := roundTripFunc(func(r *http.Request) (*http.Response, error) {
if err := json.NewDecoder(r.Body).Decode(&requestBody); err != nil {
t.Fatalf("decode request body: %v", err)
}
return &http.Response{
StatusCode: http.StatusOK,
Header: make(http.Header),
Body: io.NopCloser(bytes.NewBufferString(`{"data":[{"embedding":[0.1,0.2],"index":0}]}`)),
}, nil
})
embedder, err := NewAzureOpenAIEmbedder(
"test-key",
"https://example-resource.openai.azure.com",
"ada-002-deployment",
511,
1536,
"text-embedding-ada-002",
"2024-10-21",
nil,
)
if err != nil {
t.Fatalf("create embedder: %v", err)
}
embedder.httpClient = &http.Client{Transport: transport}
if _, err := embedder.BatchEmbed(context.Background(), []string{"hello"}); err != nil {
t.Fatalf("BatchEmbed returned error: %v", err)
}
if _, ok := requestBody["dimensions"]; ok {
t.Fatalf("expected request body to omit dimensions for fixed-size model, got %v", requestBody)
}
}
func TestAzureOpenAIEmbedderBatchEmbedOmitsDimensionsForOlderAPIVersion(t *testing.T) {
t.Parallel()
var requestBody map[string]any
transport := roundTripFunc(func(r *http.Request) (*http.Response, error) {
if err := json.NewDecoder(r.Body).Decode(&requestBody); err != nil {
t.Fatalf("decode request body: %v", err)
}
return &http.Response{
StatusCode: http.StatusOK,
Header: make(http.Header),
Body: io.NopCloser(bytes.NewBufferString(`{"data":[{"embedding":[0.1,0.2],"index":0}]}`)),
}, nil
})
embedder, err := NewAzureOpenAIEmbedder(
"test-key",
"https://example-resource.openai.azure.com",
"text-embedding-3-large-deployment",
511,
256,
"text-embedding-3-large",
"2024-02-15-preview",
nil,
)
if err != nil {
t.Fatalf("create embedder: %v", err)
}
embedder.httpClient = &http.Client{Transport: transport}
if _, err := embedder.BatchEmbed(context.Background(), []string{"hello"}); err != nil {
t.Fatalf("BatchEmbed returned error: %v", err)
}
if _, ok := requestBody["dimensions"]; ok {
t.Fatalf("expected request body to omit dimensions for older API versions, got %v", requestBody)
}
}
type roundTripFunc func(*http.Request) (*http.Response, error)
func (f roundTripFunc) RoundTrip(r *http.Request) (*http.Response, error) {
-1
View File
@@ -31,7 +31,6 @@ type OpenAIEmbedRequest struct {
Model string `json:"model"`
Input []string `json:"input"`
EncodingFormat string `json:"encoding_format,omitempty"`
Dimensions int `json:"dimensions,omitempty"`
TruncatePromptTokens int `json:"truncate_prompt_tokens,omitempty"`
}
+49
View File
@@ -0,0 +1,49 @@
package embedding
import (
"bytes"
"context"
"encoding/json"
"io"
"net/http"
"testing"
)
func TestOpenAIEmbedderBatchEmbedDoesNotSendDimensions(t *testing.T) {
t.Parallel()
var requestBody map[string]any
transport := roundTripFunc(func(r *http.Request) (*http.Response, error) {
if err := json.NewDecoder(r.Body).Decode(&requestBody); err != nil {
t.Fatalf("decode request body: %v", err)
}
return &http.Response{
StatusCode: http.StatusOK,
Header: make(http.Header),
Body: io.NopCloser(bytes.NewBufferString(`{"data":[{"embedding":[0.1,0.2],"index":0}]}`)),
}, nil
})
embedder, err := NewOpenAIEmbedder(
"test-key",
"https://api.openai.com/v1",
"text-embedding-3-large",
511,
1024,
"model-id",
nil,
)
if err != nil {
t.Fatalf("create embedder: %v", err)
}
embedder.httpClient = &http.Client{Transport: transport}
if _, err := embedder.BatchEmbed(context.Background(), []string{"hello"}); err != nil {
t.Fatalf("BatchEmbed returned error: %v", err)
}
if _, ok := requestBody["dimensions"]; ok {
t.Fatalf("expected OpenAI request body to omit dimensions, got %v", requestBody)
}
}