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

weco/client.py

@@ -25,14 +25,21 @@ class WecoAI:
     """A client for the WecoAI function builder API that allows users to build and query specialized functions built by LLMs.
     The user must simply provide a task description to build a function, and then query the function with an input to get the result they need.
     Our client supports both synchronous and asynchronous request paradigms and uses HTTP/2 for faster communication with the API.
+    Support for multimodality is included.
 
     Attributes
     ----------
     api_key : str
         The API key used for authentication.
+
+    timeout : float
+        The timeout for the HTTP requests in seconds. Default is 120.0.
+
+    http2 : bool
+        Whether to use HTTP/2 protocol for the HTTP requests. Default is True.
     """
 
-    def __init__(self, api_key: str = None, timeout: float = 120.0, http2: bool = True) -> None:
+    def __init__(self, api_key: Union[str, None] = None, timeout: float = 120.0, http2: bool = True) -> None:
         """Initializes the WecoAI client with the provided API key and base URL.
 
         Parameters
@@ -41,7 +48,7 @@ class WecoAI:
             The API key used for authentication. If not provided, the client will attempt to read it from the environment variable - WECO_API_KEY.
 
         timeout : float, optional
-            The timeout for the HTTP requests in seconds (default is 30.0).
+            The timeout for the HTTP requests in seconds (default is 120.0).
 
         http2 : bool, optional
             Whether to use HTTP/2 protocol for the HTTP requests (default is True).
@@ -146,24 +153,29 @@ class WecoAI:
         for _warning in response.get("warnings", []):
             warnings.warn(_warning)
 
-        return {
+        returned_response = {
             "output": response["response"],
             "in_tokens": response["num_input_tokens"],
             "out_tokens": response["num_output_tokens"],
             "latency_ms": response["latency_ms"],
         }
+        if "reasoning_steps" in response:
+            returned_response["reasoning_steps"] = response["reasoning_steps"]
+        return returned_response
 
-    def _build(self, task_description: str, multimodal: bool, is_async: bool) -> Union[Tuple[str, int, str], Coroutine[Any, Any, Tuple[str, int, 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.
 
@@ -205,7 +217,7 @@ class WecoAI:
         ----------
         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).
 
@@ -223,7 +235,7 @@ class WecoAI:
         ----------
         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).
 
@@ -378,7 +390,13 @@ class WecoAI:
         return image_info
 
     def _query(
-        self, is_async: bool, fn_name: str, version_number: Optional[int], 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]],
+        return_reasoning: Optional[bool]
     ) -> Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]:
         """Internal method to handle both synchronous and asynchronous query requests.
 
@@ -394,6 +412,8 @@ class WecoAI:
             The text input to the function.
         images_input : List[str], optional
             A list of image URLs or images encoded in base64 with their metadata to be sent as input to the function.
+        return_reasoning : bool, optional
+            Whether to return reasoning for the output.
 
         Returns
         -------
@@ -405,8 +425,6 @@ 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)
 
@@ -422,7 +440,7 @@ class WecoAI:
 
         # Make the request
         endpoint = "query"
-        data = {"name": fn_name, "text": text_input, "images": image_urls, "version_number": version_number}
+        data = {"name": fn_name, "text": text_input, "images": image_urls, "version_number": version_number, "return_reasoning": return_reasoning}
         request = self._make_request(endpoint=endpoint, data=data, is_async=is_async)
 
         if is_async:
@@ -437,7 +455,12 @@ class WecoAI:
             return self._process_query_response(response=response)
 
     async def aquery(
-        self, fn_name: str, version_number: Optional[int] = -1, 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]] = [],
+        return_reasoning: Optional[bool] = False
     ) -> Dict[str, Any]:
         """Asynchronously queries a function with the given function ID and input.
 
@@ -451,6 +474,8 @@ class WecoAI:
             The text input to the function.
         images_input : List[str], optional
             A list of image URLs or images encoded in base64 with their metadata to be sent as input to the function.
+        return_reasoning : bool, optional
+            Whether to return reasoning for the output. Default is False.
 
         Returns
         -------
@@ -458,9 +483,18 @@ 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, version_number=version_number, text_input=text_input, images_input=images_input, is_async=True)
-
-    def query(self, fn_name: str, version_number: Optional[int] = -1, text_input: Optional[str] = "", images_input: Optional[List[str]] = []) -> Dict[str, Any]:
+        return await self._query(
+            fn_name=fn_name, version_number=version_number, text_input=text_input, images_input=images_input, return_reasoning=return_reasoning, is_async=True
+        )
+
+    def query(
+        self,
+        fn_name: str,
+        version_number: Optional[int] = -1,
+        text_input: Optional[str] = "",
+        images_input: Optional[List[str]] = [],
+        return_reasoning: Optional[bool] = False
+    ) -> Dict[str, Any]:
         """Synchronously queries a function with the given function ID and input.
 
         Parameters
@@ -473,30 +507,36 @@ class WecoAI:
             The text input to the function.
         images_input : List[str], optional
             A list of image URLs or images encoded in base64 with their metadata to be sent as input to the function.
+        return_reasoning : bool, optional
+            Whether to return reasoning for the output. Default is False.
 
         Returns
         -------
         dict
-               A dictionary containing the output of the function, the number of input tokens, the number of output tokens,
+            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, version_number=version_number, text_input=text_input, images_input=images_input, is_async=False)
+        return self._query(
+            fn_name=fn_name, version_number=version_number, text_input=text_input, images_input=images_input, return_reasoning=return_reasoning, is_async=False
+        )
 
-    def batch_query(self, fn_name: str, batch_inputs: List[Dict[str, Any]], version_number: Optional[int] = -1) -> List[Dict[str, Any]]:
+    def batch_query(
+        self, fn_name: str, batch_inputs: List[Dict[str, Any]], version_number: Optional[int] = -1, return_reasoning: Optional[bool] = False
+    ) -> List[Dict[str, Any]]:
         """Batch queries a function version with a list of inputs.
 
         Parameters
         ----------
         fn_name : str
             The name of the function or a list of function names to query.
-
         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", ...]}.
-        
         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.
+        return_reasoning : bool, optional
+            Whether to return reasoning for the output. Default is False.
 
         Returns
         -------
@@ -504,11 +544,11 @@ class WecoAI:
             A list of dictionaries, each containing the output of a function query,
             in the same order as the input queries.
         """
+
         async def run_queries():
-            tasks = list(map(
-                lambda fn_input: self.aquery(fn_name=fn_name, version_number=version_number, **fn_input),
-                batch_inputs
-            ))
+            tasks = list(
+                map(lambda fn_input: self.aquery(fn_name=fn_name, version_number=version_number, return_reasoning=return_reasoning, **fn_input), batch_inputs)
+            )
             return await asyncio.gather(*tasks)
 
         return asyncio.run(run_queries())

weco/functional.py

@@ -48,7 +48,12 @@ async def abuild(task_description: str, multimodal: bool = False, api_key: str =
 
 
 def query(
-    fn_name: str, version_number: Optional[int] = -1, 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]] = [],
+    return_reasoning: Optional[bool] = False,
+    api_key: Optional[str] = None,
 ) -> Dict[str, Any]:
     """Queries a function synchronously with the given function ID and input.
 
@@ -62,6 +67,8 @@ def query(
         The text input to the function.
     images_input : List[str], optional
         A list of image URLs or base64 encoded images to be used as input to the function.
+    return_reasoning : bool, optional
+        A flag to indicate if the reasoning should be returned. 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.
 
@@ -72,12 +79,17 @@ def query(
         and the latency in milliseconds.
     """
     client = WecoAI(api_key=api_key)
-    response = client.query(fn_name=fn_name, version_number=version_number, 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_reasoning=return_reasoning)
     return response
 
 
 async def aquery(
-    fn_name: str, version_number: Optional[int] = -1, 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]] = [],
+    return_reasoning: Optional[bool] = False,
+    api_key: Optional[str] = None,
 ) -> Dict[str, Any]:
     """Queries a function asynchronously with the given function ID and input.
 
@@ -91,6 +103,8 @@ async def aquery(
         The text input to the function.
     images_input : List[str], optional
         A list of image URLs to be used as input to the function.
+    return_reasoning : bool, optional
+        A flag to indicate if the reasoning should be returned. 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.
 
@@ -101,12 +115,14 @@ async def aquery(
         and the latency in milliseconds.
     """
     client = WecoAI(api_key=api_key)
-    response = await client.aquery(fn_name=fn_name, version_number=version_number, 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_reasoning=return_reasoning
+    )
     return response
 
 
 def batch_query(
-    fn_name: str, batch_inputs: List[Dict[str, Any]], version_number: Optional[int] = -1, api_key: Optional[str] = None
+    fn_name: str, batch_inputs: List[Dict[str, Any]], version_number: Optional[int] = -1, return_reasoning: Optional[bool] = False, api_key: Optional[str] = None
 ) -> List[Dict[str, Any]]:
     """Synchronously queries multiple functions using asynchronous calls internally.
 
@@ -119,15 +135,14 @@ def batch_query(
         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[str]
        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", ...]}.
-
     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.
-
+    return_reasoning : bool, optional
+        A flag to indicate if the reasoning should be returned. Default is False.
     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.
 
@@ -138,5 +153,5 @@ def batch_query(
         in the same order as the input queries.
     """
     client = WecoAI(api_key=api_key)
-    responses = client.batch_query(fn_name=fn_name, version_number=version_number, batch_inputs=batch_inputs)
+    responses = client.batch_query(fn_name=fn_name, version_number=version_number, batch_inputs=batch_inputs, return_reasoning=return_reasoning)
     return responses

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: weco
-Version: 0.1.6
+Version: 0.1.8
 Summary: A client facing API for interacting with the WeCo AI function builder service.
 Author-email: WeCo AI Team <dhruv@weco.ai>
 License: MIT
@@ -52,12 +52,16 @@ pip install weco
 ```
 
 ## Features
+- Synchronous & Asynchronous client.
+- Batch API
+- Multimodality (Language & Vision)
+- Interpretability (view the reasoning behind outputs)
+
+
+## What We Offer
 
 - The **build** function enables quick and easy prototyping of new functions via LLMs through just natural language. We encourage users to do this through our [web console](https://weco-app.vercel.app/function) for maximum control and ease of use, however, you can also do this through our API as shown in [here](examples/cookbook.ipynb).
 - The **query** function allows you to test and use the newly created function in your own code.
-- We offer asynchronous versions of the above clients.
-- We provide a **batch_query** functions that allows users to batch functions for various inputs as well as multiple inputs for the same function in a query. This is helpful to make a large number of queries more efficiently.
-- We also offer multimodality capabilities. You can now query our client with both **language** AND **vision** inputs!
 
 We provide both services in two ways:
 - `weco.WecoAI` client to be used when you want to maintain the same client service across a portion of code. This is better for dense service usage.

weco-0.1.8.dist-info/RECORD

@@ -0,0 +1,10 @@
+weco/__init__.py,sha256=qiKpnrm6t0n0bpAtXEKJO1Yz2xYXnJJRZBWt-cH7DdU,168
+weco/client.py,sha256=l0H62JxDsfiF4vW2v5GEUhf6IEWX3m9_oFy7A-Wf_wI,22447
+weco/constants.py,sha256=eoAq-9qN2aZrqyIWdrb3V1zomV5kp80PfxxoPoQNMNI,167
+weco/functional.py,sha256=hFUFCWIlWDadaPAFpjl0cLF0ExysTYuld8Uwza_hyqM,6853
+weco/utils.py,sha256=UUSw6ocqWdlSmIXVcH66DAL4NuLU2rFOyviD8aTWsv0,4371
+weco-0.1.8.dist-info/LICENSE,sha256=NvpxfBuSajszAczWBGKxhHe4gsvil1H63zmu8xXZdL0,1064
+weco-0.1.8.dist-info/METADATA,sha256=olHH_wAex7_djdDwleCGCoQnwXTAjTwOSLHo0SWG1JU,5716
+weco-0.1.8.dist-info/WHEEL,sha256=Mdi9PDNwEZptOjTlUcAth7XJDFtKrHYaQMPulZeBCiQ,91
+weco-0.1.8.dist-info/top_level.txt,sha256=F0N7v6e2zBSlsorFv-arAq2yDxQbzX3KVO8GxYhPUeE,5
+weco-0.1.8.dist-info/RECORD,,

{weco-0.1.6.dist-info → weco-0.1.8.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (72.1.0)
+Generator: setuptools (73.0.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

weco-0.1.6.dist-info/RECORD

@@ -1,10 +0,0 @@
-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,,