Composio SDK

赋予你的 AI Agent 不断演进的技能

🌐 官方网站 • 📚 官方文档

本仓库包含了 Composio 的官方软件开发工具包（SDK），为 Python 和 TypeScript Agent 框架及库提供了无缝的集成能力。

入门指南

TypeScript SDK 安装

# 使用 npm
npm install @composio/core

# 使用 yarn
yarn add @composio/core

# 使用 pnpm
pnpm add @composio/core

快速开始：

import { Composio } from '@composio/core';
// 初始化 SDK
const composio = new Composio({
  // apiKey: 'your-api-key',
});

使用 OpenAI Agents 构建简单的 Agent

npm install @composio/openai-agents @openai/agents

import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, run } from '@openai/agents';

const composio = new Composio({
  provider: new OpenAIAgentsProvider(),
});

const userId = 'user@acme.org';

const tools = await composio.tools.get(userId, {
  toolkits: ['HACKERNEWS'],
});

const agent = new Agent({
  name: 'Hackernews assistant',
  tools: tools,
});

const result = await run(agent, 'What is the latest hackernews post about?');

console.log(JSON.stringify(result.finalOutput, null, 2));
// 将返回来自 agent 的响应，其中包含来自 HACKERNEWS API 的数据。

Python SDK 安装

# 使用 pip
pip install composio

# 使用 poetry
poetry add composio

快速开始：

from composio import Composio

composio = Composio(
  # api_key="your-api-key",
)

使用 OpenAI Agents 构建简单的 Agent

pip install composio_openai_agents openai-agents

import asyncio
from agents import Agent, Runner
from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider

# 初始化带有 OpenAI Agents Provider 的 Composio 客户端
composio = Composio(provider=OpenAIAgentsProvider())

user_id = "user@acme.org"
tools = composio.tools.get(user_id=user_id, toolkits=["HACKERNEWS"])

# 使用工具创建 Agent
agent = Agent(
    name="Hackernews Agent",
    instructions="You are a helpful assistant.",
    tools=tools,
)

# 运行 Agent
async def main():
    result = await Runner.run(
        starting_agent=agent,
        input="What's the latest Hackernews post about?",
    )
    print(result.final_output)

asyncio.run(main())
# 将返回来自 agent 的响应，其中包含来自 HACKERNEWS API 的数据。

如需了解更详细的使用说明和示例，请参考各个 SDK 的具体文档。

OpenAPI 规范

更新用于生成 SDK 文档的 OpenAPI 规范：

# 从后端拉取最新的 API 规范
pnpm api:pull

此命令会从 https://backend.composio.dev/api/v3/openapi.json 拉取 OpenAPI 规范，并更新本地的 API 文档文件。

该操作会在构建步骤中自动执行。

可用 SDK

TypeScript SDK (/ts)

TypeScript SDK 提供了一种现代的、类型安全的方式来与 Composio 服务交互。它专为 Node.js 和浏览器环境设计，通过全面的类型定义提供完整的 TypeScript 支持。

有关 TypeScript SDK 的详细信息，请参阅 TypeScript SDK 文档。

Python SDK (/python)

Python SDK 为 Composio 服务提供了 Pythonic 接口，使你可以轻松地将 Composio 集成到 Python 应用程序中。它支持 Python 3.10+，并遵循现代 Python 开发实践。

有关 Python SDK 的详细信息，请参阅 Python SDK 文档。

提供程序支持

下表显示了每个 SDK 支持的 AI 框架和平台：

提供程序 (Provider)	TypeScript	Python
OpenAI	✅	✅
OpenAI Agents	✅	✅
Anthropic	✅	✅
LangChain	✅	✅
LangGraph	✅*	✅
LlamaIndex	✅	✅
Vercel AI SDK	✅	❌
Google Gemini	✅	✅
Google ADK	❌	✅
Mastra	✅	❌
Cloudflare Workers AI	✅	❌
CrewAI	❌	✅
AutoGen	❌	✅

* TypeScript 中的 LangGraph 通过 @composio/langchain 包提供支持。

没有看到你使用的提供程序？ 了解如何构建自定义提供程序以集成任何 AI 框架。