Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

feat: add dependencies_required decorators to camel/embeddings (#1043) (#3992)

Rakesh399112bd6b9b
diff --git a/camel/embeddings/__init__.py b/camel/embeddings/__init__.py
index 2bf2fb856..6d23e777e 100644
--- a/camel/embeddings/__init__.py
+++ b/camel/embeddings/__init__.py
@@ -23,14 +23,14 @@ from .together_embedding import TogetherEmbedding
from .vlm_embedding import VisionLanguageEmbedding
__all__ = [
- "BaseEmbedding",
- "OpenAIEmbedding",
"AzureEmbedding",
- "SentenceTransformerEncoder",
- "VisionLanguageEmbedding",
+ "BaseEmbedding",
+ "GeminiEmbedding",
+ "JinaEmbedding",
"MistralEmbedding",
"OpenAICompatibleEmbedding",
- "JinaEmbedding",
+ "OpenAIEmbedding",
+ "SentenceTransformerEncoder",
"TogetherEmbedding",
- "GeminiEmbedding",
+ "VisionLanguageEmbedding",
]
diff --git a/camel/embeddings/azure_embedding.py b/camel/embeddings/azure_embedding.py
index a76d88528..7d5619725 100644
--- a/camel/embeddings/azure_embedding.py
+++ b/camel/embeddings/azure_embedding.py
@@ -22,7 +22,7 @@ from openai import AzureOpenAI
from camel.embeddings.base import BaseEmbedding
from camel.types import EmbeddingModelType
-from camel.utils import api_keys_required # Add this import
+from camel.utils import api_keys_required, dependencies_required
class AzureEmbedding(BaseEmbedding[str]):
@@ -46,6 +46,7 @@ class AzureEmbedding(BaseEmbedding[str]):
ValueError: If required API configuration is missing.
"""
+ @dependencies_required('openai')
@api_keys_required(
[
("api_key", 'AZURE_OPENAI_API_KEY'),
diff --git a/camel/embeddings/gemini_embedding.py b/camel/embeddings/gemini_embedding.py
index 0fd6e18ac..c74d7b1c6 100644
--- a/camel/embeddings/gemini_embedding.py
+++ b/camel/embeddings/gemini_embedding.py
@@ -18,7 +18,7 @@ from typing import Any, Optional
from camel.embeddings.base import BaseEmbedding
from camel.types import EmbeddingModelType, GeminiEmbeddingTaskType
-from camel.utils import api_keys_required
+from camel.utils import api_keys_required, dependencies_required
class GeminiEmbedding(BaseEmbedding[str]):
@@ -39,6 +39,7 @@ class GeminiEmbedding(BaseEmbedding[str]):
RuntimeError: If an unsupported model type is specified.
"""
+ @dependencies_required('google.genai')
@api_keys_required(
[
("api_key", 'GEMINI_API_KEY'),
diff --git a/camel/embeddings/jina_embedding.py b/camel/embeddings/jina_embedding.py
index f5c290341..e64164c89 100644
--- a/camel/embeddings/jina_embedding.py
+++ b/camel/embeddings/jina_embedding.py
@@ -18,17 +18,17 @@ from __future__ import annotations
import base64
import io
import os
-from typing import Any, Optional, Union
+from typing import TYPE_CHECKING, Any, Optional, Union
-import requests
-from PIL import Image
+if TYPE_CHECKING:
+ from PIL import Image
from camel.embeddings import BaseEmbedding
from camel.types.enums import EmbeddingModelType
-from camel.utils import api_keys_required
+from camel.utils import api_keys_required, dependencies_required
-class JinaEmbedding(BaseEmbedding[Union[str, Image.Image]]):
+class JinaEmbedding(BaseEmbedding[Union[str, "Image.Image"]]):
r"""Provides text and image embedding functionalities using Jina AI's API.
Args:
@@ -52,6 +52,7 @@ class JinaEmbedding(BaseEmbedding[Union[str, Image.Image]]):
L2 norm. (default: :obj:`False`)
"""
+ @dependencies_required('requests', 'PIL')
@api_keys_required([("api_key", 'JINA_API_KEY')])
def __init__(
self,
@@ -88,7 +89,7 @@ class JinaEmbedding(BaseEmbedding[Union[str, Image.Image]]):
def embed_list(
self,
- objs: list[Union[str, Image.Image]],
+ objs: list[Union[str, "Image.Image"]],
**kwargs: Any,
) -> list[list[float]]:
r"""Generates embeddings for the given texts or images.
@@ -107,6 +108,7 @@ class JinaEmbedding(BaseEmbedding[Union[str, Image.Image]]):
ValueError: If the input type is not supported.
RuntimeError: If the API request fails.
"""
+ import requests
input_data = []
for obj in objs:
diff --git a/camel/embeddings/mistral_embedding.py b/camel/embeddings/mistral_embedding.py
index 22bd795c8..a3a9db4c1 100644
--- a/camel/embeddings/mistral_embedding.py
+++ b/camel/embeddings/mistral_embedding.py
@@ -18,7 +18,7 @@ from typing import Any
from camel.embeddings.base import BaseEmbedding
from camel.types import EmbeddingModelType
-from camel.utils import api_keys_required
+from camel.utils import api_keys_required, dependencies_required
class MistralEmbedding(BaseEmbedding[str]):
@@ -37,6 +37,7 @@ class MistralEmbedding(BaseEmbedding[str]):
RuntimeError: If an unsupported model type is specified.
"""
+ @dependencies_required('mistralai')
@api_keys_required(
[
("api_key", 'MISTRAL_API_KEY'),
diff --git a/camel/embeddings/openai_compatible_embedding.py b/camel/embeddings/openai_compatible_embedding.py
index b7e52f0e2..c53328eac 100644
--- a/camel/embeddings/openai_compatible_embedding.py
+++ b/camel/embeddings/openai_compatible_embedding.py
@@ -19,7 +19,7 @@ from typing import Any, Optional
from openai import OpenAI
from camel.embeddings.base import BaseEmbedding
-from camel.utils import api_keys_required
+from camel.utils import api_keys_required, dependencies_required
class OpenAICompatibleEmbedding(BaseEmbedding[str]):
@@ -35,6 +35,7 @@ class OpenAICompatibleEmbedding(BaseEmbedding[str]):
embedding call.
"""
+ @dependencies_required('openai')
@api_keys_required(
[
("api_key", 'OPENAI_COMPATIBILITY_API_KEY'),
diff --git a/camel/embeddings/openai_embedding.py b/camel/embeddings/openai_embedding.py
index 146bea678..9d4d510af 100644
--- a/camel/embeddings/openai_embedding.py
+++ b/camel/embeddings/openai_embedding.py
@@ -20,7 +20,7 @@ from openai import OpenAI
from camel.embeddings.base import BaseEmbedding
from camel.types import NOT_GIVEN, EmbeddingModelType, NotGiven
-from camel.utils import api_keys_required
+from camel.utils import api_keys_required, dependencies_required
class OpenAIEmbedding(BaseEmbedding[str]):
@@ -41,6 +41,7 @@ class OpenAIEmbedding(BaseEmbedding[str]):
RuntimeError: If an unsupported model type is specified.
"""
+ @dependencies_required('openai')
@api_keys_required(
[
("api_key", 'OPENAI_API_KEY'),
diff --git a/camel/embeddings/sentence_transformers_embeddings.py b/camel/embeddings/sentence_transformers_embeddings.py
index ac16ae5ff..899bb7e50 100644
--- a/camel/embeddings/sentence_transformers_embeddings.py
+++ b/camel/embeddings/sentence_transformers_embeddings.py
@@ -16,6 +16,7 @@ from __future__ import annotations
from typing import Any
from camel.embeddings.base import BaseEmbedding
+from camel.utils import dependencies_required
class SentenceTransformerEncoder(BaseEmbedding[str]):
@@ -26,6 +27,7 @@ class SentenceTransformerEncoder(BaseEmbedding[str]):
https://www.sbert.net/
"""
+ @dependencies_required('sentence_transformers')
def __init__(
self,
model_name: str = "intfloat/e5-large-v2",
diff --git a/camel/embeddings/together_embedding.py b/camel/embeddings/together_embedding.py
index b8539c28a..656a8d64b 100644
--- a/camel/embeddings/together_embedding.py
+++ b/camel/embeddings/together_embedding.py
@@ -18,7 +18,7 @@ from openai import OpenAI
from camel.embeddings.base import BaseEmbedding
from camel.logger import get_logger
-from camel.utils import api_keys_required
+from camel.utils import api_keys_required, dependencies_required
logger = get_logger(__name__)
@@ -41,6 +41,7 @@ class TogetherEmbedding(BaseEmbedding[str]):
RuntimeError: If the API request fails.
"""
+ @dependencies_required('openai')
@api_keys_required([("api_key", 'TOGETHER_API_KEY')])
def __init__(
self,
diff --git a/camel/embeddings/vlm_embedding.py b/camel/embeddings/vlm_embedding.py
index 5af32a96a..601e69de0 100644
--- a/camel/embeddings/vlm_embedding.py
+++ b/camel/embeddings/vlm_embedding.py
@@ -21,6 +21,7 @@ from PIL import Image
from camel.embeddings import BaseEmbedding
from camel.logger import get_logger
+from camel.utils import dependencies_required
logger = get_logger(__name__)
@@ -36,6 +37,7 @@ class VisionLanguageEmbedding(BaseEmbedding[Union[str, Image.Image]]):
RuntimeError: If an unsupported model type is specified.
"""
+ @dependencies_required('transformers', 'PIL')
def __init__(
self, model_name: str = "openai/clip-vit-base-patch32"
) -> None:
diff --git a/test/embeddings/test_embeddings_decorators.py b/test/embeddings/test_embeddings_decorators.py
new file mode 100644
index 000000000..93880414b
--- /dev/null
+++ b/test/embeddings/test_embeddings_decorators.py
@@ -0,0 +1,110 @@
+# ========= Copyright 2023-2026 @ CAMEL-AI.org. All Rights Reserved. =========
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ========= Copyright 2023-2026 @ CAMEL-AI.org. All Rights Reserved. =========
+"""
+Tests that @dependencies_required is correctly applied to embedding classes.
+When a required package is unavailable, calling __init__ should raise
+ImportError before any API key check occurs.
+"""
+
+from unittest.mock import patch
+
+import pytest
+
+
+def _mock_missing(module_name: str):
+ """Patch is_module_available to return False for a specific module."""
+ original = __import__(
+ 'camel.utils.commons', fromlist=['is_module_available']
+ ).is_module_available
+
+ def fake(m):
+ if m == module_name:
+ return False
+ return original(m)
+
+ return patch('camel.utils.commons.is_module_available', side_effect=fake)
+
+
+def test_openai_embedding_missing_dependency():
+ from camel.embeddings import OpenAIEmbedding
+
+ with _mock_missing('openai'):
+ with pytest.raises(ImportError, match="openai"):
+ OpenAIEmbedding()
+
+
+def test_jina_embedding_missing_dependency():
+ from camel.embeddings import JinaEmbedding
+
+ with _mock_missing('requests'):
+ with pytest.raises(ImportError, match="requests"):
+ JinaEmbedding()
+
+
+def test_mistral_embedding_missing_dependency():
+ from camel.embeddings import MistralEmbedding
+
+ with _mock_missing('mistralai'):
+ with pytest.raises(ImportError, match="mistralai"):
+ MistralEmbedding()
+
+
+def test_together_embedding_missing_dependency():
+ from camel.embeddings import TogetherEmbedding
+
+ with _mock_missing('openai'):
+ with pytest.raises(ImportError, match="openai"):
+ TogetherEmbedding()
+
+
+def test_azure_embedding_missing_dependency():
+ from camel.embeddings import AzureEmbedding
+
+ with _mock_missing('openai'):
+ with pytest.raises(ImportError, match="openai"):
+ AzureEmbedding()
+
+
+def test_gemini_embedding_missing_dependency():
+ from camel.embeddings import GeminiEmbedding
+
+ with _mock_missing('google.genai'):
+ with pytest.raises(ImportError, match=r"google\.genai"):
+ GeminiEmbedding()
+
+
+def test_openai_compatible_embedding_missing_dependency():
+ from camel.embeddings import OpenAICompatibleEmbedding
+
+ with _mock_missing('openai'):
+ with pytest.raises(ImportError, match="openai"):
+ OpenAICompatibleEmbedding(
+ model_type="text-embed",
+ )
+
+
+def test_sentence_transformer_missing_dependency():
+ from camel.embeddings import SentenceTransformerEncoder
+
+ with _mock_missing('sentence_transformers'):
+ with pytest.raises(ImportError, match="sentence_transformers"):
+ SentenceTransformerEncoder()
+
+
+def test_vlm_embedding_missing_dependency():
+ from camel.embeddings import VisionLanguageEmbedding
+
+ with _mock_missing('transformers'):
+ with pytest.raises(ImportError, match="transformers"):
+ VisionLanguageEmbedding()