# @godspeedai/cognate-provider-openai-compatible 中文文档

规范地址：https://npmcn.com/package/%40godspeedai/cognate-provider-openai-compatible/

版本：0\.10\.0
npm 元数据更新时间：2026-11-16T03:47:08.120Z
中文译文更新时间：2026-11-16T18:05:37.935Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：35.4 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：3 个
- 首次发布：2026-10-09T02:30:31.221Z
- 最新版本发布：2026-11-16T03:47:07.730Z
- 近 30 天下载量：3746（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 20 个）

## 中文简介

OpenAI兼容聊天完成端点(llama.cpp, vLLM, Ollama's /v1, hosted API)的模型提供器取出;没有SDK.

## 安装

```sh
npm install @godspeedai/cognate-provider-openai-compatible
```

也可以使用：`pnpm add @godspeedai/cognate-provider-openai-compatible`、`yarn add @godspeedai/cognate-provider-openai-compatible`、`bun add @godspeedai/cognate-provider-openai-compatible`

## README

# @ godspideai/ cognate- professor- openai- 兼容

任何 OpenAI 兼容的聊天完成端点的 Cognate 模型提供者 – lama.cpp, vLLM,奥拉玛的 `/v1`,LM工作室,或托管 API —— 超平面 `fetch`没有供应商SDK.

**何时使用此软件包 :** 您的应用程序需要一个真正的模型,服务器会说话 开放AI `/chat/completions` 线条格式. 在测试中用于确定脚本的答案, 使用 [`@godspeedai/cognate-provider-local`](https://www.npmjs.com/package/@godspeedai/cognate-provider-local) 换句话说.

## 安装

```sh
bun add @godspeedai/cognate-provider-openai-compatible
```

要求数 [阿宝](https://bun.sh/) >= 1.4.0 (使用平台) `fetch`, (中文(简体) ), `AbortSignal`网络 溪流). SDK号飞船 Bun-native TypeScript源, 所以添加 `@types/bun` 财务报告和审定财务报表 `@types/node` 在检查您的工程时, 作为非依赖性 .

## 快开始

```ts
import { openAICompatible } from "@godspeedai/cognate-provider-openai-compatible";

const provider = openAICompatible({
  id: "gpt-4o-mini", // provider id becomes `openai-compatible:gpt-4o-mini`
  baseURL: process.env.OPENAI_BASE_URL ?? "https://api.openai.com/v1",
  model: "gpt-4o-mini",
  apiKey: () => process.env.OPENAI_API_KEY ?? "", // read per request, never stored
  timeoutMs: 60_000,
});

const response = await provider.generate({
  messages: [{ role: "user", content: "Hello!" }],
});
console.log(response.message.content);
console.log(response.usage); // { inputTokens, outputTokens } when the server reports usage

// Streaming: text deltas and tool-call deltas, then a final `done` delta
// carrying the assembled full response.
for await (const delta of provider.stream({ messages: [{ role: "user", content: "Hello!" }] })) {
  if (delta.type === "text") process.stdout.write(delta.text);
}
```

点 `baseURL` 例如,在任何兼容的服务器上 `http://localhost:11434/v1` 奥拉马 或者你的lama.cpp/vLLM路线. 供应商向 `<baseURL>/chat/completions`。 。 。 .

## 地图

-   **信件和工具** 成为 OpenAI 线形: 工具为 `{ type: "function", function: { name, description, parameters } }`,助理工具调用 与JSON的争辩, `responseFormat.schema` 作为 `json_schema` (或 `json_object` 没有计划),加 `max_tokens` 财务报告和审定财务报表 `temperature`。 。 。 .
-   **流线** 解析 SSE `data:` 线条(容忍块边界),累积工具 名称和论据被分割成小块 接下来是 `tool_call` 条目和 a `done` 三角洲与集合反应.
-   **错误** 输入 `ModelProviderError` 类型 : `unauthorized` (401/403) (中文(简体) ), `rate_limited` (429个), `invalid_request` (其他为4xx), `unavailable` (5xx,网络错误, 暂停, `cancelled` (电话中断)和 `malformed_response` (无相体相.

这个 `apiKey` 函数被调用到每个请求,其值从未被存储、记录或包含 在错误信息或能力合同中,提供者公布.

## 内核组件

`modelComponent(provider)` 将提供者包成内核 `Component` 出版时间 `model.generate` 因此,运行时间可以像其他能力一样选择和引用:

```ts
import { modelComponent } from "@godspeedai/cognate-provider-openai-compatible";

const component = modelComponent(provider);
// pass it in the runtime's `components` list
```

## 限制

-   只聊天补全:没有嵌入,文件,音频,或助理状态的API.
-   特性旗默认为 `stream`编号 :`tool_use`编号 :`structured_output` `true`, (中文(简体) ), `multimodal_input` `false`, (中文(简体) ), `context_limit` `8192`覆盖 `features` 来配合你的 服务器实际支持,否则资格检查会信任服务器可能不尊重的标记.
-   结构化输出取决于服务器的荣誉 `response_format`; 提供者提供 无论服务器返回什么.
-   工具调用参数必须有效 JSON 在线上; 流出错误的服务器 参数表面 `malformed_response`。 。 。 .

## 相关软件包

-   [`@godspeedai/cognate-capabilities`](https://www.npmjs.com/package/@godspeedai/cognate-capabilities) —— 说 页:1 `ModelProvider` 合同, `ModelProviderError`,和选择引擎.
-   [`@godspeedai/cognate-provider-local`](https://www.npmjs.com/package/@godspeedai/cognate-provider-local) —— 说 确定测试和离线使用的脚本提供者.
-   [`@godspeedai/cognate-runtime-bun`](https://www.npmjs.com/package/@godspeedai/cognate-runtime-bun) —— 说 引用运行时间; 通过一个提供者(或其组件)给代理商一个模型.
-   [`@godspeedai/cognate`](https://www.npmjs.com/package/@godspeedai/cognate) SDK伞.

## 许可证

阿帕奇 - 2.0

## 常见问题

### @godspeedai/cognate-provider-openai-compatible 是什么？

OpenAI兼容聊天完成端点\(llama\.cpp, vLLM, Ollama's /v1, hosted API\)的模型提供器取出;没有SDK\.

### 如何安装 @godspeedai/cognate-provider-openai-compatible？

在项目目录运行 npm install @godspeedai/cognate-provider-openai-compatible，或使用 pnpm add / yarn add / bun add。

### @godspeedai/cognate-provider-openai-compatible 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/godspeedai\_\_cognate-provider-openai-compatible 是否存在。

### @godspeedai/cognate-provider-openai-compatible 支持 ESM 还是 CommonJS？

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

### @godspeedai/cognate-provider-openai-compatible 可以商用吗？

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

### @godspeedai/cognate-provider-openai-compatible 的下载量有多少？

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

### @godspeedai/cognate-provider-openai-compatible 还在维护吗？

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

