BaseAI 现已归档，推荐使用 Langbase AI Primitives。随着我们对 BaseAI 的不断开发，我们越来越意识到，在 AI 工程领域，框架并不是一个好的选择。这个领域发展迅速，框架往往会成为阻碍。相反，你应该使用像 memory、pipes、agents 这样的 AI 原语，它们以 API 的形式与任何语言兼容，并提供 TypeScript 和 Python SDK。你可以借助任何编码代理，比如 CommandCode，利用这些 AI 原语构建属于你自己的 AI 框架。BaseAI 就是一个很好的例子。

BaseAI

入门指南

BaseAI 是一个用于构建无服务器且可组合的 AI 代理的框架，支持记忆和工具集成。它允许你在本地机器上开发具有集成智能体工具和记忆（RAG）功能的 AI 代理管道。请访问我们的 BaseAI.dev/learn 指南，开始使用 BaseAI。

文档（推荐）

请查看 BaseAI.dev/docs 和 BaseAI.dev/learn，获取完整的文档信息，开始你的旅程。

1. 初始化一个新的 BaseAI 项目

BaseAI 是一个以 TypeScript 优先的框架。要创建一个新的 BaseAI 项目，请在你的项目中运行以下命令：

npx baseai@latest init

该命令将在你的项目中创建一个 baseai 目录。目录结构如下所示：

ROOT (of your app)
├── baseai
|  ├── baseai.config.ts
|  ├── memory
|  ├── pipes
|  └── tools
├── .env (your env file)
└── package.json

2. 添加 API 密钥

将以下内容复制到你的 .env 文件中，并添加相应的 LLM API 密钥：

# !! 仅限服务器端 !!
# 请务必保密所有 API 密钥，仅在服务器端使用。

# TODO: 添加：同时在生产环境和本地环境文件中。
# Langbase 用户或组织账户的 API 密钥。
# 如何获取此 API 密钥：https://langbase.com/docs/api-reference/api-keys
LANGBASE_API_KEY=

# TODO: 仅限本地环境。仅添加到本地 .env 文件中。
# 以下密钥是本地管道运行所需的，适用于你使用的提供商。
# 对于 Langbase，请将密钥添加到你的 LLM 密钥集中。
# 更多信息：Langbase LLM 密钥集 https://langbase.com/docs/features/keysets
OPENAI_API_KEY=
ANTHROPIC_API_KEY=
COHERE_API_KEY=
FIREWORKS_API_KEY=
GOOGLE_API_KEY=
GROQ_API_KEY=
MISTRAL_API_KEY=
PERPLEXITY_API_KEY=
TOGETHER_API_KEY=
XAI_API_KEY=

3. 创建一个新的 AI 代理

Pipe 是你自定义构建的 AI 代理，以 API 的形式存在。它是快速交付 AI 功能或应用的最佳方式。让我们创建一个新的 pipe：

npx baseai@latest pipe

系统会逐步询问你 pipe 的名称、描述和其他详细信息。完成后，会在 /baseai/pipes 目录下创建一个 pipe。你现在可以编辑系统提示词、调整模型参数等。以下是 pipe 代码的示例：

import { PipeI } from '@baseai/core';

const pipeSummary = (): PipeI => ({
	// 替换为你自己的 API 密钥 https://langbase.com/docs/api-reference/api-keys
	apiKey: process.env.LANGBASE_API_KEY!,
	name: 'summary',
	description: 'AI 总结代理',
	status: 'public',
	model: 'openai:gpt-4o-mini',
	stream: true,
	json: false,
	store: true，
	moderate: true，
	top_p: 1，
	max_tokens: 1000，
	temperature: 0.7，
	presence_penalty: 1，
	frequency_penalty: 1，
	stop: [],
	tool_choice: 'auto',
	parallel_tool_calls: true，
	messages: [
		{
			role: 'system',
			content: `你是一个有用的 AI 代理。尽量让内容更简洁。`
		}
	],
	variables: [],
	memory: [],
	tools: []
});

export default pipeSummary;

4. 将 pipe 集成到你的应用中

让我们在你的项目根目录下创建一个新的 index.ts 文件。接下来需要执行以下步骤：

1. 导入我们刚刚创建的 pipe 配置。
2. 使用 pipe 配置创建一个新的 pipe 实例。
3. 使用用户消息运行 pipe。
4. 监听流事件。

以下是代码示例：

import { Pipe, getRunner } from '@baseai/core';
import pipeSummarizer from './baseai/pipes/summary';

const pipe = new Pipe(pipeSummarizer());

const userMsg = `
Langbase studio 是一个用于构建、协作和部署 AI 的平台。它允许你实时地用真实数据试验你的 pipelines，存储对话记录、管理 prompt 版本，并真正帮助你将想法从原型开发推进到生产部署，通过 LLMOps 实现对使用情况、成本和质量的全面监控。
一个完整的 AI 开发者平台。
- 协作：邀请所有团队成员共同参与 pipeline 的开发。一起构建 AI。
- 开发人员与利益相关者：无论是研发团队、工程部门、产品团队，还是市场和销售团队，几乎每个利益相关者都可以在同一 pipeline 上协作。这就像 GitHub 和 Google Docs 的强大结合，专为 AI 打造的完整开发者平台。
`;

async function main() {
	const { stream } = await pipe.run({
		messages: [{ role: 'user', content: userMsg }],
		stream: true,
	});

	const runner = getRunner(stream);

	// 方法一：使用事件监听器
	runner.on('connect', () => {
		console.log('流已开始。\n');
	});

	runner.on('content', content => {
		process.stdout.write(content);
	});

	runner.on('end', () => {
		console.log('\n流已结束。');
	});

	runner.on('error', error => {
		console.error('错误:', error);
	});
}

main();

如果你使用的是 Node.js，请确保在文件顶部安装并导入 dotenv：

import 'dotenv/config';

5. 运行 AI 代理

要在本地运行管道，您需要启动 BaseAI 服务器。在终端中运行以下命令：

npx baseai@latest dev

然后，在终端中运行 index.ts 文件：

npx tsx index.ts

您应该会在终端中看到以下输出：

流已开始。

Langbase Studio 是您的 AI 开发实验平台。您可以使用真实数据进行实时实验，存储消息，并对提示进行版本控制，从而无缝地从原型过渡到生产环境。

主要特性：
- **协作**：邀请团队成员共同构建 AI。
- **包容性团队**：让研发、工程、产品和市场等所有相关方在一个共享空间中参与协作。它就像 GitHub 和 Google Docs 的结合，专为 AI 开发而设计。
流已结束。

[!TIP] 您也可以使用 BaseAI 在本地运行 RAG。请查看内存代理快速入门指南，了解更多详情。

贡献

我们欢迎对 BaseAI 的贡献。更多信息请参阅我们的贡献指南。

作者

以下是 BaseAI 的原始作者：

• Ahmad Awais (@MrAhmadAwais)

• Ashar Irfan (@MrAsharIrfan)

• Saqib Ameen (@SaqibAmeen)

• Ahmad Bilal (@AhmadBilalDev)

安全

如果您发现了 BaseAI 中的安全漏洞，请通过发送电子邮件至 security@langbase.com 私下报告。请勿公开提交问题。有关 Langbase 安全及如何报告的更多详细信息，请访问此链接。

点击并浏览我们的网站、文档以及免费的/学习 AI 课程，了解更多关于构建 AI 代理、使用智能工具和智能记忆的知识。

BaseAI 快速上手指南

⚠️ 重要提示：BaseAI 项目目前已归档（Archived）。开发团队建议转向使用更灵活的 Langbase AI Primitives（如 Memory, Pipes, Agents），它们作为 API 支持任意语言，并提供 TypeScript 和 Python SDK。本文档仅作为历史版本参考或学习 AI Agent 构建思路使用。

BaseAI 是一个优先支持 TypeScript 的框架，用于构建具有记忆（Memory）和工具（Tools）能力的无服务器、可组合 AI Agent。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Windows, macOS, 或 Linux
• Node.js：建议安装最新 LTS 版本 (v18+)
• 包管理器：npm, yarn, 或 pnpm
• API Keys：
  • LANGBASE_API_KEY：用于连接 Langbase 平台（必填）。
  • 模型提供商 Key：如 OPENAI_API_KEY, ANTHROPIC_API_KEY 等（根据使用的模型选配）。

安装步骤

1. 初始化项目

在项目根目录下运行以下命令，创建一个新的 BaseAI 项目结构：

npx baseai@latest init

执行成功后，项目目录中将生成 baseai 文件夹，结构如下：

ROOT (of your app)
├── baseai
|  ├── baseai.config.ts
|  ├── memory
|  ├── pipes
|  └── tools
├── .env (your env file)
└── package.json

2. 配置 API 密钥

在项目根目录创建或编辑 .env 文件，填入必要的 API 密钥。请注意：密钥仅限服务端使用，切勿泄露。

# !! SERVER SIDE ONLY !!
# Keep all your API keys secret — use only on the server side.

# Langbase API key (必填)
LANGBASE_API_KEY=your_langbase_api_key_here

# 本地运行所需的模型提供商 Key (选填，根据需求添加)
OPENAI_API_KEY=your_openai_key
ANTHROPIC_API_KEY=your_anthropic_key
# ... 其他提供商 key

基本使用

1. 创建 AI Agent (Pipe)

"Pipe" 是 BaseAI 中自定义 AI Agent 的核心概念。运行以下命令交互式地创建一个新的 Pipe：

npx baseai@latest pipe

按提示输入名称、描述等信息后，将在 baseai/pipes 目录下生成配置文件（例如 summary.ts）。您可以编辑该文件以调整系统提示词、模型参数等：

import { PipeI } from '@baseai/core';

const pipeSummary = (): PipeI => ({
	apiKey: process.env.LANGBASE_API_KEY!,
	name: 'summary',
	description: 'AI Summary agent',
	status: 'public',
	model: 'openai:gpt-4o-mini',
	stream: true,
	json: false,
	store: true,
	moderate: true,
	top_p: 1,
	max_tokens: 1000,
	temperature: 0.7,
	presence_penalty: 1,
	frequency_penalty: 1,
	stop: [],
	tool_choice: 'auto',
	parallel_tool_calls: true,
	messages: [
		{
			role: 'system',
			content: `You are a helpful AI agent. Make everything Less wordy.`
		}
	],
	variables: [],
	memory: [],
	tools: []
});

export default pipeSummary;

2. 集成到应用

在项目根目录创建 index.ts 文件，编写代码调用刚才创建的 Pipe：

import 'dotenv/config'; // 如果使用 Node.js，请确保安装并导入 dotenv
import { Pipe, getRunner } from '@baseai/core';
import pipeSummarizer from './baseai/pipes/summary';

const pipe = new Pipe(pipeSummarizer());

const userMsg = `
Langbase studio is your playground to build, collaborate, and deploy AI...
`;

async function main() {
	const { stream } = await pipe.run({
		messages: [{ role: 'user', content: userMsg }],
		stream: true,
	});

	const runner = getRunner(stream);

	// 监听流式输出事件
	runner.on('connect', () => {
		console.log('Stream started.\n');
	});

	runner.on('content', content => {
		process.stdout.write(content);
	});

	runner.on('end', () => {
		console.log('\nStream ended.');
	});

	runner.on('error', error => {
		console.error('Error:', error);
	});
}

main();

3. 运行 Agent

首先启动 BaseAI 本地开发服务器：

npx baseai@latest dev

保持服务器运行，在另一个终端窗口执行您的脚本：

npx tsx index.ts

您将看到实时的流式输出结果：

Stream started.

Langbase Studio is your AI development playground. Experiment in real-time with real data, store messages, and version prompts to move from prototype to production seamlessly.

Key Features:
- **Collaborate**: Invite team members to build AI together.
- **Inclusive Teams**: Engage all stakeholders—R&D, engineering, product, and marketing—in a shared space. It's like GitHub combined with Google Docs for AI development.
Stream ended.