workgpt

WorkGPT 是一个类似于 AutoGPT 或 LangChain 的代理框架。你只需提供一条指令和一组 API，它就会与 AI 不断交互，直到完成你的指令。

例如，指令可以是搜索网络上的信息、爬取某个网站，或者帮你叫一辆优步。我们支持任何可以用 OpenAPI 文件表示的 API。

安装

npm install workgpt

使用方法

import { Calculator } from 'workgpt/apis/calculator'
import { FactApi } from 'workgpt/apis/fact'
import { OpenpmApi } from 'workgpt/apis/openpm'
import { OpenAiAgent } from 'workgpt/chat-agents/open-ai'
import { WorkGptRunner } from 'workgpt/runners/workgpt'

const agent = new OpenAiAgent({
  verbose: true,
  temperature: 0.1,
  model: 'gpt-4-0613',
})

const apis = await Promise.all([
  OpenpmApi.fromPackageId('ipinfo', {
    authKey: process.env.IPINFO_API_KEY!,
  }),
  new Calculator(),
  new FactApi(),
])

const runner = new WorkGptRunner({
  agent,
  apis,
})

const result = await runner.runWithDirective(
  'IP 地址 76.220.35.234 对应的城市是哪个？该城市的人口是多少？'
)

console.log('结果', result)

什么是 OpenPM

在上面的示例中，我们使用了一个 OpenPM API。OpenPM 是一个用于管理 OpenAPI 文件的包管理器。在示例中，我们从 OpenPM 引入了一个名为 ipinfo 的包，用来查询 IP 地址信息。

你并不一定要使用 OpenPM。我们同样支持导入任意的 OpenAPI 文件。此外，我们在认证方面也做了智能处理：你只需传入一个 authKey，库就会自动完成授权。API 中的所有端点都会以本地函数的形式暴露给 LLM，随时可供调用。

网页爬取示例

我们提供了一个使用 Puppeteer 作为文本浏览器的示例，以便让 LLM 能够访问互联网。请注意，这个文本浏览器只会返回网页的纯文本内容，而不会传递 HTML。不过，对于 GPT-4 来说，这已经足够了——它足够智能，可以直接从纯文本中提取所需的数据。

我们还可以为 LLM 提供一个自定义的结束程序 API，当 LLM 完成任务后，就可以调用这个 API。这样做的好处是可以为 LLM 提供一个明确的数据提取模式，尤其适合从网页中抓取结构化数据。

export class WorkGptControl extends Api {
  @invokable({
    usage: '结束程序。当你得到答案时调用。',
    schema: z.object({
      fundingRounds: z.array(
        z.object({
          organizationName: z.string(),
          transactionName: z.string(),
          moneyRaised: z.string(),
          leadInvestors: z.array(z.string()),
        })
      ),
    }),
  })
  onFinish(result: any) {
    haltProgram(result)
  }
}

const agent = new OpenAiAgent({
  verbose: true,
  temperature: 0,
  model: 'gpt-4-0613',
})

const apis = await Promise.all([new TextBrowser(), new WorkGptControl()])

const runner = new WorkGptRunner({
  agent,
  apis,
})

const result = await runner.runWithDirective(
  '获取 https://www.crunchbase.com 网站上精选的融资轮次信息'
)

console.log('结果', JSON.stringify(result, null, 2))

许可证

MIT

WorkGPT 快速上手指南

WorkGPT 是一个类似 AutoGPT 或 LangChain 的 AI 智能体框架。你只需提供指令和一组 API，它就能与 AI 进行多轮对话，直到完成任务。支持任何可通过 OpenAPI 文件表示的接口。

环境准备

• 系统要求：支持 Node.js 的操作系统（Windows, macOS, Linux）
• 前置依赖：
  • Node.js (建议 v16 或更高版本)
  • npm 包管理器
  • OpenAI API Key (需配置在环境变量中)

安装步骤

使用 npm 安装 WorkGPT：

npm install workgpt

提示：国内开发者若遇到下载缓慢，可配置淘宝镜像源加速：

npm config set registry https://registry.npmmirror.com

基本使用

以下示例展示了如何组合计算器、事实查询和 IP 信息查询 API，让 AI 自动完成“查询 IP 归属城市及人口”的任务。

请确保已设置环境变量 IPINFO_API_KEY 和 OPENAI_API_KEY。

import { Calculator } from 'workgpt/apis/calculator'
import { FactApi } from 'workgpt/apis/fact'
import { OpenpmApi } from 'workgpt/apis/openpm'
import { OpenAiAgent } from 'workgpt/chat-agents/open-ai'
import { WorkGptRunner } from 'workgpt/runners/workgpt'

const agent = new OpenAiAgent({
  verbose: true,
  temperature: 0.1,
  model: 'gpt-4-0613',
})

const apis = await Promise.all([
  OpenpmApi.fromPackageId('ipinfo', {
    authKey: process.env.IPINFO_API_KEY!,
  }),
  new Calculator(),
  new FactApi(),
])

const runner = new WorkGptRunner({
  agent,
  apis,
})

const result = await runner.runWithDirective(
  'What is the city related to the ip address 76.220.35.234 and what is the population of that city?'
)

console.log('Result', result)

核心逻辑说明：

1. 初始化 Agent：配置使用的 LLM 模型（如 gpt-4）及参数。
2. 加载 APIs：通过 OpenpmApi 加载第三方 OpenAPI 包，或直接实例化内置 API。框架会自动处理认证逻辑。
3. 运行任务：创建 WorkGptRunner 并传入自然语言指令，AI 将自主规划调用哪些 API 以达成目标。