# @fevex/openai 中文文档

规范地址：https://npmcn.com/package/%40fevex/openai/

版本：0\.1\.0-alpha\.14
npm 元数据更新时间：2026-11-11T04:28:27.818Z
中文译文更新时间：2026-11-14T15:14:08.957Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40fevex/openai
原文对照：https://npmcn.com/package/%40fevex/openai/?lang=original
项目主页：https://github.com/hemia-labs/fevex#readme
源码仓库：https://github.com/hemia-labs/fevex

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

- 包体积（解压后）：36.2 kB，4 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：1 个
- 首次发布：2026-07-27T19:01:42.431Z
- 最新版本发布：2026-11-11T04:28:27.368Z
- 近 30 天下载量：3409（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 13 个）

## 中文简介

用于Fevex的OpenAI ModelGateway适配器.

## 安装

```sh
npm install @fevex/openai
```

也可以使用：`pnpm add @fevex/openai`、`yarn add @fevex/openai`、`bun add @fevex/openai`

## README

# @ fevex/ openai (英语)

官方开放AI `ModelGateway` fevex的适配器. 见 [兼容和发布政策](https://fevex.dev/docs/compatibility/)。 。 。 .

```bash
npm install @fevex/core @fevex/openai
```

```ts
import { createOpenAI } from '@fevex/openai';

const model = createOpenAI({
  apiKey: process.env.OPENAI_API_KEY!,
  organization: process.env.OPENAI_ORG_ID,
  project: process.env.OPENAI_PROJECT_ID,
  schemaPolicy: 'strict',
})('gpt-5.6');
```

适配器使用本地 `fetch` 并且只执行Fevex模型合同. 工具执行、 验证、 事件和重试等运行时行为属于 改为 `@fevex/core`。返回的网关包括 `metadata: { provider: "openai", model: modelId }` 用于追踪、 eval 成本计算器和 OpenTelemeter 导出.

## 文本、工具和延续

无 `outputSchema`,将 OpenAI 文本作为精确的字符串返回 反应API, 即使它看起来像JSON。 与 `outputSchema`,则 适配器在 Fevex 执行本地计划验证前需要有效的 JSON . 拒绝,回复不全和功能错位的呼叫明显失败.

在工具循环期间,适配器存储原始响应项,包括 [aPI要求的推理项目](https://platform.openai.com/docs/api-reference/responses-streaming/response/refusal?lang=python), (中文(简体) ), 不透明 `providerState`。Fevex 返回该状态到下一个模式步骤 自动。 直接 `ModelGateway` 消费者也必须这样做 不得检查。 那个适配器 `stateCodec` 让费韦克斯 只有在私人的持久检查站内才能使用.

核心推理工作转至 `reasoning.effort`· ; `provider-default` 使提供者选项不受影响。 核心合同 包含 `none`, (中文(简体) ), `minimal`, (中文(简体) ), `low`, (中文(简体) ), `medium`, (中文(简体) ), `high`, (中文(简体) ), `xhigh` 财务报告和审定财务报表 `max` 这样 目前的GPT-5.6模型可以使用其已记录的工作水平. 特定模式 支持仍然属于 OpenAI,所以一个不支持的值被报告 API (英语). 只能通过提供方设置提供 `modelOptions.reasoning`。 。 。 .

`createOpenAI` 接收连接设置( e)`apiKey`选项 `organization`, (中文(简体) ), `project`, (中文(简体) ), `baseURL`,计划政策和 `fetch`)和型号 创建网关时会提供ID. 说明理由的努力是故意的 每个请求设置 `ModelInput`而不是工厂的设置.

适配器总是使用响应流式API. 它只发出 `response.output_text.delta` 作为可见输出并构建终端结果 从 `response.completed`; 推理和部分函数参数依然存在 私处.

工具名称和 `schemaName` 必须匹配 `[A-Za-z0-9_-]{1,64}`. 费韦克斯拥有 字段,例如模型、输入、工具、工具选择、计划格式、并行调用 和输出上限覆盖冲突 `modelOptions`。背景提供者任务 和内置工具 留在这个网关之外.

## Schema 政策

`schemaPolicy` 默认为 `"strict"`。在发送请求之前,适配器 对照OpenAI文件记录的检查工具输入和最终产出 [结构化产出子集](https://developers.openai.com/api/docs/guides/structured-outputs)。 。 。 . 每个方案必须有一个对象根;每个对象必须要求其全部 属性和设置 `additionalProperties: false`不支持的关键字和 文件大小限制抛出 `OpenAIError` 与 `code: "PROVIDER_SCHEMA_UNSUPPORTED"` 在此之前 `fetch` 运行.

设定 `schemaPolicy: "best-effort"` 来发送工具 `strict: false`对象 输出使用 JSON 模式,其他 JSON 值使用一个 schema 指令. 费韦克斯 仍然验证本地返回的值, 但 OpenAI 不保证计划 遵守此模式, 因此调用者可能需要重试无效的结果 .

| 政策 | 工具输入 | 最后产出 |
| --- | --- | --- |
| `strict` | OpenAI 严格的函数计划 | 结构化产出 |
| `best-effort` | 非限制性函数计划a | JSON 模式或 JSON 指令 |

## 常见问题

### @fevex/openai 是什么？

用于Fevex的OpenAI ModelGateway适配器\.

### 如何安装 @fevex/openai？

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

### @fevex/openai 支持 TypeScript 吗？

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

### @fevex/openai 支持 ESM 还是 CommonJS？

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

### @fevex/openai 需要什么版本的 Node\.js？

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

### @fevex/openai 可以商用吗？

@fevex/openai 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @fevex/openai 的下载量有多少？

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

### @fevex/openai 还在维护吗？

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