OpenAI 类型Spec 定义

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

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

使用软件包

安装软件包

您可以通过运行安装软件包 npm i @azure-tools/openai-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。 。 。 .

手动刷新

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

• 为工作流程排队新的运行 .

• 本地运行以下命令 :

  yarn install
  yarn import-openapi
  yarn tsp:all
  yarn tsp:validate
  yarn tsp:validate:export
  

出版新版本

弹出版本

跳出版本由自动处理 请使用工作流程。确保你跟随 常规承诺 引发新的释放.

发布软件包

GitHub 发布

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

公共 npm 种子

以上工作流程完成后,请确保您手动排队 伙伴管道 并使用以下球队名称: azureainfoundrydevx.