# @completionhq/completion-node 中文文档

规范地址：https://npmcn.com/package/%40completionhq/completion-node/

版本：0\.0\.4
npm 元数据更新时间：2024-04-15T00:09:03.116Z
中文译文更新时间：2026-11-10T13:42:24.124Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40completionhq/completion-node
原文对照：https://npmcn.com/package/%40completionhq/completion-node/?lang=original

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

- 包体积（解压后）：21.6 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=12\.\*
- 运行依赖：5 个
- 首次发布：2024-04-14T23:50:36.375Z
- 最新版本发布：2024-04-15T00:09:02.785Z
- 近 30 天下载量：8186（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

完成节点SDK是快速而轻量级的与完成API互动的方式.

## 安装

```sh
npm install @completionhq/completion-node
```

也可以使用：`pnpm add @completionhq/completion-node`、`yarn add @completionhq/completion-node`、`bun add @completionhq/completion-node`

## README

# 补全库

完成让您:

-   监控和调试您的 LLM 提示在生产中 .
-   跟踪 LLM 模型的使用和成本.

## 关键特性

-   **监视提示**: 实时跟踪发送给您的 LLM 模型的提示 。 我们有意将即时参数从即时模板中分出,以确保您可以监视提示,自动检测版本变化,并调试历史数据上的问题.
-   **费用追踪**:跟踪您的 LLM 模型的使用和成本。 我们详细列出了每起急车的费用,包括模型费用、急车费用和总费用.
-   **版本控制**: 管理您提示的版本。 我们自动检测快速模板和参数的更改,允许您跟踪您提示随时间推移的演变情况.

## 安装

使用 npm 或纱线安装补全节点库 :

```bash
npm install @completionhq/completion-node

# or

yarn add @completionhq/completion-node
```

## 使用量

下面是演示如何在您的节点.js应用程序中使用补全的示例 .

完成是LLM-agnostic,意思是它可以和任何LLM模型一起使用,包括来自OpenAI,Anthropic,Google,Mistral等的.

### 基本日志

```typescript
import { Completion } from '@completionhq/completion-node';

const completion = new Completion({
  apiKey: 'abc123',
});

const messagesTemplate = [
  {
    role: 'User',
    message: 'Hello, how are you {name}?',
  },
  {
    role: 'Assistant',
    message: 'I am good, thank you. How can I help you today?',
  },
];

const promptArguments = {
  name: 'Alice',
};

const output = "Is there anything I can help you with today?";

await completion.log({
  templateName: 'greeting',
  messagesTemplate,
  promptArguments,
  output,
  model: 'gpt-3.5-turbo',
});
```

### 记录已编译的快件

```typescript

const compiledMessages = [
  {
    role: 'User',
    message: 'Hello, how are you Alice?',
  },
  {
    role: 'Assistant',
    message: 'I am good, thank you. How can I help you today?',
  },
];
await completion.log({
  templateName: 'greeting',
  compiledMessages,
  output,
  model: 'gpt-3.5-turbo',
});
```

### 使用已编译的快速日志

```typescript
const compiledPrompt = "User: Hello, how are you Alice?\nAssistant: I am good, thank you. How can I help you today?";

await completion.log({
  templateName: 'greeting',
  compiledPrompt,
  output,
  model: 'gpt-3.5-turbo',
});
```

## 常见问题

### @completionhq/completion-node 是什么？

完成节点SDK是快速而轻量级的与完成API互动的方式\.

### 如何安装 @completionhq/completion-node？

在项目目录运行 npm install @completionhq/completion-node，或使用 pnpm add / yarn add / bun add。

### @completionhq/completion-node 支持 TypeScript 吗？

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

### @completionhq/completion-node 支持 ESM 还是 CommonJS？

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

### @completionhq/completion-node 需要什么版本的 Node\.js？

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

### @completionhq/completion-node 可以商用吗？

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

### @completionhq/completion-node 的下载量有多少？

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

### @completionhq/completion-node 还在维护吗？

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