# @anvia/openai 中文文档

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

版本：1\.3\.8
npm 元数据更新时间：2026-11-06T14:25:16.321Z
中文译文更新时间：2026-11-06T14:09:09.297Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：283 kB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@anvia/core ^1\.18\.0
- 首次发布：2026-05-03T14:58:50.632Z
- 最新版本发布：2026-11-06T14:25:15.823Z
- 近 30 天下载量：3037（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：87（近 12 个月 87 个）

## 中文简介

Anvia的OpenAI供应商适配器.

## 安装

```sh
npm install @anvia/openai
```

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

## README

# @anvia/openai (英语)

连接 Anvia 代理到 OpenAI 或 OpenAI 兼容的端点 。 使用一个客户端 聊天、打字决定、嵌入、图像、讲话和抄本.

Azure OpenAI 和 Azure AI 创建,使用 [`@anvia/azure`](https://npmcn.com/package/%40anvia/provider-azure/README.md) 用于Azure端点和认证配置.

## 安装

```sh
pnpm add @anvia/openai @anvia/core
```

## 快速启动

设定 `OPENAI_API_KEY` 在运行此示例之前.

```ts
import { Agent } from "@anvia/core";
import { OpenAIClient } from "@anvia/openai";

const client = new OpenAIClient({
  apiKey: process.env.OPENAI_API_KEY!,
});
const agent = new Agent({
  id: "assistant",
  model: client.completionModel({ modelId: "gpt-5.6", api: "responses" }),
  instructions: "Answer clearly and concisely.",
});

const result = await agent.generate({
  prompt: "What should I check before launching a new product?",
});

if (result.type === "response") {
  console.log(result.output);
}
```

## 类型决定

```ts
import { OpenAIClient, GPT_6_LUNA } from "@anvia/openai";
import { check, decide } from "@anvia/core/decision";

const model = new OpenAIClient({ apiKey: process.env.OPENAI_API_KEY! }).decisionModel({
  modelId: GPT_6_LUNA,
});
const result = await decide({
  model,
  state: { message: "Please refund my duplicate charge." },
  questions: { refund: check({ instructions: "Is a refund requested?" }) },
});
console.log(result.answers.refund.probability);
```

使用带有OpenAI SDK 7.30.0+的专用决定API. 支持文字和结构化的JSON; 结构状态被序列化为文本。 拒绝投掷 `DecisionRefusalError` 从核心. 见地图绘制、限制、批次和拒绝处理的使用指南.

## 你能建造的东西

-   聊天补全和响应 API,流化,工具,和结构化输出.
-   为所支持的模型打入了推理控制.
-   输入分类,多标签检查,和通过数字评分 `decisionModel()` 财务报告和审定财务报表 `decide()`。 。 。 .
-   嵌入,图像生成,语音生成,抄录,和模型上市.
-   自定义端点通过 `baseUrl`。 。 。 .

模型处理默认为聊天补全. 该示例明确选择响应. Bun用户可以安装相同的软件包 `bun add`。 。 。 .

## 学多点

-   [使用指南](https://github.com/anvia-hq/anvia/blob/main/docs/packages/provider-openai.md)
-   [Anvia 概览](https://github.com/anvia-hq/anvia/blob/main/README.md)
-   [捐款](https://github.com/anvia-hq/anvia/blob/main/CONTRIBUTING.md)

## 兼容模型元数据

`listModels()` 广告保护地 `supported_parameters` 作为 `supportedParameters` 当它是一系列字符串,并且对象值 `reasoning` 作为特定供应商 元数据。 使用前验证推理字段;其方案因服务而异. 对象值 `pricing` 以同样的方式保存;在使用前验证其字段.

## 常见问题

### @anvia/openai 是什么？

Anvia的OpenAI供应商适配器\.

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

在项目目录运行 npm install @anvia/openai，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@anvia/core（^1\.18\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

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

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

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

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

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

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

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

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

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

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