weco 0.1.4__py3-none-any.whl → 0.1.6__py3-none-any.whl

weco/client.py

@@ -65,11 +65,6 @@ class WecoAI:
         self.client = httpx.Client(http2=http2, timeout=timeout)
         self.async_client = httpx.AsyncClient(http2=http2, timeout=timeout)
 
-    def close(self):
-        """Close both synchronous and asynchronous clients."""
-        self.client.close()
-        asyncio.run(self.async_client.aclose())
-
     def _headers(self) -> Dict[str, str]:
         """Constructs the headers for the API requests."""
         return {
@@ -158,20 +153,24 @@ class WecoAI:
             "latency_ms": response["latency_ms"],
         }
 
-    def _build(self, task_description: str, is_async: bool) -> Union[Tuple[str, str], Coroutine[Any, Any, Tuple[str, str]]]:
+    def _build(self, task_description: str, multimodal: bool, is_async: bool) -> Union[Tuple[str, int, str], Coroutine[Any, Any, Tuple[str, int, str]]]:
         """Internal method to handle both synchronous and asynchronous build requests.
 
         Parameters
         ----------
         task_description : str
             A description of the task for which the function is being built.
+        
+        multimodal : bool
+            Whether the function is multimodal or not.
+        
         is_async : bool
             Whether to perform an asynchronous request.
 
         Returns
         -------
-        Union[tuple[str, str], Coroutine[Any, Any, tuple[str, str]]]
-            A tuple containing the name and description of the function, or a coroutine that returns such a tuple.
+        Union[tuple[str, int, str], Coroutine[Any, Any, tuple[str, int, str]]]
+            A tuple containing the name, version number and description of the function, or a coroutine that returns such a tuple.
 
         Raises
         ------
@@ -185,51 +184,57 @@ class WecoAI:
             raise ValueError(f"Task description must be less than {MAX_TEXT_LENGTH} characters.")
 
         endpoint = "build"
-        data = {"request": task_description}
+        data = {"request": task_description, "multimodal": multimodal}
         request = self._make_request(endpoint=endpoint, data=data, is_async=is_async)
 
         if is_async:
-
+            # return 0 for the version number
             async def _async_build():
                 response = await request
-                return response["name"], response["description"]
+                return response["function_name"], 0, response["description"]
 
             return _async_build()
         else:
             response = request  # the request has already been made and the response is available
-            return response["name"], response["description"]
+            return response["function_name"], 0, response["description"]
 
-    async def abuild(self, task_description: str) -> Tuple[str, str]:
+    async def abuild(self, task_description: str, multimodal: bool = False) -> Tuple[str, int, str]:
         """Asynchronously builds a specialized function given a task description.
 
         Parameters
         ----------
         task_description : str
             A description of the task for which the function is being built.
+        
+        multimodal : bool, optional
+            Whether the function is multimodal or not (default is False).
 
         Returns
         -------
         tuple[str, str]
-            A tuple containing the name and description of the function.
+            A tuple containing the name, version number and description of the function.
         """
-        return await self._build(task_description=task_description, is_async=True)
+        return await self._build(task_description=task_description, multimodal=multimodal, is_async=True)
 
-    def build(self, task_description: str) -> Tuple[str, str]:
+    def build(self, task_description: str, multimodal: bool = False) -> Tuple[str, int, str]:
         """Synchronously builds a specialized function given a task description.
 
         Parameters
         ----------
         task_description : str
             A description of the task for which the function is being built.
+        
+        multimodal : bool, optional
+            Whether the function is multimodal or not (default is False).
 
         Returns
         -------
         tuple[str, str]
-            A tuple containing the name and description of the function.
+            A tuple containing the name, version number and description of the function.
         """
-        return self._build(task_description=task_description, is_async=False)
+        return self._build(task_description=task_description, multimodal=multimodal, is_async=False)
 
-    def _upload_image(self, fn_name: str, upload_id: str, image_info: Dict[str, Any]) -> str:
+    def _upload_image(self, fn_name: str, version_number: int, upload_id: str, image_info: Dict[str, Any]) -> str:
         """
         Uploads an image to an S3 bucket and returns the URL of the uploaded image.
 
@@ -237,6 +242,8 @@ class WecoAI:
         ----------
         fn_name : str
             The name of the function for which the image is being uploaded.
+        version_number : int
+            The version number of the function for which the image is being uploaded.
         upload_id: str
             A unique identifier for the image upload.
         image_info : Dict[str, Any]
@@ -271,13 +278,12 @@ class WecoAI:
 
         # Request a presigned URL from the server
         endpoint = "upload_link"
-        request_data = {"fn_name": fn_name, "upload_id": upload_id, "file_type": file_type}
+        request_data = {"fn_name": fn_name, "version_number": version_number, "upload_id": upload_id, "file_type": file_type}
         # This needs to be a synchronous request since we need the presigned URL to upload the image
         response = self._make_request(endpoint=endpoint, data=request_data, is_async=False)
 
         # Upload the image to the S3 bucket
-        image_name = generate_random_base16_code()
-        files = {"file": (f"{image_name}.{file_type}", upload_data)}
+        files = {"file": upload_data}
         http_response = requests.post(response["url"], data=response["fields"], files=files)
         if http_response.status_code == 204:
             pass
@@ -372,7 +378,7 @@ class WecoAI:
         return image_info
 
     def _query(
-        self, is_async: bool, fn_name: str, text_input: Optional[str], images_input: Optional[List[str]]
+        self, is_async: bool, fn_name: str, version_number: Optional[int], text_input: Optional[str], images_input: Optional[List[str]]
     ) -> Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]:
         """Internal method to handle both synchronous and asynchronous query requests.
 
@@ -382,6 +388,8 @@ class WecoAI:
             Whether to perform an asynchronous request.
         fn_name : str
             The name of the function to query.
+        version_number : int, optional
+            The version number of the function to query.
         text_input : str, optional
             The text input to the function.
         images_input : List[str], optional
@@ -397,6 +405,8 @@ class WecoAI:
         ValueError
             If the input is invalid.
         """
+        warnings.warn("Setting the version number of the function is not yet supported. Currently, the first version of the function will be used i.e., version 0.")
+        version_number = 0
         # Validate the input
         image_info = self._validate_query(text_input=text_input, images_input=images_input)
 
@@ -405,14 +415,14 @@ class WecoAI:
         upload_id = generate_random_base16_code()
         for i, info in enumerate(image_info):
             if info["source"] == "url" or info["source"] == "base64" or info["source"] == "local":
-                url = self._upload_image(fn_name=fn_name, upload_id=upload_id, image_info=info)
+                url = self._upload_image(fn_name=fn_name, version_number=version_number, upload_id=upload_id, image_info=info)
             else:
                 raise ValueError(f"Image at index {i} must be a public URL or a path to a local image file.")
             image_urls.append(url)
 
         # Make the request
         endpoint = "query"
-        data = {"name": fn_name, "text": text_input, "images": image_urls}
+        data = {"name": fn_name, "text": text_input, "images": image_urls, "version_number": version_number}
         request = self._make_request(endpoint=endpoint, data=data, is_async=is_async)
 
         if is_async:
@@ -427,7 +437,7 @@ class WecoAI:
             return self._process_query_response(response=response)
 
     async def aquery(
-        self, fn_name: str, text_input: Optional[str] = "", images_input: Optional[List[str]] = []
+        self, fn_name: str, version_number: Optional[int] = -1, text_input: Optional[str] = "", images_input: Optional[List[str]] = []
     ) -> Dict[str, Any]:
         """Asynchronously queries a function with the given function ID and input.
 
@@ -435,6 +445,8 @@ class WecoAI:
         ----------
         fn_name : str
             The name of the function to query.
+        version_number : int, optional
+            The version number of the function to query. If not provided, the latest version will be used. Pass -1 to use the latest version.
         text_input : str, optional
             The text input to the function.
         images_input : List[str], optional
@@ -446,15 +458,17 @@ class WecoAI:
             A dictionary containing the output of the function, the number of input tokens, the number of output tokens,
             and the latency in milliseconds.
         """
-        return await self._query(fn_name=fn_name, text_input=text_input, images_input=images_input, is_async=True)
+        return await self._query(fn_name=fn_name, version_number=version_number, text_input=text_input, images_input=images_input, is_async=True)
 
-    def query(self, fn_name: str, text_input: Optional[str] = "", images_input: Optional[List[str]] = []) -> Dict[str, Any]:
+    def query(self, fn_name: str, version_number: Optional[int] = -1, text_input: Optional[str] = "", images_input: Optional[List[str]] = []) -> Dict[str, Any]:
         """Synchronously queries a function with the given function ID and input.
 
         Parameters
         ----------
         fn_name : str
             The name of the function to query.
+        version_number : int, optional
+            The version number of the function to query. If not provided, the latest version will be used. Pass -1 to use the latest version.
         text_input : str, optional
             The text input to the function.
         images_input : List[str], optional
@@ -466,49 +480,35 @@ class WecoAI:
                A dictionary containing the output of the function, the number of input tokens, the number of output tokens,
             and the latency in milliseconds.
         """
-        return self._query(fn_name=fn_name, text_input=text_input, images_input=images_input, is_async=False)
-
-    def batch_query(self, fn_names: Union[str, List[str]], batch_inputs: List[Dict[str, Any]]) -> List[Dict[str, Any]]:
-        """Synchronously queries multiple functions using asynchronous calls internally.
+        return self._query(fn_name=fn_name, version_number=version_number, text_input=text_input, images_input=images_input, is_async=False)
 
-        This method uses the asynchronous queries to submit all queries concurrently
-        and waits for all responses to be received before returning the results.
+    def batch_query(self, fn_name: str, batch_inputs: List[Dict[str, Any]], version_number: Optional[int] = -1) -> List[Dict[str, Any]]:
+        """Batch queries a function version with a list of inputs.
 
         Parameters
         ----------
-        fn_name : Union[str, List[str]]
+        fn_name : str
             The name of the function or a list of function names to query.
-            Note that if a single function name is provided, it will be used for all queries.
-            If a list of function names is provided, the length must match the number of queries.
 
         batch_inputs : List[Dict[str, Any]]
             A list of inputs for the functions to query. The input must be a dictionary containing the data to be processed. e.g.,
             when providing for a text input, the dictionary should be {"text_input": "input text"}, for an image input, the dictionary should be {"images_input": ["url1", "url2", ...]}
             and for a combination of text and image inputs, the dictionary should be {"text_input": "input text", "images_input": ["url1", "url2", ...]}.
-            Note that the index of each input must correspond to the index of the function name when both inputs are lists.
+        
+        version_number : int, optional
+            The version number of the function to query. If not provided, the latest version will be used. Pass -1 to use the latest version.
 
         Returns
         -------
         List[Dict[str, Any]]
             A list of dictionaries, each containing the output of a function query,
             in the same order as the input queries.
-
-
-        Raises
-        ------
-        ValueError
-            If the number of function names (when provided as a list) does not match the number of inputs.
         """
-        if isinstance(fn_names, str):
-            fn_names = [fn_names] * len(batch_inputs)
-        elif len(fn_names) != len(batch_inputs):
-            raise ValueError("The number of function names must match the number of inputs.")
-
         async def run_queries():
-            tasks = [
-                self.aquery(fn_name=fn_name, **fn_input)  # unpack the input kwargs
-                for fn_name, fn_input in zip(fn_names, batch_inputs)
-            ]
+            tasks = list(map(
+                lambda fn_input: self.aquery(fn_name=fn_name, version_number=version_number, **fn_input),
+                batch_inputs
+            ))
             return await asyncio.gather(*tasks)
 
         return asyncio.run(run_queries())

weco/constants.py

@@ -1,4 +1,4 @@
-MAX_TEXT_LENGTH = 10000
+MAX_TEXT_LENGTH = 1e6  # 1 million characters
 MAX_IMAGE_UPLOADS = 5
 MAX_IMAGE_SIZE_MB = 10  # 10 MB
 SUPPORTED_IMAGE_EXTENSIONS = ["png", "jpeg", "jpg", "webp", "gif"]

weco/functional.py

@@ -3,14 +3,15 @@ from typing import Any, Dict, List, Optional
 from .client import WecoAI
 
 
-# TODO: Implement the closing stuff for the client
-def build(task_description: str, api_key: str = None) -> tuple[str, str]:
+def build(task_description: str, multimodal: bool = False, api_key: str = None) -> tuple[str, int, str]:
     """Builds a specialized function synchronously given a task description.
 
     Parameters
     ----------
     task_description : str
         A description of the task for which the function is being built.
+    multimodal : bool, optional
+        A flag to indicate if the function should be multimodal. Default is False.
     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.
 
@@ -20,32 +21,34 @@ def build(task_description: str, api_key: str = None) -> 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)
+    response = client.build(task_description=task_description, multimodal=multimodal)
     return response
 
 
-async def abuild(task_description: str, api_key: str = None) -> tuple[str, str]:
+async def abuild(task_description: str, multimodal: bool = False, api_key: str = None) -> tuple[str, int, str]:
     """Builds a specialized function asynchronously given a task description.
 
     Parameters
     ----------
     task_description : str
         A description of the task for which the function is being built.
+    multimodal : bool, optional
+        A flag to indicate if the function should be multimodal. Default is False.
     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.
+        A tuple containing the name, version number and description of the function.
     """
     client = WecoAI(api_key=api_key)
-    response = await client.abuild(task_description=task_description)
+    response = await client.abuild(task_description=task_description, multimodal=multimodal)
     return response
 
 
 def query(
-    fn_name: str, text_input: Optional[str] = "", images_input: Optional[List[str]] = [], api_key: Optional[str] = None
+    fn_name: str, version_number: Optional[int] = -1, text_input: Optional[str] = "", images_input: Optional[List[str]] = [], api_key: Optional[str] = None
 ) -> Dict[str, Any]:
     """Queries a function synchronously with the given function ID and input.
 
@@ -53,6 +56,8 @@ def query(
     ----------
     fn_name : str
         The name of the function to query.
+    version_number : int, optional
+        The version number of the function to query. If not provided, the latest version is used. Default is -1 for the same behavior.
     text_input : str, optional
         The text input to the function.
     images_input : List[str], optional
@@ -67,12 +72,12 @@ def query(
         and the latency in milliseconds.
     """
     client = WecoAI(api_key=api_key)
-    response = client.query(fn_name=fn_name, text_input=text_input, images_input=images_input)
+    response = client.query(fn_name=fn_name, version_number=version_number, text_input=text_input, images_input=images_input)
     return response
 
 
 async def aquery(
-    fn_name: str, text_input: Optional[str] = "", images_input: Optional[List[str]] = [], api_key: Optional[str] = None
+    fn_name: str, version_number: Optional[int] = -1, text_input: Optional[str] = "", images_input: Optional[List[str]] = [], api_key: Optional[str] = None
 ) -> Dict[str, Any]:
     """Queries a function asynchronously with the given function ID and input.
 
@@ -80,6 +85,8 @@ async def aquery(
     ----------
     fn_name : str
         The name of the function to query.
+    version_number : int, optional
+        The version number of the function to query. If not provided, the latest version is used. Default is -1 for the same behavior.
     text_input : str, optional
         The text input to the function.
     images_input : List[str], optional
@@ -94,12 +101,12 @@ async def aquery(
         and the latency in milliseconds.
     """
     client = WecoAI(api_key=api_key)
-    response = await client.aquery(fn_name=fn_name, text_input=text_input, images_input=images_input)
+    response = await client.aquery(fn_name=fn_name, version_number=version_number, text_input=text_input, images_input=images_input)
     return response
 
 
 def batch_query(
-    fn_names: str | List[str], batch_inputs: List[Dict[str, Any]], api_key: Optional[str] = None
+    fn_name: str, batch_inputs: List[Dict[str, Any]], version_number: Optional[int] = -1, api_key: Optional[str] = None
 ) -> List[Dict[str, Any]]:
     """Synchronously queries multiple functions using asynchronous calls internally.
 
@@ -117,7 +124,9 @@ def batch_query(
        A list of inputs for the functions to query. The input must be a dictionary containing the data to be processed. e.g.,
        when providing for a text input, the dictionary should be {"text_input": "input text"}, for an image input, the dictionary should be {"images_input": ["url1", "url2", ...]}
        and for a combination of text and image inputs, the dictionary should be {"text_input": "input text", "images_input": ["url1", "url2", ...]}.
-       Note that the index of each input must correspond to the index of the function name when both inputs are lists.
+
+    version_number : int, optional
+        The version number of the function to query. If not provided, the latest version is used. Default is -1 for the same behavior.
 
     api_key : str, optional
         The API key for the WecoAI service. If not provided, the API key must be set using the environment variable - WECO_API_KEY.
@@ -129,5 +138,5 @@ def batch_query(
         in the same order as the input queries.
     """
     client = WecoAI(api_key=api_key)
-    responses = client.batch_query(fn_names=fn_names, batch_inputs=batch_inputs)
+    responses = client.batch_query(fn_name=fn_name, version_number=version_number, batch_inputs=batch_inputs)
     return responses

{weco-0.1.4.dist-info → weco-0.1.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: weco
-Version: 0.1.4
+Version: 0.1.6
 Summary: A client facing API for interacting with the WeCo AI function builder service.
 Author-email: WeCo AI Team <dhruv@weco.ai>
 License: MIT

weco-0.1.6.dist-info/RECORD

@@ -0,0 +1,10 @@
+weco/__init__.py,sha256=qiKpnrm6t0n0bpAtXEKJO1Yz2xYXnJJRZBWt-cH7DdU,168
+weco/client.py,sha256=JNpIJz-_YtWqaZHJUldK3tFI1u7wcuU65xxyRUJOdog,21322
+weco/constants.py,sha256=eoAq-9qN2aZrqyIWdrb3V1zomV5kp80PfxxoPoQNMNI,167
+weco/functional.py,sha256=gckeXFVouy4wLHj0uLwxQkRNUj0urldk1f5ZDZk4yhY,6209
+weco/utils.py,sha256=UUSw6ocqWdlSmIXVcH66DAL4NuLU2rFOyviD8aTWsv0,4371
+weco-0.1.6.dist-info/LICENSE,sha256=NvpxfBuSajszAczWBGKxhHe4gsvil1H63zmu8xXZdL0,1064
+weco-0.1.6.dist-info/METADATA,sha256=CLrbjmTuQJHzW0SUIBkah1rdU7P3Ra9PHFuf_eYd_M0,5957
+weco-0.1.6.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+weco-0.1.6.dist-info/top_level.txt,sha256=F0N7v6e2zBSlsorFv-arAq2yDxQbzX3KVO8GxYhPUeE,5
+weco-0.1.6.dist-info/RECORD,,

weco-0.1.4.dist-info/RECORD

@@ -1,10 +0,0 @@
-weco/__init__.py,sha256=qiKpnrm6t0n0bpAtXEKJO1Yz2xYXnJJRZBWt-cH7DdU,168
-weco/client.py,sha256=MGwLxV0pgZ_dighM5tvE32VbM1lspppTq8EmdZnXCfE,20608
-weco/constants.py,sha256=zIVqyFh6JQVWkPpeh7ABUvTmJ9CjQk_4LPlz4pEO0Uk,145
-weco/functional.py,sha256=MpyFaREjoPBWqY0iLgsN0JovL6cyCyNf5SzYI0i1b5w,5328
-weco/utils.py,sha256=UUSw6ocqWdlSmIXVcH66DAL4NuLU2rFOyviD8aTWsv0,4371
-weco-0.1.4.dist-info/LICENSE,sha256=NvpxfBuSajszAczWBGKxhHe4gsvil1H63zmu8xXZdL0,1064
-weco-0.1.4.dist-info/METADATA,sha256=YonF54xTkK71fPqBSuRmRcyqQDRh059LKxUpVvrZ94w,5957
-weco-0.1.4.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
-weco-0.1.4.dist-info/top_level.txt,sha256=F0N7v6e2zBSlsorFv-arAq2yDxQbzX3KVO8GxYhPUeE,5
-weco-0.1.4.dist-info/RECORD,,