camel-ai 0.1.3__py3-none-any.whl → 0.1.4__py3-none-any.whl

camel/functions/open_api_specs/klarna/__init__.py

@@ -0,0 +1,13 @@
+# =========== 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. ===========

camel/functions/open_api_specs/klarna/openapi.yaml

@@ -0,0 +1,87 @@
+---
+openapi: 3.0.1
+info:
+  version: v0
+  title: Open AI Klarna product Api
+  description: Search and compare prices from thousands of online shops. Only available in the US.
+servers:
+- url: https://www.klarna.com/us/shopping
+tags:
+- name: open-ai-product-endpoint
+  description: Open AI Product Endpoint. Query for products.
+paths:
+  "/public/openai/v0/products":
+    get:
+      tags:
+      - open-ai-product-endpoint
+      summary: API for fetching Klarna product information
+      operationId: productsUsingGET
+      parameters:
+      - name: q
+        in: query
+        description: A precise query that matches one very small category or product
+          that needs to be searched for to find the products the user is looking for.
+          If the user explicitly stated what they want, use that as a query. The query
+          is as specific as possible to the product name or category mentioned by
+          the user in its singular form, and don't contain any clarifiers like latest,
+          newest, cheapest, budget, premium, expensive or similar. The query is always
+          taken from the latest topic, if there is a new topic a new query is started.
+        required: true
+        schema:
+          type: string
+      - name: size
+        in: query
+        description: number of products returned
+        required: false
+        schema:
+          type: integer
+      - name: min_price
+        in: query
+        description: "(Optional) Minimum price in local currency for the product searched
+          for. Either explicitly stated by the user or implicitly inferred from a
+          combination of the user's request and the kind of product searched for."
+        required: false
+        schema:
+          type: integer
+      - name: max_price
+        in: query
+        description: "(Optional) Maximum price in local currency for the product searched
+          for. Either explicitly stated by the user or implicitly inferred from a
+          combination of the user's request and the kind of product searched for."
+        required: false
+        schema:
+          type: integer
+      responses:
+        '200':
+          description: Products found
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ProductResponse"
+        '503':
+          description: one or more services are unavailable
+      deprecated: false
+components:
+  schemas:
+    Product:
+      type: object
+      properties:
+        attributes:
+          type: array
+          items:
+            type: string
+        name:
+          type: string
+        price:
+          type: string
+        url:
+          type: string
+      title: Product
+    ProductResponse:
+      type: object
+      properties:
+        products:
+          type: array
+          items:
+            "$ref": "#/components/schemas/Product"
+      title: ProductResponse

camel/functions/open_api_specs/speak/__init__.py

@@ -0,0 +1,13 @@
+# =========== 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. ===========

camel/functions/open_api_specs/speak/openapi.yaml

@@ -0,0 +1,151 @@
+openapi: 3.0.1
+info:
+  title: Speak
+  description: Learn how to say anything in another language with Speak, your AI-powered language tutor.
+  version: 'v1'
+servers:
+  - url: https://api.speak.com
+paths:
+  /v1/public/openai/translate:
+    post:
+      operationId: translate
+      summary: Translate and explain how to say a specific phrase or word in another language.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/translateRequest'
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/translateResponse'
+  /v1/public/openai/explain-phrase:
+    post:
+      operationId: explainPhrase
+      summary: Explain the meaning and usage of a specific foreign language phrase that the user is asking about.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/explainPhraseRequest'
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/explainPhraseResponse'
+  /v1/public/openai/explain-task:
+    post:
+      operationId: explainTask
+      summary: Explain the best way to say or do something in a specific situation or context with a foreign language. Use this endpoint when the user asks more general or high-level questions.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/explainTaskRequest'
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/explainTaskResponse'
+components:
+  schemas:
+    translateRequest:
+      type: object
+      required:
+        - phrase_to_translate
+        - learning_language
+        - native_language
+        - additional_context
+        - full_query
+      properties:
+        phrase_to_translate:
+          type: string
+          description: Phrase or concept to translate into the foreign language and explain further.
+        learning_language:
+          type: string
+          description: The foreign language that the user is learning and asking about. Always use the full name of the language (e.g. Spanish, French).
+        native_language:
+          type: string
+          description: The user's native language. Infer this value from the language the user asked their question in. Always use the full name of the language (e.g. Spanish, French).
+        additional_context:
+          type: string
+          description: A description of any additional context in the user's question that could affect the explanation - e.g. setting, scenario, situation, tone, speaking style and formality, usage notes, or any other qualifiers.
+        full_query:
+          type: string
+          description: Full text of the user's question.
+    translateResponse:
+      type: object
+      properties:
+        explanation:
+          type: string
+          description: An explanation of how to say the input phrase in the foreign language.
+    explainPhraseRequest:
+      type: object
+      required:
+        - foreign_phrase
+        - learning_language
+        - native_language
+        - additional_context
+        - full_query
+      properties:
+        foreign_phrase:
+          type: string
+          description: Foreign language phrase or word that the user wants an explanation for.
+        learning_language:
+          type: string
+          description: The language that the user is asking their language question about. The value can be inferred from question - e.g. for "Somebody said no mames to me, what does that mean", the value should be "Spanish" because "no mames" is a Spanish phrase. Always use the full name of the language (e.g. Spanish, French).
+        native_language:
+          type: string
+          description: The user's native language. Infer this value from the language the user asked their question in. Always use the full name of the language (e.g. Spanish, French).
+        additional_context:
+          type: string
+          description: A description of any additional context in the user's question that could affect the explanation - e.g. setting, scenario, situation, tone, speaking style and formality, usage notes, or any other qualifiers.
+        full_query:
+          type: string
+          description: Full text of the user's question.
+    explainPhraseResponse:
+      type: object
+      properties:
+        explanation:
+          type: string
+          description: An explanation of what the foreign language phrase means, and when you might use it.
+    explainTaskRequest:
+      type: object
+      required:
+        - task_description
+        - learning_language
+        - native_language
+        - additional_context
+        - full_query
+      properties:
+        task_description:
+          type: string
+          description: Description of the task that the user wants to accomplish or do. For example, "tell the waiter they messed up my order" or "compliment someone on their shirt"
+        learning_language:
+          type: string
+          description: The foreign language that the user is learning and asking about. The value can be inferred from question - for example, if the user asks "how do i ask a girl out in mexico city", the value should be "Spanish" because of Mexico City. Always use the full name of the language (e.g. Spanish, French).
+        native_language:
+          type: string
+          description: The user's native language. Infer this value from the language the user asked their question in. Always use the full name of the language (e.g. Spanish, French).
+        additional_context:
+          type: string
+          description: A description of any additional context in the user's question that could affect the explanation - e.g. setting, scenario, situation, tone, speaking style and formality, usage notes, or any other qualifiers.
+        full_query:
+          type: string
+          description: Full text of the user's question.
+    explainTaskResponse:
+      type: object
+      properties:
+        explanation:
+          type: string
+          description: An explanation of the best thing to say in the foreign language to accomplish the task described in the user's question.

camel/functions/openai_function.py

@@ -171,7 +171,6 @@ class OpenAIFunction:
         self.openai_tool_schema = openai_tool_schema or get_openai_tool_schema(
             func
         )
-        self.properties = self.openai_tool_schema
 
     @staticmethod
     def validate_openai_tool_schema(openai_tool_schema: Dict[str, Any]) -> None:
@@ -193,6 +192,9 @@ class OpenAIFunction:
             SchemaError: If the parameters do not meet JSON Schema reference
                 specifications.
         """
+        # Check the type
+        if not openai_tool_schema["type"]:
+            raise ValueError("miss type")
         # Check the function description
         if not openai_tool_schema["function"]["description"]:
             raise ValueError("miss function description")

camel/functions/retrieval_functions.py

@@ -0,0 +1,61 @@
+# =========== 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 List, Union
+
+from camel.functions import OpenAIFunction
+from camel.retrievers import AutoRetriever
+from camel.types import StorageType
+
+
+def information_retrieval(
+    query: str, content_input_paths: Union[str, List[str]]
+) -> str:
+    r"""Retrieves information from a local vector storage based on the
+    specified query. This function connects to a local vector storage system
+    and retrieves relevant information by processing the input query. It is
+    essential to use this function when the answer to a question requires
+    external knowledge sources.
+
+    Args:
+        query (str): The question or query for which an answer is required.
+        content_input_paths (Union[str, List[str]]): Paths to local
+            files or remote URLs.
+
+    Returns:
+        str: The information retrieved in response to the query, aggregated
+            and formatted as a string.
+
+    Example:
+        # Retrieve information about CAMEL AI.
+        information_retrieval(query = "what is CAMEL AI?",
+                            content_input_paths="https://www.camel-ai.org/")
+    """
+    auto_retriever = AutoRetriever(
+        vector_storage_local_path="camel/temp_storage",
+        storage_type=StorageType.QDRANT,
+    )
+
+    retrieved_info = auto_retriever.run_vector_retriever(
+        query=query, content_input_paths=content_input_paths, top_k=3
+    )
+    return retrieved_info
+
+
+# add the function to OpenAIFunction list
+RETRIEVAL_FUNCS: List[OpenAIFunction] = [
+    OpenAIFunction(func)
+    for func in [
+        information_retrieval,
+    ]
+]

camel/functions/slack_functions.py

@@ -0,0 +1,275 @@
+# =========== 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 __future__ import annotations
+
+import json
+import logging
+import os
+from typing import TYPE_CHECKING, List, Optional
+
+if TYPE_CHECKING:
+    from ssl import SSLContext
+
+    from slack_sdk import WebClient
+
+from slack_sdk.errors import SlackApiError
+
+from camel.functions import OpenAIFunction
+
+logger = logging.getLogger(__name__)
+
+
+def _login_slack(
+    slack_token: Optional[str] = None,
+    ssl: Optional[SSLContext] = None,
+) -> WebClient:
+    r"""Authenticate using the Slack API.
+
+    Args:
+        slack_token (str, optional): The Slack API token. If not provided, it
+            attempts to retrieve the token from the environment variable
+            SLACK_BOT_TOKEN or SLACK_USER_TOKEN.
+        ssl (SSLContext, optional): SSL context for secure connections.
+            Defaults to `None`.
+
+    Returns:
+        WebClient: A WebClient object for interacting with Slack API.
+
+    Raises:
+        ImportError: If slack_sdk package is not installed.
+        KeyError: If SLACK_BOT_TOKEN or SLACK_USER_TOKEN environment variables
+            are not set.
+    """
+    try:
+        from slack_sdk import WebClient
+    except ImportError as e:
+        raise ImportError(
+            "Cannot import slack_sdk. Please install the package with \
+            `pip install slack_sdk`."
+        ) from e
+    if not slack_token:
+        slack_token = os.environ.get("SLACK_BOT_TOKEN") or os.environ.get(
+            "SLACK_USER_TOKEN"
+        )
+        if not slack_token:
+            raise KeyError(
+                "SLACK_BOT_TOKEN or SLACK_USER_TOKEN environment variable not set."
+            )
+
+    client = WebClient(token=slack_token, ssl=ssl)
+    logger.info("Slack login successful.")
+    return client
+
+
+def create_slack_channel(name: str, is_private: Optional[bool] = True) -> str:
+    r"""Creates a new slack channel, either public or private.
+
+    Args:
+        name (str): Name of the public or private channel to create.
+        is_private (bool, optional): Whether to create a private channel
+            instead of a public one. Defaults to `True`.
+
+    Returns:
+        str: JSON string containing information about Slack channel created.
+
+    Raises:
+        SlackApiError: If there is an error during get slack channel
+            information.
+    """
+    try:
+        slack_client = _login_slack()
+        response = slack_client.conversations_create(
+            name=name, is_private=is_private
+        )
+        channel_id = response["channel"]["id"]
+        response = slack_client.conversations_archive(channel=channel_id)
+        return str(response)
+    except SlackApiError as e:
+        return f"Error creating conversation: {e.response['error']}"
+
+
+def join_slack_channel(channel_id: str) -> str:
+    r"""Joins an existing Slack channel.
+
+    Args:
+        channel_id (str): The ID of the Slack channel to join.
+
+    Returns:
+        str: A confirmation message indicating whether join successfully or an
+            error message.
+
+    Raises:
+        SlackApiError: If there is an error during get slack channel
+            information.
+    """
+    try:
+        slack_client = _login_slack()
+        response = slack_client.conversations_join(channel=channel_id)
+        return str(response)
+    except SlackApiError as e:
+        return f"Error creating conversation: {e.response['error']}"
+
+
+def leave_slack_channel(channel_id: str) -> str:
+    r"""Leaves an existing Slack channel.
+
+    Args:
+        channel_id (str): The ID of the Slack channel to leave.
+
+    Returns:
+        str: A confirmation message indicating whether leave successfully or an
+            error message.
+
+    Raises:
+        SlackApiError: If there is an error during get slack channel
+            information.
+    """
+    try:
+        slack_client = _login_slack()
+        response = slack_client.conversations_leave(channel=channel_id)
+        return str(response)
+    except SlackApiError as e:
+        return f"Error creating conversation: {e.response['error']}"
+
+
+def get_slack_channel_information() -> str:
+    r"""Retrieve Slack channels and return relevant information in JSON format.
+
+    Returns:
+        str: JSON string containing information about Slack channels.
+
+    Raises:
+        SlackApiError: If there is an error during get slack channel
+            information.
+    """
+    try:
+        slack_client = _login_slack()
+        response = slack_client.conversations_list()
+        conversations = response["channels"]
+        # Filtering conversations and extracting required information
+        filtered_result = [
+            {
+                key: conversation[key]
+                for key in ("id", "name", "created", "num_members")
+            }
+            for conversation in conversations
+            if all(
+                key in conversation
+                for key in ("id", "name", "created", "num_members")
+            )
+        ]
+        return json.dumps(filtered_result, ensure_ascii=False)
+    except SlackApiError as e:
+        return f"Error creating conversation: {e.response['error']}"
+
+
+def get_slack_channel_message(channel_id: str) -> str:
+    r"""Retrieve messages from a Slack channel.
+
+    Args:
+        channel_id (str): The ID of the Slack channel to retrieve messages
+            from.
+
+    Returns:
+        str: JSON string containing filtered message data.
+
+    Raises:
+        SlackApiError: If there is an error during get slack channel message.
+    """
+    try:
+        slack_client = _login_slack()
+        result = slack_client.conversations_history(channel=channel_id)
+        messages = result["messages"]
+        filtered_messages = [
+            {key: message[key] for key in ("user", "text", "ts")}
+            for message in messages
+            if all(key in message for key in ("user", "text", "ts"))
+        ]
+        return json.dumps(filtered_messages, ensure_ascii=False)
+    except SlackApiError as e:
+        return f"Error retrieving messages: {e.response['error']}"
+
+
+def send_slack_message(
+    message: str,
+    channel_id: str,
+    user: Optional[str] = None,
+) -> str:
+    r"""Send a message to a Slack channel.
+
+    Args:
+        message (str): The message to send.
+        channel_id (str): The ID of the Slack channel to send message.
+        user (Optional[str]): The user ID of the recipient. Defaults to `None`.
+
+    Returns:
+        str: A confirmation message indicating whether the message was sent
+            successfully or an error message.
+
+    Raises:
+        SlackApiError: If an error occurs while sending the message.
+    """
+    try:
+        slack_client = _login_slack()
+        if user:
+            response = slack_client.chat_postEphemeral(
+                channel=channel_id, text=message, user=user
+            )
+        else:
+            response = slack_client.chat_postMessage(
+                channel=channel_id, text=message
+            )
+        return str(response)
+    except SlackApiError as e:
+        return f"Error creating conversation: {e.response['error']}"
+
+
+def delete_slack_message(
+    time_stamp: str,
+    channel_id: str,
+) -> str:
+    r"""Delete a message to a Slack channel.
+
+    Args:
+        time_stamp (str): Timestamp of the message to be deleted.
+        channel_id (str): The ID of the Slack channel to delete message.
+
+    Returns:
+        str: A confirmation message indicating whether the message was delete
+            successfully or an error message.
+
+    Raises:
+        SlackApiError: If an error occurs while sending the message.
+    """
+    try:
+        slack_client = _login_slack()
+        response = slack_client.chat_delete(channel=channel_id, ts=time_stamp)
+        return str(response)
+    except SlackApiError as e:
+        return f"Error creating conversation: {e.response['error']}"
+
+
+SLACK_FUNCS: List[OpenAIFunction] = [
+    OpenAIFunction(func)  # type: ignore[arg-type]
+    for func in [
+        create_slack_channel,
+        join_slack_channel,
+        leave_slack_channel,
+        get_slack_channel_information,
+        get_slack_channel_message,
+        send_slack_message,
+        delete_slack_message,
+    ]
+]

camel/models/__init__.py

@@ -15,6 +15,7 @@ from .anthropic_model import AnthropicModel
 from .base_model import BaseModelBackend
 from .model_factory import ModelFactory
 from .open_source_model import OpenSourceModel
+from .openai_audio_models import OpenAIAudioModels
 from .openai_model import OpenAIModel
 from .stub_model import StubModel
 
@@ -25,4 +26,5 @@ __all__ = [
     'StubModel',
     'OpenSourceModel',
     'ModelFactory',
+    'OpenAIAudioModels',
 ]

camel/models/anthropic_model.py

@@ -27,10 +27,24 @@ class AnthropicModel(BaseModelBackend):
     r"""Anthropic API in a unified BaseModelBackend interface."""
 
     def __init__(
-        self, model_type: ModelType, model_config_dict: Dict[str, Any]
+        self,
+        model_type: ModelType,
+        model_config_dict: Dict[str, Any],
+        api_key: Optional[str] = None,
     ) -> None:
+        r"""Constructor for Anthropic backend.
+
+        Args:
+            model_type (ModelType): Model for which a backend is created,
+                one of GPT_* series.
+            model_config_dict (Dict[str, Any]): A dictionary that will
+                be fed into openai.ChatCompletion.create().
+            api_key (Optional[str]): The API key for authenticating with the
+                Anthropic service. (default: :obj:`None`)
+        """
         super().__init__(model_type, model_config_dict)
-        self.client = Anthropic(api_key=os.environ["ANTHROPIC_API_KEY"])
+        self._api_key = api_key or os.environ.get("ANTHROPIC_API_KEY")
+        self.client = Anthropic(api_key=self._api_key)
         self._token_counter: Optional[BaseTokenCounter] = None
 
     def _convert_response_from_anthropic_to_openai(self, response):