@dust-tt/client

中文文档
1.2.10发布于 2026/11/13ISCTypeScriptESM + CJS近 30 天下载 11.7万

灰尘 API 客户端

中文使用文档
文档目录5 节
  1. 安装
  2. 使用量
  3. 设置
  4. 找到所有探员
  5. 创建对话

JavaScript 的灰尘 SDK

简单易用客户端 灰尘 API


Build status npm version

可用源代码 这里。 。 。 .

安装

npm install @dust-tt/client

使用量

使用灰尘 尘埃发展平台 开始学习尘埃API.

使用一个 工作空间 api 密钥 或 OAuth 证书 访问令牌 (目前需要和我们谈谈).

注意: 我们使用“结果”模式处理出错( E)看见更多) (中文(简体) ).

设置

import { DustAPI } from "@dust-tt/client";

const dustAPI = new DustAPI(
  {
    url: "https://dust.tt",
  },
  {
    workspaceId: "YOUR_WORKSPACE_ID",
    apiKey: "YOUR_API_KEY_OR_ACCESS_TOKEN",
  },
  console
);

找到所有探员

const r = await dustApi.getAgentConfigurations();

if (r.isErr()) {
  throw new Error(`API Error: ${r.error.message}`);
} else {
  const agents = r.value.filter((agent) => agent.status === "active");
}

创建对话

const context = {
  timezone: "UTC",
  username: user.firstName,
  email: user.email,
  fullName: user.fullName,
  profilePictureUrl: user.image,
  origin: "api", // Contact us to add more
};

const question = "Hello! What can you do for me ?";

const r = await dustApi.createConversation({
  title: null,
  visibility: "unlisted",
  message: {
    content: question,
    mentions: [
      {
        configurationId: agent.sId,
      },
    ],
    context,
  },
});

if (r.isErr()) {
  throw new Error(r.error.message);
} else {
  const { conversation, message } = r.value;

  try {
    const r = await dustApi.streamAgentAnswerEvents({
      conversation,
      userMessageId: message.sId,
      signal,
    });
    if (r.isErr()) {
      throw new Error(r.error.message);
    } else {
      const { eventStream } = r.value;

      let answer = "";
      let action: AgentActionPublicType | undefined = undefined;
      let chainOfThought = "";

      for await (const event of eventStream) {
        if (!event) {
          continue;
        }
        switch (event.type) {
          case "user_message_error": {
            console.error(
              `User message error: code: ${event.error.code} message: ${event.error.message}`
            );
            return;
          }
          case "agent_error": {
            console.error(
              `Agent message error: code: ${event.error.code} message: ${event.error.message}`
            );
            return;
          }
          case "agent_action_success": {
            action = event.action;
            break;
          }

          case "generation_tokens": {
            if (event.classification === "tokens") {
              answer = (answer + event.text).trim();
            } else if (event.classification === "chain_of_thought") {
              chainOfThought += event.text;
            }
            break;
          }
          case "agent_message_success": {
            answer = event.message.content ?? "";
            break;
          }
          default:
          // Nothing to do on unsupported events
        }
      }
    }
  } catch (error) {
    if (error instanceof Error && error.message.includes("AbortError")) {
      // Stream aborted
    } else {
      // Other error
    }
  }
}

版本与发布记录

@dust-tt/client 共发布 90 个版本,首次发布于 2024/11/07;过去 12 个月发布了 15 个版本。

版本发布日期距今
1.2.10latest2026/11/13今天
1.2.92026/09/221 个月前
1.2.82026/07/293 个月前
1.2.72026/07/153 个月前
1.2.62026/02/128 个月前
1.2.52026/02/079 个月前

关于 @dust-tt/client 的常见问题

@dust-tt/client 是什么?

灰尘 API 客户端

如何安装 @dust-tt/client?

在项目目录运行 npm install @dust-tt/client,或使用 pnpm add / yarn add / bun add。

@dust-tt/client 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@dust-tt/client 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@dust-tt/client 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=24.16.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@dust-tt/client 可以商用吗?

@dust-tt/client 使用 ISC 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@dust-tt/client 的下载量有多少?

根据 npm 官方下载统计,@dust-tt/client 在 2026/10/13 – 2026/11/11 这 30 天内被下载 116,871 次,日均约 3,896 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@dust-tt/client 还在维护吗?

最新版本 1.2.10 发布于 2026/11/13(今天);至今共发布 90 个版本,其中过去 12 个月发布了 15 个;首次发布于 2024/11/07。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。