# @dograh/sdk 中文文档

规范地址：https://npmcn.com/package/%40dograh/sdk/

版本：0\.1\.7
npm 元数据更新时间：2026-05-31T11:42:50.850Z
中文译文更新时间：2026-11-12T14:41:52.353Z
软件包许可：BSD-2-Clause

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40dograh/sdk
原文对照：https://npmcn.com/package/%40dograh/sdk/?lang=original
项目主页：https://dograh.com/
源码仓库：https://github.com/dograh-hq/dograh

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：181 kB，71 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- 首次发布：2026-04-20T05:51:56.120Z
- 最新版本发布：2026-05-31T11:42:50.704Z
- 近 30 天下载量：12058（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 7 个）

## 中文简介

Dograh 语音- AI 工作流程的打入器

## 安装

```sh
npm install @dograh/sdk
```

也可以使用：`pnpm add @dograh/sdk`、`yarn add @dograh/sdk`、`bun add @dograh/sdk`

## README

# @dograh/ sdk (英语)

Dograh语音-AI工作流程的打入构建器. 获取节点光谱目录 dograh 后端在会话开始时, 验证每个反对它的呼叫 调用网站,并生产通过 Python 绕行的线条格式 JSON `ReactFlowDTO`。 。 。 .

## 安装

```bash
npm install @dograh/sdk
# or
pnpm add @dograh/sdk
```

对于本地开发的取出单列,请添加 tsconfig 路径 条目 :

```json
{
  "paths": {
    "@dograh/sdk": ["../sdk/typescript/src/index.ts"]
  }
}
```

## 使用量

```ts
import { DograhClient, Workflow } from "@dograh/sdk";

const client = new DograhClient({
  baseUrl: "http://localhost:8000",
  apiKey: process.env.DOGRAH_API_KEY,
});

const wf = new Workflow({ client, name: "loan_qualification" });

const start = await wf.add({
  type: "startCall",
  name: "greeting",
  prompt: "You are Sarah from Acme Loans. Greet the caller warmly.",
  greeting_type: "text",
  greeting: "Hi {{first_name}}, this is Sarah.",
});

const qualify = await wf.add({
  type: "agentNode",
  name: "qualify",
  prompt: "Ask about loan amount and timeline.",
});

const done = await wf.add({ type: "endCall", name: "done", prompt: "Thank them." });

wf.edge(start, qualify, { label: "interested", condition: "Caller expressed interest." });
wf.edge(qualify, done, { label: "done", condition: "Qualification complete." });

await client.saveWorkflow(123, wf);
```

## 客户端验证

每个 `add()` 调用以获取的光谱验证 kwargs . `ValidationError` 当:

-   传递未知字段(捕获物打字)
-   缺少或空白所需的字段
-   scalar 类型错误( 如布尔字符串)
-   a 一个 `options` 数值不在允许的列表中

当一个Spec带一个 `llm_hint`,提示附在错误之后,所以是一个 LLM 代理在重试时可以自我更正 :

```
tool_uuids: expected tool_refs, got string
  Hint: List of tool UUIDs from `list_tools`.
```

服务器侧 Pydantic 验证器运行到保存并显示客户端的任何内容 让我们通过.

## 环境

```bash
DOGRAH_API_URL=http://localhost:8000   # default
DOGRAH_API_KEY=sk-...                  # sent as X-API-Key
```

## 许可证

BSD 2- Clause — 见 `LICENSE`。 。 。 .

## 常见问题

### @dograh/sdk 是什么？

Dograh 语音- AI 工作流程的打入器

### 如何安装 @dograh/sdk？

在项目目录运行 npm install @dograh/sdk，或使用 pnpm add / yarn add / bun add。

### @dograh/sdk 支持 TypeScript 吗？

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

### @dograh/sdk 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @dograh/sdk 需要什么版本的 Node\.js？

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

### @dograh/sdk 可以商用吗？

@dograh/sdk 使用 BSD-2-Clause 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @dograh/sdk 的下载量有多少？

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

### @dograh/sdk 还在维护吗？

最新版本 0\.1\.7 发布于 2026/05/31（5 个月前）；至今共发布 7 个版本，其中过去 12 个月发布了 7 个；首次发布于 2026/04/20。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。