$f$(👷‍♂️)

一个面向客户端的API，用于与WeCo AI功能构建服务进行交互！

使用此API快速构建复杂系统。我们通过提供一种快速原型化困难解决方案的接口，降低了软件开发、数据科学和机器学习入门的门槛。

安装

只需在您选择的终端中运行以下命令即可简单地安装weco包

pip install weco

功能

• 同步和异步客户端。
• 批量API
• 多模态（语言和视觉）
• 可解释性（查看输出背后的推理）

我们提供的内容

• build函数通过自然语言快速轻松地通过LLM原型化新功能。我们鼓励用户通过我们的Web控制台进行操作，以获得最大控制和易用性，但是您也可以像这里所示的那样通过我们的API进行操作。
• query函数允许您在您的代码中测试和使用新创建的功能。

我们以两种方式提供这两种服务

• 当您想要在代码的一部分中维护相同的客户端服务时，请使用weco.WecoAI客户端。这对于密集型服务使用更好。
• 当您只需要稀疏使用时，请使用weco.query和weco.build。

用法

使用WeCo API时，您需要设置API密钥：您可以通过导航到API密钥选项卡来找到/设置API密钥此处。一旦您有了API密钥，您可以通过api_key参数输入将其传递给weco客户端，或者将其设置为一个环境变量，例如

export WECO_API_KEY=<YOUR_WECO_API_KEY>

示例

我们在Web控制台中创建了一个用于以下任务的功能

"分析一个商业想法并提供结构化评估。输出一个包含'viability_score'（0-100）、'strengths'（列表）、'weaknesses'（列表）和'next_steps'（列表）的JSON。"。

现在，您可以在代码的任何地方查询此功能了！

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."
)

有关更多示例和高级用户指南，请参阅我们的功能构建烹饪书。

祝您构建快乐 $f$(👷‍♂️)！

贡献

我们重视您的贡献！如果您认为您可以帮助改进我们的包，使人们能够用AI构建AI，请贡献力量！

以下步骤可作为您贡献的指南

1. 从源代码下载并安装包

   git clone https://github.com/WecoAI/weco-python.git
   cd weco-python
   pip install -e ".[dev]"
   

2. 为您的功能或错误修复创建一个新分支

   git checkout -b feature/your-feature-name
   

3. 进行更改并运行测试以确保一切正常

   测试可能很昂贵，因为它们使用API密钥进行LLM请求，因此编写小型且简单的测试以增加包的覆盖率是开发者的最佳利益。

   pytest -n auto tests
   

4. 提交并推送您的更改，然后为我们打开一个PR 😁

请确保您的代码遵循我们的风格指南（Numpy docstrings）并包含适当的测试。我们感谢您的贡献！