OpenAI 兼容协议

420 阅读3分钟

OpenAI 兼容协议

OpenAI 兼容协议是指其他厂商或开源项目提供的 API 在设计上与 OpenAI 的 API 保持一致,以便开发者能够通过 OpenAI 提供的 SDK 无缝迁移或切换使用不同的 AI 模型。这种兼容性主要体现在以下几个方面:

  • 相同的端点:提供与 OpenAI 相同的 API 端点,例如/v1/completions用于文本生成,/v1/embeddings用于生成嵌入向量等。
  • 一致的参数:使用与 OpenAI 相同的参数名称和格式,例如modelprompttemperaturemax_tokens等。
  • 身份验证方式:使用类似的 API 密钥进行身份验证,通常通过 HTTP 头部的Authorization字段传递。

OpenAI 兼容协议的存在有诸多好处,它可以降低开发者的迁移成本,通过更换不同 API 轻松切换不同的 AI 模型,而无需修改现有代码。同时,也促进了 AI 生态系统的发展,兼容性鼓励更多厂商和开源项目加入,形成更丰富的 AI 生态系统。

OpenAI API端点:

  1. 对话类: - 多轮对话(Chat Completions)POST https://api.openai.com/v1/chat/completions,用于与模型进行多轮对话交互,生成文本回复。
  2. 私有化模型训练类
  • 创建微调任务(Fine - tunes)POST https://api.openai.com/v1/fine - tunes,用于上传训练数据并创建一个微调任务。
  • 获取微调任务列表(Fine - tunes List)GET https://api.openai.com/v1/fine - tunes,获取所有的微调任务列表。
  • 获取单个微调任务详情(Fine - tunes Retrieve)GET https://api.openai.com/v1/fine - tunes/{fine - tune - id},获取指定微调任务的详细信息。
  • 取消微调任务(Fine - tunes Cancel)POST https://api.openai.com/v1/fine - tunes/{fine - tune - id}/cancel,取消正在进行的微调任务。
  • 获取微调任务事件(Fine - tunes Events)GET https://api.openai.com/v1/fine - tunes/{fine - tune - id}/events,获取指定微调任务的训练过程事件。
  • 删除模型(Delete Model)DELETE https://api.openai.com/v1/models/{model},删除指定的微调模型。
  1. 通用类
  • 获取模型列表(Models List)GET https://api.openai.com/v1/models,获取OpenAI可用的模型列表。
  • 获取模型详情(Models Retrieve)GET https://api.openai.com/v1/models/{model},获取指定模型的详细信息。
  • 上传文件(Files Upload)POST https://api.openai.com/v1/files,上传文件,主要用于微调的训练数据集、验证数据集等。
  1. 图片&音频类
  • 图像生成(Images Generations)POST https://api.openai.com/v1/images/generations,根据文本描述生成图像。
  • 图像编辑(Images Edits)POST https://api.openai.com/v1/images/edits,对给定图像进行编辑,需要提供图像和标记编辑点的RGBA掩码等参数。
  • 图像变体(Images Variations)POST https://api.openai.com/v1/images/variations,生成给定图像的变体。
  • 语音转文本(Audio Transcriptions)POST https://api.openai.com/v1/audio/transcriptions,基于Whisper模型,将语音文件转换为文本。
  • 文本转语音(Audio Speeches)POST https://api.openai.com/v1/audio/speeches,将输入的文本合成为语音。
  1. 其他
  • 文本补全(Completions)POST https://api.openai.com/v1/completions,用于基于给定的提示生成文本,不具备对话交互能力,常用于一次性生成文章、回答问题等任务。
  • 文本审查(Moderations)POST https://api.openai.com/v1/moderations,检测文本中的违规内容,如是否包含违规内容等。

更多相关内容请参考OpenAI官方文档获取最新和最准确的信息。