weco 0.1.10__py3-none-any.whl → 0.2.0__py3-none-any.whl

weco/functional.py

@@ -1,184 +0,0 @@
-from typing import Any, Dict, List, Optional, Union
-
-from .client import WecoAI
-
-
-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.
-
-    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, multimodal=multimodal)
-    return response
-
-
-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, version number and description of the function.
-    """
-    client = WecoAI(api_key=api_key)
-    response = await client.abuild(task_description=task_description, multimodal=multimodal)
-    return response
-
-
-def query(
-    fn_name: str,
-    version: Optional[Union[str, int]] = -1,
-    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.
-
-    Parameters
-    ----------
-    fn_name : str
-        The name of the function to query.
-    version : str | int, optional
-        The version alias or number of the function to query. If not provided, the latest version is used. Default is -1 for the same behavior.
-    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
-        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.
-
-    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,
-        version=version,
-        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: Optional[Union[str, int]] = -1,
-    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.
-
-    Parameters
-    ----------
-    fn_name : str
-        The name of the function to query.
-    version: str | int, optional
-        The version number or alias of the function to query. If not provided, the latest version is used. Default is -1 for the same behavior.
-    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
-        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.
-
-    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 = await client.aquery(
-        fn_name=fn_name,
-        version=version,
-        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: Optional[Union[str, int]] = -1,
-    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.
-
-    This method uses the asynchronous queries to submit all queries concurrently
-    and waits for all responses to be received before returning the results.
-
-    Parameters
-    ----------
-    fn_name : str | List[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[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 : str | int, optional
-        The version number or alias of the function to query. If not provided, the latest version is used. Default is -1 for the same behavior.
-    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.
-
-    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.
-    """
-    client = WecoAI(api_key=api_key)
-    responses = client.batch_query(
-        fn_name=fn_name, version=version, version_number=version_number, batch_inputs=batch_inputs, return_reasoning=return_reasoning
-    )
-    return responses

weco-0.1.10.dist-info/METADATA

@@ -1,125 +0,0 @@
-Metadata-Version: 2.1
-Name: weco
-Version: 0.1.10
-Summary: A client facing API for interacting with the WeCo AI function builder service.
-Author-email: WeCo AI Team <dhruv@weco.ai>
-License: MIT
-Project-URL: Homepage, https://github.com/WecoAI/weco-python
-Keywords: AI,LLM,machine learning,data science,function builder,AI function
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Classifier: License :: OSI Approved :: MIT License
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: asyncio
-Requires-Dist: httpx[http2]
-Requires-Dist: pillow
-Provides-Extra: dev
-Requires-Dist: flake8 ; extra == 'dev'
-Requires-Dist: flake8-pyproject ; extra == 'dev'
-Requires-Dist: black ; extra == 'dev'
-Requires-Dist: isort ; extra == 'dev'
-Requires-Dist: pytest-asyncio ; extra == 'dev'
-Requires-Dist: pytest-xdist ; extra == 'dev'
-Requires-Dist: build ; extra == 'dev'
-Requires-Dist: setuptools-scm ; extra == 'dev'
-
-<div align="center" style="display: flex; align-items: center; justify-content: center;">
-  <img src="assets/weco.svg" alt="WeCo AI" style="height: 50px; margin-right: 10px;">
-  <a href="https://git.io/typing-svg"><img src="https://readme-typing-svg.demolab.com?font=Georgia&size=32&duration=4000&pause=400&color=FD4578&vCenter=true&multiline=false&width=200&height=50&lines=WeCo+Client" alt="Typing SVG" /></a>
-</div>
-
-![Python](https://img.shields.io/badge/Python-3.10.14-blue)
-[![License](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
-
-<!-- TODO: Update examples -->
-# $f$(👷‍♂️)
-
-<a href="https://colab.research.google.com/github/WecoAI/weco-python/blob/main/examples/cookbook.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab" width=110 height=20/></a>
-<a target="_blank" href="https://lightning.ai/new?repo_url=https%3A%2F%2Fgithub.com%2FWecoAI%2Fweco-python%2Fblob%2Fmain%2Fexamples%2Fcookbook.ipynb"><img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open in Studio" width=100 height=20/></a>
-
-A client facing API for interacting with the [WeCo AI](https://www.weco.ai/) function builder [service](https://weco-app.vercel.app/function)!
-
-
-Use this API to build *complex* systems *fast*. We lower the barrier of entry to software engineer, data science and machine learning by providing an interface to prototype difficult solutions quickly in just a few lines of code.
-
-## Installation
-
-Install the `weco` package simply by calling this in your terminal of choice:
-```bash
-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 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.query` and `weco.build` to be used when you only require sparse usage.
-
-## Usage
-
-When using the WeCo API, you will need to set the API key:
-You can find/setup your API key [here](https://weco-app.vercel.app/account) by navigating to the API key tab. Once you have your API key, you may pass it to the `weco` client using the `api_key` argument input or set it as an environment variable such as:
-```bash
-export WECO_API_KEY=<YOUR_WECO_API_KEY>
-```
-
-## Example
-
-We create a function on the [web console](https://weco-app.vercel.app/function) for the following task:
-> "Analyze a business idea and provide a structured evaluation. Output a JSON with 'viability_score' (0-100), 'strengths' (list), 'weaknesses' (list), and 'next_steps' (list)."
-
-Now, you're ready to query this function anywhere in your code!
-
-```python
-from weco import query
-response = query(
-    fn_name="BusinessIdeaAnalyzer-XYZ123",  # Replace with your actual function name
-    text_input="A subscription service for personalized, AI-generated bedtime stories for children."
-)
-```
-
-For more examples and an advanced user guide, check out our function builder [cookbook](examples/cookbook.ipynb).
-
-## Happy building $f$(👷‍♂️)!
-
-## Contributing
-
-We value your contributions! If you believe you can help to improve our package enabling people to build AI with AI, please contribute!
-
-Use the following steps as a guideline to help you make contributions:
-
-1. Download and install package from source:
-   ```bash
-   git clone https://github.com/WecoAI/weco-python.git
-   cd weco-python
-   pip install -e ".[dev]"
-   ```
-
-2. Create a new branch for your feature or bugfix:
-   ```bash
-   git checkout -b feature/your-feature-name
-   ```
-
-3. Make your changes and run tests to ensure everything is working:
-   
-   > **Tests can be expensive to run as they make LLM requests with the API key being used so it is the developers best interests to write small and simple tests that adds coverage for a large portion of the package.**
-   
-   ```bash
-   pytest -n auto tests
-   ```
-
-4. Commit and push your changes, then open a PR for us to view 😁
-
-Please ensure your code follows our style guidelines (Numpy docstrings) and includes appropriate tests. We appreciate your contributions!

weco-0.1.10.dist-info/RECORD

@@ -1,10 +0,0 @@
-weco/__init__.py,sha256=qiKpnrm6t0n0bpAtXEKJO1Yz2xYXnJJRZBWt-cH7DdU,168
-weco/client.py,sha256=iJanKlSKlcg3x6V7rA0Bw7Px2nGy87766rePvGn-KzI,23013
-weco/constants.py,sha256=eoAq-9qN2aZrqyIWdrb3V1zomV5kp80PfxxoPoQNMNI,167
-weco/functional.py,sha256=CgQsBKppRmT1lAloEdTEbE1gOeCciK-H6RTUR6DDrrc,7706
-weco/utils.py,sha256=UUSw6ocqWdlSmIXVcH66DAL4NuLU2rFOyviD8aTWsv0,4371
-weco-0.1.10.dist-info/LICENSE,sha256=NvpxfBuSajszAczWBGKxhHe4gsvil1H63zmu8xXZdL0,1064
-weco-0.1.10.dist-info/METADATA,sha256=-6joUA_QvFIHrrXSe0LqbXbypW1PTW4d8keLneJ9fu0,5717
-weco-0.1.10.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
-weco-0.1.10.dist-info/top_level.txt,sha256=F0N7v6e2zBSlsorFv-arAq2yDxQbzX3KVO8GxYhPUeE,5
-weco-0.1.10.dist-info/RECORD,,