superagent-py

项目介绍—Superagent Python SDK 🥷

打造智能助手的开放框架

Superagent 是一个开源框架，旨在帮助开发者快速将高效的AI助手集成到任意应用中。无论是新手还是资深程序员，都可以在几分钟内轻松实现在应用中添加AI助手的功能。

安装指南

要在项目中使用Superagent，只需将以下依赖添加到项目的构建文件中即可：

pip install superagent-py
# 或者
poetry add superagent-py

使用方法

在您的Python应用中，您可以通过以下示例代码构建并调用一个AI助手：

from superagent.client import Superagent

client = Superagent(token="API_TOKEN", base_url="https://api.beta.superagent.sh")

agent = client.agent.create(request={
    "name": "My Agent",
    "description": "My awesome agent",
    "isActive": True,
    "llmModel": "GPT_4_1106_PREVIEW",
    "prompt": "You are a helpful assistant"
})

output = client.agent.invoke(
    agent_id=agent.data.id,
    input="Hi there!",
    enable_streaming=False,
    session_id="123"
)

print("Received response from superagent", agent.data)

异步客户端

Superagent 同样支持异步编程，以提升性能和响应效率：

from superagent.client import AsyncSuperagent

agent = await client.agent.create(request={
    "name": "My Agent",
    "description": "My awesome agent",
    "isActive": True,
    "llmModel": "GPT_4_1106_PREVIEW",
    "prompt": "You are a helpful assistant"
})

output = await client.agent.invoke(
    agent_id=agent.data.id,
    input="Hi there!",
    enable_streaming=False,
    session_id="123"
)

print("Received response from superagent", agent.data)

异常处理

所有由SDK抛出的异常都继承自moneykit.ApiError。这是一个基础异常类，您可以捕获并处理API相关的错误：

from superagent.core import ApiError

try:
  client.agents.get(agent_id="12312")
except ApiError as e:
  # 处理任何与API相关的错误

具体错误代码如下：

致谢

特别感谢Fern团队对Superagent库和SDK的支持。

测试状态

目前该SDK处于测试阶段，因此在版本之间可能会有重大更改。建议将这个包的版本锁定在pyproject.toml文件中，以避免非预期的版本更新带来的破坏。

贡献指南

尽管我们非常欢迎开源贡献，但请注意，此库是程序化生成的。因此，直接对本库进行的修改可能会在下次自动生成时被覆盖。我们建议首先通过开issue的形式与我们交流，如有proof of concept也可以提交PR，但我们可能无法直接合并。

README的贡献则不在此限，欢迎对文档进行任何改进。