SmythOS (SRE) 快速上手指南

SmythOS Runtime Environment (SRE) 是专为生产级 AI Agent 打造的开源运行时与 SDK。它提供了操作系统级别的资源抽象（如 LLM、向量数据库、存储和缓存），通过统一的 API 屏蔽底层提供商差异，让开发者只需编写一次逻辑即可在任何环境中扩展运行。

环境准备

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

• 操作系统：Linux, macOS, 或 Windows (支持 WSL2)
• Node.js：版本 18.0 或更高 (推荐使用 LTS 版本)
• 包管理器：npm (随 Node.js 安装) 或 yarn/pnpm
• API Keys：根据需求准备相关服务的密钥（如 OpenAI, Pinecone, AWS 等）

国内开发者提示：如果 npm 安装速度较慢，建议切换至国内镜像源（如淘宝镜像）：

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

安装步骤

您可以选择以下两种方式之一开始使用 SRE：

方式一：使用 CLI 创建新项目（推荐）

这是最快捷的入门方式，CLI 会引导您完成项目脚手架和配置。

1. 全局安装 SmythOS CLI：

   npm i -g @smythos/cli
   

2. 创建新项目：

   sre create
   

   跟随终端提示完成项目初始化配置。

方式二：在现有项目中集成 SDK

如果您已有项目，可直接安装 SDK 包：

npm install @smythos/sdk

基本使用

SRE SDK 支持加载现有的 .smyth 工作流文件，也支持完全通过代码构建 Agent 逻辑。

示例 1：加载并运行 Agent

假设您有一个通过 SmythOS Visual Studio 构建的 my-agent.smyth 文件：

import path from 'path';
import { Agent, Model } from '@smythos/sdk';

async function main() {
    const agentPath = path.resolve(__dirname, 'my-agent.smyth');

    // 导入 Agent 工作流并指定模型
    const agent = Agent.import(agentPath, {
        model: Model.OpenAI('gpt-4o'),
    });

    // 发送提示并获取完整响应
    const result = await agent.prompt('Hello, how are you ?');

    console.log(result);
}

main().catch(console.error);

进阶功能：

• 流式输出：调用 .stream() 方法即可实时接收内容、工具调用等事件。
• 对话模式：使用 agent.chat() 创建具有记忆功能的会话对象，自动维护上下文历史。

示例 2：代码构建复杂 Agent

您也可以直接使用 SDK 组合各种能力（如向量检索、LLM 生成、存储）来构建 Agent：

import { Agent, Model } from '@smythos/sdk';

async function main() {
    // 创建智能 Agent
    const agent = new Agent({
        name: 'Article Writer',
        model: 'gpt-4o',
        behavior: 'You are a copy writing assistant. The user will provide a topic and you have to write an article about it and store it.',
    });

    // 添加自定义技能：结合向量库、LLM 和存储
    agent.addSkill({
        id: 'AgentWriter_001',
        name: 'WriteAndStoreArticle',
        description: 'Writes an article about a given topic and stores it',
        process: async ({ topic }) => {
            // 1. 向量数据库 - 搜索相关上下文
            const vec = agent.vectordb.Pinecone({
                namespace: 'myNameSpace',
                indexName: 'demo-vec',
                pineconeApiKey: process.env.PINECONE_API_KEY,
                embeddings: Model.OpenAI('text-embedding-3-large'),
            });

            const searchResult = await vec.search(topic, {
                topK: 10,
                includeMetadata: true,
            });
            const context = searchResult.map((e) => e?.metadata?.text).join('\n');

            // 2. LLM - 生成文章
            const llm = agent.llm.OpenAI('gpt-4o-mini');
            const result = await llm.prompt(`Write an article about ${topic} using the following context: ${context}`);

            // 3. 存储 - 保存文章
            const storage = agent.storage.S3({
                /* ... S3 Config ... */
            });
            const uri = await storage.write('article.txt', result);

            return `The article has been generated and stored. Internal URI: ${uri}`;
        },
    });

    // 调用 Agent
    const result = await agent.prompt('Write an article about Sakura trees');
    console.log(result);
}

main().catch(console.error);

调试提示

如果在运行过程中遇到问题，可以通过设置环境变量开启详细日志以便排查：

export LOG_LEVEL="debug"
# 然后重新运行您的代码