Skip to content

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

fix(embedding): honor configured Gemini text parameters (#3361)

HootRocka3a06fd0acb7
diff --git a/src/agentscope/embedding/_gemini/_model.py b/src/agentscope/embedding/_gemini/_model.py
index dc994ced8..089aa9aef 100644
--- a/src/agentscope/embedding/_gemini/_model.py
+++ b/src/agentscope/embedding/_gemini/_model.py
@@ -119,8 +119,8 @@ class GeminiEmbeddingModel(EmbeddingModelBase[str | TextBlock | DataBlock]):
persisted ``dimensions`` inside ``parameters``.
parameters (`GeminiEmbeddingModel.Parameters | None`, \
defaults to ``None``):
- Provider-specific non-dimensional parameters. Currently
- empty for Gemini.
+ Provider-specific non-dimensional text embedding options,
+ such as ``task_type``. Per-call options take precedence.
embedding_cache (`EmbeddingCacheBase | None`, defaults to \
``None``):
Optional embedding cache.
@@ -327,16 +327,20 @@ class GeminiEmbeddingModel(EmbeddingModelBase[str | TextBlock | DataBlock]):
)
texts.append(item)
+ config_kwargs = {
+ **self.parameters.model_dump(exclude_none=True),
+ **kwargs,
+ }
config = types.EmbedContentConfig(
output_dimensionality=self.dimensions,
- **kwargs,
+ **config_kwargs,
)
cache_key = {
"model": self.model,
"contents": texts,
"output_dimensionality": self.dimensions,
- **kwargs,
+ **config_kwargs,
}
if self.embedding_cache:
diff --git a/tests/embedding_gemini_test.py b/tests/embedding_gemini_test.py
index eba99b9bc..be4df866b 100644
--- a/tests/embedding_gemini_test.py
+++ b/tests/embedding_gemini_test.py
@@ -2,9 +2,10 @@
# pylint: disable=protected-access
"""Unit tests for GeminiEmbeddingModel."""
from dataclasses import asdict
+from tempfile import TemporaryDirectory
from typing import Any
from unittest import IsolatedAsyncioTestCase
-from unittest.mock import AsyncMock, MagicMock
+from unittest.mock import AsyncMock, MagicMock, patch
from utils import AnyValue
@@ -12,7 +13,9 @@ from agentscope.embedding import (
GeminiEmbeddingModel,
EmbeddingResponse,
EmbeddingUsage,
+ FileEmbeddingCache,
)
+from agentscope.credential import GeminiCredential
from agentscope.message import DataBlock, Base64Source
A = AnyValue()
@@ -85,6 +88,7 @@ class GeminiTextCallTest(IsolatedAsyncioTestCase):
model = GeminiEmbeddingModel.__new__(GeminiEmbeddingModel)
model.model = "gemini-embedding-001"
model.dimensions = 2
+ model.parameters = GeminiEmbeddingModel.Parameters()
model.context_size = 2048
model.batch_size = 100
model.max_retries = 3
@@ -128,6 +132,105 @@ class GeminiTextCallTest(IsolatedAsyncioTestCase):
with self.assertRaises(ValueError):
await GeminiEmbeddingModel._call_text(model, [_img()])
+ def _make_configured_model(
+ self,
+ task_type: str,
+ cache: FileEmbeddingCache | None = None,
+ ) -> GeminiEmbeddingModel:
+ """Use the public constructor with only the SDK client mocked."""
+ with patch("google.genai.Client") as client:
+ client.return_value.aio.models.embed_content = AsyncMock(
+ return_value=MagicMock(
+ embeddings=[MagicMock(values=[0.1, 0.2])],
+ ),
+ )
+ return GeminiEmbeddingModel(
+ credential=GeminiCredential(api_key="offline-placeholder"),
+ model="gemini-embedding-001",
+ dimensions=2,
+ parameters=GeminiEmbeddingModel.Parameters(
+ task_type=task_type,
+ ),
+ embedding_cache=cache,
+ max_retries=0,
+ )
+
+ async def test_configured_parameters_and_call_precedence(self) -> None:
+ """Configured text options reach the SDK; call options win."""
+ model = self._make_configured_model("RETRIEVAL_QUERY")
+ sdk = model.client.aio.models.embed_content
+ for overrides, task_type in (
+ ({}, "RETRIEVAL_QUERY"),
+ ({"task_type": "RETRIEVAL_DOCUMENT"}, "RETRIEVAL_DOCUMENT"),
+ ):
+ with self.subTest(task_type=task_type):
+ await model(["hello"], **overrides)
+ request = sdk.call_args.kwargs
+ self.assertEqual(
+ {
+ **request,
+ "config": request["config"].model_dump(
+ exclude_none=True,
+ ),
+ },
+ {
+ "model": "gemini-embedding-001",
+ "contents": ["hello"],
+ "config": {
+ "task_type": task_type,
+ "output_dimensionality": 2,
+ },
+ },
+ )
+ self.assertEqual(
+ model.parameters.model_dump(),
+ {"task_type": "RETRIEVAL_QUERY"},
+ )
+ self.assertEqual(sdk.await_count, 2)
+
+ async def test_file_cache_uses_effective_parameters(self) -> None:
+ """Distinct task configurations cannot reuse each other's vectors."""
+ with TemporaryDirectory() as directory:
+ cache = FileEmbeddingCache(cache_dir=directory)
+ query = self._make_configured_model("RETRIEVAL_QUERY", cache)
+ document = self._make_configured_model("RETRIEVAL_DOCUMENT", cache)
+ document.client.aio.models.embed_content.return_value = MagicMock(
+ embeddings=[MagicMock(values=[0.3, 0.4])],
+ )
+ cases = (
+ (query, {}, "api", [[0.1, 0.2]]),
+ (document, {}, "api", [[0.3, 0.4]]),
+ (
+ query,
+ {"task_type": "RETRIEVAL_DOCUMENT"},
+ "cache",
+ [[0.3, 0.4]],
+ ),
+ (query, {}, "cache", [[0.1, 0.2]]),
+ )
+ for index, (model, overrides, source, embeddings) in enumerate(
+ cases,
+ ):
+ with self.subTest(case=index):
+ result = await model(["hello"], **overrides)
+ self.assertEqual(
+ asdict(result),
+ {
+ "embeddings": embeddings,
+ "id": A,
+ "created_at": A,
+ "type": "embedding",
+ "usage": {
+ "tokens": None if source == "api" else 0,
+ "time": A if source == "api" else 0,
+ "type": "embedding",
+ },
+ "source": source,
+ },
+ )
+ query.client.aio.models.embed_content.assert_awaited_once()
+ document.client.aio.models.embed_content.assert_awaited_once()
+
class GeminiMultimodalCallTest(IsolatedAsyncioTestCase):
"""Test Gemini multimodal embedding via mocked _call_multimodal."""