weco 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

weco/__init__.py

@@ -0,0 +1,8 @@
+from .client import WecoAI
+from .functional import build, query
+
+__all__ = [
+    "WecoAI",
+    "build",
+    "query",
+]

weco/client.py

@@ -0,0 +1,121 @@
+import os
+from typing import Any, Dict
+
+import requests
+
+
+class WecoAI:
+    def __init__(self, api_key: str = None) -> None:
+        """Initializes the WecoAI client with the provided API key and base URL.
+
+        Parameters
+        ----------
+        api_key : str
+            The API key used for authentication. If not provided, the client will attempt to read it from the environment variable - WECO_API_KEY.
+        base_url : str
+            The base URL of the WecoAI API.
+
+        Raises
+        ------
+        ValueError
+            If the API key is not provided to the client, is not set as an environment variable or is not a string.
+        """
+        # Manage the API key
+        if api_key is None or not isinstance(api_key, str):
+            try:
+                api_key = os.environ["WECO_API_KEY"]
+            except KeyError:
+                raise ValueError(
+                    "WECO_API_KEY must be passed to client or set as an environment variable"
+                )
+        self.api_key = api_key
+
+        # base URL
+        self.base_url = "https://function-builder.vercel.app"
+
+    def _headers(self) -> Dict[str, str]:
+        """Constructs the headers for the API requests.
+
+        Returns
+        -------
+        dict
+            A dictionary containing the headers.
+        """
+        return {
+            "Authorization": f"Bearer {self.api_key}",
+            "Content-Type": "application/json",
+        }
+
+    def _post(self, endpoint: str, data: Dict[str, Any]) -> Dict[str, Any]:
+        """Makes a POST request to the specified endpoint with the provided data.
+
+        Parameters
+        ----------
+        endpoint : str
+            The API endpoint to which the request will be made.
+        data : dict
+            The data to be sent in the request body.
+
+        Returns
+        -------
+        dict
+            The response from the server as a dictionary.
+
+        Raises
+        ------
+        requests.HTTPError
+            If the request fails.
+        """
+        url = f"{self.base_url}/{endpoint}"
+        response = requests.post(url, json=data, headers=self._headers())
+        response.raise_for_status()
+        return response.json()
+
+    def build(self, task_description: str) -> tuple[str, str]:
+        """Builds a specialized function given a task description.
+
+        Parameters
+        ----------
+        task_description : str
+            A description of the task for which the function is being built.
+
+        Returns
+        -------
+        tuple[str, str]
+            A tuple containing the name and description of the function.
+        """
+        endpoint = "build"
+        data = {"request": task_description}
+        response = self._post(endpoint, data)
+        return response["name"], response["description"]
+
+    def query(self, fn_name: str, fn_input: str) -> Dict[str, Any]:
+        """Queries a function with the given function ID and input.
+
+        Parameters
+        ----------
+        fn_name : str
+            The name of the function to query.
+        fn_input : str
+            The input to the function.
+
+        Returns
+        -------
+        dict
+            A dictionary containing the output of the function, the number of input tokens, the number of output tokens,
+            and the latency in milliseconds.
+        """
+
+        endpoint = "query"
+        data = {
+            "name": fn_name,
+            "user_message": fn_input,
+        }
+        response = self._post(endpoint, data)
+        result = {
+            "output": response["response"],
+            "in_tokens": response["num_input_tokens"],
+            "out_tokens": response["num_output_tokens"],
+            "latency_ms": response["latency_ms"],
+        }
+        return result

weco/functional.py

@@ -0,0 +1,46 @@
+from typing import Any, Dict, Optional
+
+from .client import WecoAI
+
+
+def build(task_description: str, api_key: str = None) -> tuple[str, str]:
+    """Builds a specialized function given a task description.
+
+    Parameters
+    ----------
+    task_description : str
+        A description of the task for which the function is being built.
+    api_key : str
+        The API key for the WecoAI service. If not provided, the API key must be set using the environment variable - WECO_API_KEY.
+
+    Returns
+    -------
+    tuple[str, str]
+        A tuple containing the name and description of the function.
+    """
+    client = WecoAI(api_key=api_key)
+    response = client.build(task_description=task_description)
+    return response
+
+
+def query(fn_name: str, fn_input: str, api_key: Optional[str] = None) -> Dict[str, Any]:
+    """Queries a function with the given function ID and input.
+
+    Parameters
+    ----------
+    fn_name : str
+        The name of the function to query.
+    fn_input : str
+        The input to the function.
+    api_key : str
+        The API key for the WecoAI service. If not provided, the API key must be set using the environment variable - WECO_API_KEY.
+
+    Returns
+    -------
+    dict
+        A dictionary containing the output of the function, the number of input tokens, the number of output tokens,
+        and the latency in milliseconds.
+    """
+    client = WecoAI(api_key=api_key)
+    response = client.query(fn_name=fn_name, fn_input=fn_input)
+    return response

{weco-0.1.0.dist-info → weco-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: weco
-Version: 0.1.0
+Version: 0.1.1
 Summary: A client facing API for interacting with the WeCo AI function builder service.
 Home-page: https://github.com/WecoAI/weco
 Author: ['WeCo AI Team']

weco-0.1.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+weco/__init__.py,sha256=Xl80uFblDNbhIxL3_BQgYc_SninCeOeF0shnzPCrxrw,119
+weco/client.py,sha256=YOUgWJwLKlp9GR2u40pmnjaBtmDjLtdP_pUuvDAMCJQ,3744
+weco/functional.py,sha256=AnQ0PaZKr2K9a7wxXfVPJTTJLgrn1niZDQctdkj5vFA,1501
+weco-0.1.1.dist-info/LICENSE,sha256=NvpxfBuSajszAczWBGKxhHe4gsvil1H63zmu8xXZdL0,1064
+weco-0.1.1.dist-info/METADATA,sha256=ieRckEKjQ-shxHf5VPcNCHENd6CUpJz3i43-EeLSnMw,3214
+weco-0.1.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+weco-0.1.1.dist-info/top_level.txt,sha256=F0N7v6e2zBSlsorFv-arAq2yDxQbzX3KVO8GxYhPUeE,5
+weco-0.1.1.dist-info/RECORD,,

weco-0.1.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+weco

weco-0.1.0.dist-info/RECORD

@@ -1,5 +0,0 @@
-weco-0.1.0.dist-info/LICENSE,sha256=NvpxfBuSajszAczWBGKxhHe4gsvil1H63zmu8xXZdL0,1064
-weco-0.1.0.dist-info/METADATA,sha256=ea8ara4e-SA2DxtiUbnxZqSN9yR1iFFiDwxF671veiQ,3214
-weco-0.1.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-weco-0.1.0.dist-info/top_level.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-weco-0.1.0.dist-info/RECORD,,

weco-0.1.0.dist-info/top_level.txt

@@ -1 +0,0 @@
-