# @core-ai/openai-compat 中文文档

规范地址：https://npmcn.com/package/%40core-ai/openai-compat/

版本：0\.38\.0
npm 元数据更新时间：2026-11-06T13:56:33.475Z
中文译文更新时间：2026-11-10T19:10:24.333Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：6.4 kB，5 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2026-07-15T01:26:39.944Z
- 最新版本发布：2026-11-06T13:56:33.146Z
- 近 30 天下载量：3664（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：30（近 12 个月 30 个）

## 中文简介

为 @ core-ai/ core-ai 提供兼容的聊天补全服务

## 安装

```sh
npm install @core-ai/openai-compat
```

也可以使用：`pnpm add @core-ai/openai-compat`、`yarn add @core-ai/openai-compat`、`bun add @core-ai/openai-compat`

## README

# @ core-ai/openai-compat

OpenAI 兼容的聊天补全提供者 `@core-ai/core-ai`。 。 。 .

## 安装

```bash
npm install @core-ai/core-ai @core-ai/openai-compat zod
```

## 使用量

```ts
import { generate } from '@core-ai/core-ai';
import { createOpenAICompat } from '@core-ai/openai-compat';

const provider = createOpenAICompat({
    apiKey: process.env.API_KEY,
    baseURL: 'https://gateway.example.com/v1',
});

const result = await generate({
    model: provider.chatModel('qwen3-235b'),
    messages: [{ role: 'user', content: 'Hello!' }],
});

console.log(result.content);
```

已知的 OpenAI 模型映射 `maxTokens` 到 Chat 所需的参数 结业. 未知模式ID默认为 `max_tokens`设置全供应商 当一个终点需要时, 兼容性默认 `max_completion_tokens`数字 :

```ts
const provider = createOpenAICompat({
    apiKey: process.env.API_KEY,
    baseURL: 'https://gateway.example.com/v1',
    maxTokensParameter: 'max_completion_tokens',
});

await generate({
    model: provider.chatModel('custom-reasoning-model'),
    messages: [{ role: 'user', content: 'Hello!' }],
    maxTokens: 1024,
});
```

这家提供商只披露了查特补全模型. 它会接受已知的 openAI 兼容网关所使用的非标准响应字段,包括 `reasoning_content` 财务报告和审定财务报表 `reasoning`设置 `reasoning: false` 当这些字段 不应被解释为推理产出.

结构化输出默认使用一个强制函数工具用于宽端点 兼容性。 如果端点支持严格的JSON Schema响应格式, 选择使用 `structuredOutputMode: 'json-schema'`数字 :

```ts
const provider = createOpenAICompat({
    apiKey: process.env.API_KEY,
    baseURL: 'https://gateway.example.com/v1',
    structuredOutputMode: 'json-schema',
});
```

## 常见问题

### @core-ai/openai-compat 是什么？

为 @ core-ai/ core-ai 提供兼容的聊天补全服务

### 如何安装 @core-ai/openai-compat？

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

### @core-ai/openai-compat 支持 TypeScript 吗？

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

### @core-ai/openai-compat 支持 ESM 还是 CommonJS？

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

### @core-ai/openai-compat 可以商用吗？

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

### @core-ai/openai-compat 的下载量有多少？

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

### @core-ai/openai-compat 还在维护吗？

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