Skip to content

Build and run agents you can see, understand and trust.

feat(embedding): add pass_dimensions option for OpenAI embedding model (#1897)

jinliyl3a39230fa8a1
diff --git a/src/agentscope/embedding/_openai/_model.py b/src/agentscope/embedding/_openai/_model.py
index 10fb61566..defe23e0e 100644
--- a/src/agentscope/embedding/_openai/_model.py
+++ b/src/agentscope/embedding/_openai/_model.py
@@ -30,6 +30,7 @@ class OpenAIEmbeddingModel(EmbeddingModelBase[str]):
credential: CredentialBase,
model: str,
parameters: "OpenAIEmbeddingModel.Parameters | None" = None,
+ pass_dimensions: bool = True,
embedding_cache: EmbeddingCacheBase | None = None,
context_size: int = 8191,
max_retries: int = 3,
@@ -49,6 +50,9 @@ class OpenAIEmbeddingModel(EmbeddingModelBase[str]):
defaults to ``None``):
User-configurable parameters (currently only
``dimensions``).
+ pass_dimensions (`bool`, defaults to `True`):
+ Whether to pass the ``dimensions`` parameter to the API.
+ Some OpenAI-compatible providers do not support it.
embedding_cache (`EmbeddingCacheBase | None`, defaults to \
``None``):
Optional embedding cache.
@@ -81,6 +85,7 @@ class OpenAIEmbeddingModel(EmbeddingModelBase[str]):
api_key=credential.api_key.get_secret_value(),
**client_kwargs,
)
+ self.pass_dimensions = pass_dimensions
self.embedding_cache: EmbeddingCacheBase | None = embedding_cache
@classmethod
@@ -114,10 +119,11 @@ class OpenAIEmbeddingModel(EmbeddingModelBase[str]):
api_kwargs: dict[str, Any] = {
"input": inputs,
"model": self.model,
- "dimensions": self.dimensions,
"encoding_format": "float",
**kwargs,
}
+ if self.pass_dimensions:
+ api_kwargs["dimensions"] = self.dimensions
if self.embedding_cache:
cached = await self.embedding_cache.retrieve(
@@ -134,7 +140,17 @@ class OpenAIEmbeddingModel(EmbeddingModelBase[str]):
response = await self.client.embeddings.create(**api_kwargs)
time = (datetime.now() - start_time).total_seconds()
- embeddings = [item.embedding for item in response.data]
+ embeddings: list[Any] = [None] * len(inputs)
+ for pos, item in enumerate(response.data):
+ index = getattr(item, "index", pos)
+ if not isinstance(index, int):
+ index = pos
+ if 0 <= index < len(inputs):
+ embeddings[index] = item.embedding or getattr(
+ item,
+ "dense_embedding",
+ None,
+ )
if self.embedding_cache:
await self.embedding_cache.store(