# @azure-tools/openai-typespec 中文文档

规范地址：https://npmcn.com/package/%40azure-tools/openai-typespec/

版本：1\.34\.1
npm 元数据更新时间：2026-11-04T02:45:52.329Z
中文译文更新时间：2026-11-07T14:02:19.089Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40azure-tools/openai-typespec
原文对照：https://npmcn.com/package/%40azure-tools/openai-typespec/?lang=original

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

- 包体积（解压后）：10 MB，216 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：0 个
- peer 依赖：@typespec/http ^1\.14\.0，@typespec/openapi ^1\.14\.0
- 首次发布：2025-11-12T18:24:06.498Z
- 最新版本发布：2026-11-04T02:45:52.167Z
- 近 30 天下载量：36997（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：50（近 12 个月 50 个）

## 中文简介

TypeSpec 定义是自动导入 [openAI OpenAPI 描述](https://github.com/openai/openai-openapi) 使用 [tsp- openapi 3 (韩语)](https://www.npmjs.com/package/@typespec/openapi3)。 。 。 .

## 安装

```sh
npm install @azure-tools/openai-typespec
```

也可以使用：`pnpm add @azure-tools/openai-typespec`、`yarn add @azure-tools/openai-typespec`、`bun add @azure-tools/openai-typespec`

## README

# OpenAI 类型Spec 定义

TypeSpec 定义是自动导入 [openAI OpenAPI 描述](https://github.com/openai/openai-openapi) 使用 [tsp- openapi 3 (韩语)](https://www.npmjs.com/package/@typespec/openapi3)。 。 。 .

请不要提交任何 任何修改 因为它会 被下一个进口.

## 使用软件包

### 安装软件包

您可以通过运行安装软件包 `npm i @azure-tools/openai-typespec` 或您的软件包管理器的等同命令.

### 示例定义

以下是一个在安装后如何使用类型定义的例子 .

```TypeSpec
// using an import with a path instead of the whole package is important
// to avoid importing operations which you most likely don't want in your definition
import "@azure-tools/openapi-typespec/models/responses";

using OpenAI;

model MyModel {
   someOpenAIProperty: OpenAI.Response;
}
```

### 版本政策

此软件包不遵循语义版本( SemVer) 。 这意味着任何版本的更新“May”都包含源断面变化,或者直接用于消耗性定义,或者间接用于生成这些定义的资产。 这种政策的主要原因是这个软件包是OpenAI共享的OpenAPI描述的自动导入,这些描述没有遵循任何特定的版本方案.

## 每周刷新一次

以下工作流程每周更新定义 `.github/workflows/weekly-ts.yml`。 。 。 .

## 手动刷新

如果您想要手动刷新定义, 您也可以:

-   为工作流程排队新的运行 .
    
-   本地运行以下命令 :
    
    ```shell
    yarn install
    yarn import-openapi
    yarn tsp:all
    yarn tsp:validate
    yarn tsp:validate:export
    ```
    

## 出版新版本

### 弹出版本

跳出版本由自动处理 [请使用工作流程](https://npmcn.com/package/.github/workflows/release-please.yml)。确保你跟随 [常规承诺](https://www.conventionalcommits.org/en/v1.0.0/) 引发新的释放.

### 发布软件包

#### GitHub 发布

在标签推后 `publish.yml` 工作流程将自动创建新的 GitHub 发布 。 也可以手动从网络界面/CLI中排入,确保您选择一个标签作为 _源分支_。 。 。 .

#### 公共 npm 种子

以上工作流程完成后,请确保您手动排队 [伙伴管道](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/1/Partner-Release-Pipeline?anchor=javascript/typescript-to-npmjs.org) 并使用以下球队名称: azureainfoundrydevx.

## 常见问题

### @azure-tools/openai-typespec 是什么？

TypeSpec 定义是自动导入 openAI OpenAPI 描述 使用 tsp- openapi 3 \(韩语\)。 。 。 \.

### 如何安装 @azure-tools/openai-typespec？

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

### @azure-tools/openai-typespec 支持 TypeScript 吗？

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

### @azure-tools/openai-typespec 支持 ESM 还是 CommonJS？

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

### @azure-tools/openai-typespec 可以商用吗？

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

### @azure-tools/openai-typespec 的下载量有多少？

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

### @azure-tools/openai-typespec 还在维护吗？

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