＜span class=“js_title_inner“＞OpenAI的 OpenAPI 规范简介＜/span＞

背景

OpenAI OpenAPI 规范是由 OpenAI 官方发布的一个开源项目，旨在为 OpenAI API 提供标准化的接口定义。

这个项目托管在 GitHub 上，为开发者提供了一个清晰、结构化的方式来理解和使用 OpenAI 的强大 API。

OpenAI API规范

由 OpenAI 提供的一套接口，允许客户端与大模型进行交互

好处：

1. 高度的灵活性和广泛的应用场景

2. 基于 HTTP 的通信框架，是稳定和标准化的访问方式

3. RESTful 架构，简单易用，确保了与各种编程语言和平台的兼容性

由于本质上还是一个C/S交互模型，所以可以拆解步骤如下：

1. Client端操作

• 客户端通过网络将请求发送至OpenAI服务器，需包含认证信息（如API Key）。

• 开发者按照OpenAI API规范（RESTful架构）组装请求参数，包括：
  ✓ 模型选择（如GPT-3.5/4）
  ✓ 输入文本（prompt）
  ✓ 参数配置（temperature, max_tokens等）

• 请求通过HTTP协议（通常为POST）封装。

• 构建API请求

• 发送API请求

• Server端处理

• • 将模型输出封装为结构化数据（JSON格式），包含：
    ✓ 生成内容（choices字段）
    ✓ 使用量统计（usage字段）

  • 大模型（如GPT系列）执行推理：
    ✓ 解析输入文本
    ✓ 生成预测结果（如补全文本、代码等）

  • 可能涉及多轮计算（长文本分块处理）。

  • 验证请求合法性（身份鉴权、参数校验）。

  • 分配计算资源，将请求传递至对应模型服务。

  • 服务器处理请求

  • 模型处理/文本生成

  • 构建API响应

  请求报文-body参数

  请求body提供了多个参数和选项，用于控制生成结果的质量、多样性和长度等特性。

  下面是一个curl案例：

  

  常见的一些参数是：Temperature/Top_k/Top_p

  

  其他的可选参数：

  

  请求报文-messages 参数

  messages 必须是消息对象 ( message object )的数组

  每个消息对象有一个 role ( “system”, “user”, 或 “assistant” ) 和 content ( 消息的内容 )

  不同role的消息数量限定

  最多1 条role=system的消息

  若干条role=user或者role=assistant的消息

  消息有序性

  大模型会先使用系统消息 ( “system” ) 格式化，然后交替读取用户消息 ( “user” ) 和助手消息 ( “assistant” )

  响应报文

  响应示例：

  

  其他响应参数：

  

  • choices.message:大模型输出结果

  • choices.usage：token统计信息