# @convokit/server 中文文档

规范地址：https://npmcn.com/package/%40convokit/server/

版本：0\.1\.1
npm 元数据更新时间：2026-02-26T04:29:26.151Z
中文译文更新时间：2026-11-10T22:53:43.145Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：11.8 kB，6 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- 首次发布：2026-02-26T04:22:15.834Z
- 最新版本发布：2026-02-26T04:29:26.019Z
- 近 30 天下载量：2479（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 2 个）

## 中文简介

ConvoKit 服务器 SDK – 使用您的秘密 API 密钥安全服务器对服务器聊天

## 安装

```sh
npm install @convokit/server
```

也可以使用：`pnpm add @convokit/server`、`yarn add @convokit/server`、`bun add @convokit/server`

## README

# @ convokit/ 服务器

> **ConvoKit目前提前进入.** 服务员是现场直播.. [加入 convokit.dev 时](https://convokit.dev/) 以获得早期访问.

服务器 SDK 用于 [骑兵队](https://convokit.dev/) —— 使用您的服务器发送 AI 聊天信息 **密钥 API**。密钥从不离开后端,使这比在浏览器中使用公钥更加安全.

**网站:** [convokit.dev (英语)](https://convokit.dev/)

* * *

## 安装

```bash
npm install @convokit/server
```

* * *

## 使用量

```js
const { createClient } = require('@convokit/server');

const client = createClient(process.env.CONVOKIT_SECRET_KEY); // sk_live_...

// New conversation
const { reply, conversation_id } = await client.chat({
  message: 'What are your support hours?',
});
console.log(reply);

// Follow-up in the same thread
const { reply: reply2 } = await client.chat({
  message: 'And on weekends?',
  conversationId: conversation_id,
});
console.log(reply2);
```

* * *

## 类型脚本

```ts
import { createClient, type ChatOptions, type ChatResponse } from '@convokit/server';

const client = createClient({ apiKey: process.env.CONVOKIT_SECRET_KEY! });

const res: ChatResponse = await client.chat({
  message: 'Hello',
  instanceId: 'my-bot',
  chatHistory: [],
});
```

* * *

## 对话历史

传递之前的消息, AI有上下文 :

```js
const { reply } = await client.chat({
  message: 'What did I just ask?',
  chatHistory: [
    { role: 'user', content: 'What are your support hours?' },
    { role: 'assistant', content: 'We are open 9am–5pm Monday to Friday.' },
  ],
});
```

格式 : `{ role: 'user' | 'assistant' | 'system', content: string }`。 。 。 .

当你有一个 `conversationId`,可以省略 `chatHistory` ——后端已经有线程了.

* * *

## 选项

| 选项 | 需求 | 说明 |
| --- | --- | --- |
| `message` | 对 | 要发送的用户信息 |
| `conversationId` | 没有 | 在同一线索中用于后续消息 |
| `widgetId` | 没有 | 组合的标识符( 如: bot name, channel) |
| `chatHistory` | 没有 | 上一则上下文信件 |

## 回应

| 外地 | 说明 |
| --- | --- |
| `reply` | 大赦国际的答复案文 |
| `conversation_id` | 在下一个消息中传递此内容以继续线索 |
| `usage` | 托肯用法 - `prompt_tokens`, (中文(简体) ), `completion_tokens`, (中文(简体) ), `total_tokens` |

* * *

## 警卫

-   使用一个 **密钥** (单位:千美元)`sk_live_...`在您的服务器上 。 永远不要在浏览器或客户端代码中曝光.
-   对于浏览器/部件的使用,请使用 **公钥** (单位:千美元)`pk_live_...`与 [`@convokit/widget`](https://www.npmjs.com/package/@convokit/widget) 软件包.

* * *

## 提前获取

ConvoKit提前进入 获取您的 API 密钥并配置您的 AI **[convokit.dev (英语)](https://convokit.dev/)**。 。 。 .

等待名单是现场直播的——现在加入进来,以便早日进入.

* * *

## 许可证

麻省理工学院

## 常见问题

### @convokit/server 是什么？

ConvoKit 服务器 SDK – 使用您的秘密 API 密钥安全服务器对服务器聊天

### 如何安装 @convokit/server？

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

### @convokit/server 支持 TypeScript 吗？

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

### @convokit/server 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @convokit/server 需要什么版本的 Node\.js？

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

### @convokit/server 可以商用吗？

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

### @convokit/server 的下载量有多少？

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

### @convokit/server 还在维护吗？

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