š« CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org
Python agentai-societiesartificial-intelligencecommunicative-aicooperative-aideep-learninglarge-language-modelsmulti-agent-systemsnatural-language-processing
feat(embeddings): Add text embedding feature (#376)
Tianqi Xue826fc33adde
diff --git a/camel/agents/chat_agent.py b/camel/agents/chat_agent.pyindex 90f2e9b1a..7355b9e59 100644--- a/camel/agents/chat_agent.py+++ b/camel/agents/chat_agent.py@@ -38,7 +38,7 @@ from camel.types import (OpenAIBackendRole,RoleType,)-from camel.utils import get_model_encoding, openai_api_key_required+from camel.utils import get_model_encoding@dataclass(frozen=True)@@ -257,7 +257,6 @@ class ChatAgent(BaseAgent):"""self.update_memory(message, OpenAIBackendRole.ASSISTANT)- @openai_api_key_requireddef step(self,input_message: BaseMessage,diff --git a/camel/embeddings/__init__.py b/camel/embeddings/__init__.pynew file mode 100644index 000000000..f25d73d16--- /dev/null+++ b/camel/embeddings/__init__.py@@ -0,0 +1,20 @@+# =========== Copyright 2023 @ 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 @ CAMEL-AI.org. All Rights Reserved. ===========+from .base import BaseEmbedding+from .openai_embedding import OpenAIEmbedding++__all__ = [+ "BaseEmbedding",+ "OpenAIEmbedding",+]diff --git a/camel/embeddings/base.py b/camel/embeddings/base.pynew file mode 100644index 000000000..e28f4e249--- /dev/null+++ b/camel/embeddings/base.py@@ -0,0 +1,63 @@+# =========== Copyright 2023 @ 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 @ CAMEL-AI.org. All Rights Reserved. ===========+from abc import ABC, abstractmethod+from typing import Any, List+++class BaseEmbedding(ABC):+ r"""Abstract base class for text embedding functionalities."""++ @abstractmethod+ def embed_texts(+ self,+ texts: List[str],+ **kwargs: Any,+ ) -> List[List[float]]:+ r"""Generates embeddings for the given texts.++ Args:+ texts (List[str]): The texts for which to generate the embeddings.+ **kwargs (Any): Extra kwargs passed to the embedding API.++ Returns:+ List[List[float]]: A list that represents the generated embedding+ as a list of floating-point numbers.+ """+ pass++ def embed_text(+ self,+ text: str,+ **kwargs: Any,+ ) -> List[float]:+ r"""Generates an embedding for the given text.++ Args:+ text (str): The text for which to generate the embedding.+ **kwargs (Any): Extra kwargs passed to the embedding API.++ Returns:+ List[float]: A list of floating-point numbers representing the+ generated embedding.+ """+ return self.embed_texts([text], **kwargs)[0]++ @abstractmethod+ def get_output_dim(self) -> int:+ r"""Returns the output dimension of the embeddings.++ Returns:+ int: The dimensionality of the embedding for the current model.+ """+ passdiff --git a/camel/embeddings/openai_embedding.py b/camel/embeddings/openai_embedding.pynew file mode 100644index 000000000..8e28b70c5--- /dev/null+++ b/camel/embeddings/openai_embedding.py@@ -0,0 +1,74 @@+# =========== Copyright 2023 @ 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 @ CAMEL-AI.org. All Rights Reserved. ===========+from typing import Any, List++from openai import OpenAI++from camel.embeddings import BaseEmbedding+from camel.types import EmbeddingModelType+from camel.utils import openai_api_key_required+++class OpenAIEmbedding(BaseEmbedding):+ r"""Provides text embedding functionalities using OpenAI's models.++ Args:+ model (OpenAiEmbeddingModel, optional): The model type to be used for+ generating embeddings. (default: :obj:`ModelType.ADA2`)++ Raises:+ RuntimeError: If an unsupported model type is specified.+ """++ def __init__(+ self,+ model_type: EmbeddingModelType = EmbeddingModelType.ADA2,+ ) -> None:+ if not model_type.is_openai:+ raise ValueError("Invalid OpenAI embedding model type.")+ self.model_type = model_type+ self.output_dim = model_type.output_dim+ self.client = OpenAI()++ @openai_api_key_required+ def embed_texts(+ self,+ texts: List[str],+ **kwargs: Any,+ ) -> List[List[float]]:+ r"""Generates embeddings for the given texts.++ Args:+ texts (List[str]): The texts for which to generate the embeddings.+ **kwargs (Any): Extra kwargs passed to the embedding API.++ Returns:+ List[List[float]]: A list that represents the generated embedding+ as a list of floating-point numbers.+ """+ # TODO: count tokens+ response = self.client.embeddings.create(+ input=texts,+ model=self.model_type.value,+ **kwargs,+ )+ return [data.embedding for data in response.data]++ def get_output_dim(self) -> int:+ r"""Returns the output dimension of the embeddings.++ Returns:+ int: The dimensionality of the embedding for the current model.+ """+ return self.output_dimdiff --git a/camel/models/openai_model.py b/camel/models/openai_model.pyindex b318f5337..0afa8af61 100644--- a/camel/models/openai_model.py+++ b/camel/models/openai_model.py@@ -20,7 +20,11 @@ from camel.configs import OPENAI_API_PARAMS_WITH_FUNCTIONSfrom camel.messages import OpenAIMessagefrom camel.models import BaseModelBackendfrom camel.types import ChatCompletion, ChatCompletionChunk, ModelType-from camel.utils import BaseTokenCounter, OpenAITokenCounter+from camel.utils import (+ BaseTokenCounter,+ OpenAITokenCounter,+ openai_api_key_required,+)class OpenAIModel(BaseModelBackend):@@ -53,6 +57,7 @@ class OpenAIModel(BaseModelBackend):self._token_counter = OpenAITokenCounter(self.model_type)return self._token_counter+ @openai_api_key_requireddef run(self,messages: List[OpenAIMessage],diff --git a/camel/types/__init__.py b/camel/types/__init__.pyindex 749c6b9a8..251201855 100644--- a/camel/types/__init__.py+++ b/camel/types/__init__.py@@ -17,6 +17,7 @@ from .enums import (TaskType,TerminationMode,OpenAIBackendRole,+ EmbeddingModelType,VectorDistance,)from .openai_types import (@@ -38,6 +39,7 @@ __all__ = ['TaskType','TerminationMode','OpenAIBackendRole',+ 'EmbeddingModelType','VectorDistance','Choice','ChatCompletion',diff --git a/camel/types/enums.py b/camel/types/enums.pyindex f40ad4fd3..754341d91 100644--- a/camel/types/enums.py+++ b/camel/types/enums.py@@ -39,38 +39,28 @@ class ModelType(Enum):@propertydef value_for_tiktoken(self) -> str:- return self.value if self.name != "STUB" else "gpt-3.5-turbo"+ return self.value if self is ModelType.STUB else "gpt-3.5-turbo"@propertydef is_openai(self) -> bool:- r"""Returns whether this type of models is an OpenAI-released model.-- Returns:- bool: Whether this type of models belongs to OpenAI.- """- if self.name in {- "GPT_3_5_TURBO",- "GPT_3_5_TURBO_16K",- "GPT_4",- "GPT_4_32K",- "GPT_4_TURBO",- "GPT_4_TURBO_VISION",- }:- return True- else:- return False+ r"""Returns whether this type of models is an OpenAI-released model."""+ return self in {+ ModelType.GPT_3_5_TURBO,+ ModelType.GPT_3_5_TURBO_16K,+ ModelType.GPT_4,+ ModelType.GPT_4_32K,+ ModelType.GPT_4_TURBO,+ ModelType.GPT_4_TURBO_VISION,+ }@propertydef is_open_source(self) -> bool:- r"""Returns whether this type of models is open-source.-- Returns:- bool: Whether this type of models is open-source.- """- if self.name in {"LLAMA_2", "VICUNA", "VICUNA_16K"}:- return True- else:- return False+ r"""Returns whether this type of models is open-source."""+ return self in {+ ModelType.LLAMA_2,+ ModelType.VICUNA,+ ModelType.VICUNA_16K,+ }@propertydef token_limit(self) -> int:@@ -123,6 +113,40 @@ class ModelType(Enum):return self.value in model_name.lower()+class EmbeddingModelType(Enum):+ ADA2 = "text-embedding-ada-002"+ ADA1 = "text-embedding-ada-001"+ BABBAGE1 = "text-embedding-babbage-001"+ CURIE1 = "text-embedding-curie-001"+ DAVINCI1 = "text-embedding-davinci-001"++ @property+ def is_openai(self) -> bool:+ r"""Returns whether this type of models is an OpenAI-released model."""+ return self in {+ EmbeddingModelType.ADA1,+ EmbeddingModelType.ADA2,+ EmbeddingModelType.BABBAGE1,+ EmbeddingModelType.CURIE1,+ EmbeddingModelType.DAVINCI1,+ }++ @property+ def output_dim(self) -> int:+ if self is EmbeddingModelType.ADA2:+ return 1536+ elif self is EmbeddingModelType.ADA1:+ return 1024+ elif self is EmbeddingModelType.BABBAGE1:+ return 2048+ elif self is EmbeddingModelType.CURIE1:+ return 4096+ elif self is EmbeddingModelType.DAVINCI1:+ return 12288+ else:+ raise ValueError(f"Unknown model type {self}.")++class TaskType(Enum):AI_SOCIETY = "ai_society"CODE = "code"diff --git a/camel/utils/commons.py b/camel/utils/commons.pyindex 8ac475f47..160c0938d 100644--- a/camel/utils/commons.py+++ b/camel/utils/commons.py@@ -33,7 +33,7 @@ from urllib.parse import urlparseimport requests-from camel.types import ModelType, TaskType+from camel.types import TaskTypeF = TypeVar('F', bound=Callable[..., Any])@@ -55,11 +55,7 @@ def openai_api_key_required(func: F) -> F:@wraps(func)def wrapper(self, *args, **kwargs):- if hasattr(self, "model") and self.model_type == ModelType.STUB:- return func(self, *args, **kwargs)- elif self.model_type.is_open_source:- return func(self, *args, **kwargs)- elif 'OPENAI_API_KEY' in os.environ:+ if 'OPENAI_API_KEY' in os.environ:return func(self, *args, **kwargs)else:raise ValueError('OpenAI API key not found.')diff --git a/test/embeddings/test_openai_embedding.py b/test/embeddings/test_openai_embedding.pynew file mode 100644index 000000000..e2b6b959b--- /dev/null+++ b/test/embeddings/test_openai_embedding.py@@ -0,0 +1,23 @@+# =========== Copyright 2023 @ 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 @ CAMEL-AI.org. All Rights Reserved. ===========+import pytest++from camel.embeddings import BaseEmbedding, OpenAIEmbedding++[email protected]("embedding_model", [OpenAIEmbedding()])+def test_embedding(embedding_model: BaseEmbedding):+ text = "test embedding text."+ vector = embedding_model.embed_text(text)+ assert len(vector) == embedding_model.get_output_dim()