Dust

Custom AI agent platform to speed up your work.

Check out our user guides and developer platform

We're hiring

• About Us
• Open Positions

Dust 快速上手指南

Dust 是一个自定义 AI 代理平台，旨在通过构建专属智能体来加速您的工作流程。以下指南将帮助您快速开始使用。

环境准备

在开始之前，请确保满足以下系统要求和前置条件：

• 操作系统：支持 macOS、Linux 或 Windows（建议通过 WSL2 在 Windows 上运行以获得最佳兼容性）。
• Node.js：版本 18.0 或更高（推荐使用 LTS 版本）。
• 包管理器：已安装 npm 或 yarn。
• 账户权限：您需要拥有一个 Dust 账户并获取相应的 API Key。
• 网络环境：由于 Dust 服务托管在海外，国内开发者可能需要配置网络代理以确保连接稳定。目前官方暂未提供中国镜像源。

安装步骤

Dust 主要作为 SaaS 平台提供服务，开发者通常通过 CLI 工具或 SDK 与平台交互。以下是初始化开发环境的步骤：

1. 创建项目目录并初始化

   mkdir my-dust-agent
   cd my-dust-agent
   npm init -y
   

2. 安装 Dust SDK

   npm install @dust-tt/dust
   

3. 配置环境变量 在项目根目录下创建 .env 文件，并填入您的 API Key：

   echo "DUST_API_KEY=your_actual_api_key_here" > .env
   

   注意：请将 your_actual_api_key_here 替换为您在 Dust 控制台 生成的真实密钥。

基本使用

以下是一个最简单的示例，展示如何通过代码调用 Dust 平台上的 AI 代理执行任务。

1. 创建脚本文件 新建一个名为 index.js 的文件，并写入以下代码：

   import { Dust } from '@dust-tt/dust';
   
   // 初始化客户端
   const dust = new Dust({
     apiKey: process.env.DUST_API_KEY,
   });
   
   async function runAgent() {
     try {
       // 替换 'your-agent-name' 为您在 Dust 平台上创建的代理名称
       // 替换 'your-workspace-id' 为您的工作区 ID
       const response = await dust.runAgent({
         workspaceId: 'your-workspace-id',
         agentName: 'your-agent-name',
         inputs: {
           query: '请总结今天的主要新闻。',
         },
       });
   
       console.log('Agent Response:', response);
     } catch (error) {
       console.error('Error running agent:', error);
     }
   }
   
   runAgent();
   

2. 运行脚本 确保您的 .env 文件已正确配置，然后执行：

   node index.js
   

如果配置无误，您将看到来自 Dust 代理的响应输出。更多高级功能（如创建自定义代理、连接数据源等）请访问 Dust 开发者文档。