OpenAI API教程

OpenAI API 是由OpenAI公司开发，为LLM开发人员提供的一个简单接口。通过此API能在应用程序中方便地调用OpenAI提供的大模型基础能力。 OpenAI的API协议已成为LLM领域的标准。

本文将首先介绍OpenAI API基础知识和模型，然后以Chat Completions API和Embedding API为例子介绍OpenAI API的用法。 最后使用Embedding模型构建一个网站智能问答系统。本文内容包括：

• API快速入门
• OpenAI提供的模型
• Chat Completions API和Embedding API
• 基于Embedding模型构建智能问答系统

API快速入门

• 安装OpenAI Python Library

shell
复制代码
pip install --upgrade openai

• 设置API Key

shell
复制代码
export OPENAI_API_KEY='your-api-key-here'

• 发送请求

  • python

    python
    复制代码
    from openai import OpenAI
    client = OpenAI()
    # 请求参数将在下文中介绍
    completion = client.chat.completions.create(
      model="gpt-3.5-turbo",
      messages=[
        {"role": "system", "content": "You are a poetic assistant, skilled in explaining complex programming concepts with creative flair."},
        {"role": "user", "content": "Compose a poem that explains the concept of recursion in programming."}
      ]
    )
    
    print(completion.choices[0].message)
    

  • curl

    shell
    复制代码
    curl https://api.openai.com/v1/chat/completions   -H "Content-Type: application/json"   -H "Authorization: Bearer $OPENAI_API_KEY"   -d '{
      "model": "gpt-3.5-turbo",
      "messages": [
        {
          "role": "system",
          "content": "You are a poetic assistant, skilled in explaining complex programming concepts with creative flair."
        },
        {
          "role": "user",
          "content": "Compose a poem that explains the concept of recursion in programming."
        }
      ]
    }'
    

OpenAI提供的模型

OpenAI API 提供不同功能和价位的模型。您甚至可以根据自己的具体使用情况对模型进行定制和微调。

模型	描述	常用模型
GPT-4 and GPT-4 Turbo	一套在 GPT-3.5 基础上改进的模型，可理解并生成自然语言或代码	gpt-4-turbo-preview
GPT-3.5 Turbo	一套在 GPT-3.5 基础上改进的模型，可理解并生成自然语言或代码	gpt-3.5-turbo
DALL·E	能根据自然语言提示生成和编辑图像的模型	dall-e-3
TTS	一套可将文本转换成自然发音口语音频的模型	tts-1
Whisper	可以将音频转换为文本的模型	whisper-1
Embeddings	一套可将文本转换为数字形式的模型	text-embedding-3-large
Moderation	可检测文本是否敏感或不安全的微调模型	text-moderation-latest
GPT base	一套不遵循指令的模型，可理解并生成自然语言或代码	babbage-002

Chat Completions API

Chat Model将对话信息以列表的形式作为输入，并将模型生成的信息作为输出返回。 虽然聊天格式是为了方便多轮对话而设计的，但它同样适用于没有任何对话的单轮任务。

Example Reqeust

• curl request

shell
复制代码
curl https://api.openai.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -d '{
    "model": "gpt-3.5-turbo",
    "messages": [
      {
        "role": "system",
        "content": "You are a helpful assistant."
      },
      {
        "role": "user",
        "content": "Who won the world series in 2020?"
      },
      {
        "role": "assistant",
        "content": "The Los Angeles Dodgers won the World Series in 2020."
      },
      {
        "role": "user",
        "content": "Where was it played?"
      }
    ]
  }'

• python request

python
复制代码
from openai import OpenAI
client = OpenAI()

response = client.chat.completions.create(
  model="gpt-3.5-turbo",
  messages=[
    {"role": "system", "content": "You are a helpful assistant."},
    {"role": "user", "content": "Who won the world series in 2020?"},
    {"role": "assistant", "content": "The Los Angeles Dodgers won the World Series in 2020."},
    {"role": "user", "content": "Where was it played?"}
  ]
)

print(completion.choices[0].message)

Request主要输入是messages参数。messages必须是一个对象数组，其中每个对象都有一个角色（“system”、"user"或 “assistant”）和content。对话可以短至一条信息，也可以来回多次。

通常情况下，对话的格式是system在前，user和assistant交替在后。

system有助于设置assistant的行为。例如，您可以修改assistant的个性，或对其在整个对话过程中的行为提供具体指导。不过请注意，系统信息是可选的，如果没有系统信息，模型的行为可能与使用 "You are a helpful assistant."这样的通用信息类似。

user提供请求或评论，供assistant回复。assistant信息会存储以前的回复，但也可以由您自己编写，以提供所需的行为示例。

当用户引用之前的信息时，包括对话历史记录就显得非常重要。由于模型无法记忆过去的请求，因此所有相关信息都必须作为每次请求中对话历史的一部分提供。如果一个对话无法容纳在模型的标记限制内，就需要以某种方式将其缩短。

Example Response

json
复制代码
{
  "choices": [
    {
      "finish_reason": "stop",
      "index": 0,
      "message": {
        "content": "The 2020 World Series was played in Texas at Globe Life Field in Arlington.",
        "role": "assistant"
      },
      "logprobs": null
    }
  ],
  "created": 1677664795,
  "id": "chatcmpl-7QyqpwdfhqwajicIEznoc6Q47XAyW",
  "model": "gpt-3.5-turbo-0613",
  "object": "chat.completion",
  "usage": {
    "completion_tokens": 17,
    "prompt_tokens": 57,
    "total_tokens": 74
  }
}

每次响应，都包括一个finish_reason. finish_reason的可能值是：

• stop：API返回完整信息，或由通过 stop 参数提供的stop序列之一终止的消息
• length：不完整模型的输出，由于max_tokens参数或限制令牌
• function_call：模型决定调用一个函数
• content_filter:由于我们的内容过滤器中的标记而省略了内容
• null：API响应仍在进行中的或不完整

根据输入的参数不同，模型的返回可能包括不同的信息。

Embedding API

LLM的Embedding通常用在RAG中，给模型某个特定领域的知识，以提高生成文本的准确性和信息含量。

要获取Embedding，将文本字符串和Embedding模型名称（如 text-embedding-3-small）一起发送到 embeddings API 端点。响应将包含一个Embedding（浮点数列表）， 可以提取它，保存在矢量数据库中，并用于许多不同的用例。

Example Request

• curl

shell
复制代码
curl https://api.openai.com/v1/embeddings \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -d '{
    "input": "Your text string goes here",
    "model": "text-embedding-3-small"
  }'

• python

python
复制代码
from openai import OpenAI
client = OpenAI()

response = client.embeddings.create(
    input="Your text string goes here",
    model="text-embedding-3-small"
)

print(response.data[0].embedding)

Example Response

json
复制代码
{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [
        -0.006929283495992422,
        -0.005336422007530928,
        ... (omitted for spacing)
        -4.547132266452536e-05,
        -0.024047505110502243
      ],
    }
  ],
  "model": "text-embedding-3-small",
  "usage": {
    "prompt_tokens": 5,
    "total_tokens": 5
  }
}

如何学习大模型 AI ？

由于新岗位的生产效率，要优于被取代岗位的生产效率，所以实际上整个社会的生产效率是提升的。

但是具体到个人，只能说是：

“最先掌握AI的人，将会比较晚掌握AI的人有竞争优势”。

这句话，放在计算机、互联网、移动互联网的开局时期，都是一样的道理。

我在一线互联网企业工作十余年里，指导过不少同行后辈。帮助很多人得到了学习和成长。

我意识到有很多经验和知识值得分享给大家，也可以通过我们的能力和经验解答大家在人工智能学习中的很多困惑，所以在工作繁忙的情况下还是坚持各种整理和分享。但苦于知识传播途径有限，很多互联网行业朋友无法获得正确的资料得到学习提升，故此将并将重要的AI大模型资料包括AI大模型入门学习思维导图、精品AI大模型学习书籍手册、视频教程、实战学习等录播视频免费分享出来。

😝有需要的小伙伴，可以点击下方链接免费领取或者V扫描下方二维码免费领取🆓

第一阶段（10天）：初阶应用

该阶段让大家对大模型 AI有一个最前沿的认识，对大模型 AI 的理解超过 95% 的人，可以在相关讨论时发表高级、不跟风、又接地气的见解，别人只会和 AI 聊天，而你能调教 AI，并能用代码将大模型和业务衔接。

• 大模型 AI 能干什么？
• 大模型是怎样获得「智能」的？
• 用好 AI 的核心心法
• 大模型应用业务架构
• 大模型应用技术架构
• 代码示例：向 GPT-3.5 灌入新知识
• 提示工程的意义和核心思想
• Prompt 典型构成
• 指令调优方法论
• 思维链和思维树
• Prompt 攻击和防范
• …

第二阶段（30天）：高阶应用

该阶段我们正式进入大模型 AI 进阶实战学习，学会构造私有知识库，扩展 AI 的能力。快速开发一个完整的基于 agent 对话机器人。掌握功能最强的大模型开发框架，抓住最新的技术进展，适合 Python 和 JavaScript 程序员。

• 为什么要做 RAG
• 搭建一个简单的 ChatPDF
• 检索的基础概念
• 什么是向量表示（Embeddings）
• 向量数据库与向量检索
• 基于向量检索的 RAG
• 搭建 RAG 系统的扩展知识
• 混合检索与 RAG-Fusion 简介
• 向量模型本地部署
• …

第三阶段（30天）：模型训练

恭喜你，如果学到这里，你基本可以找到一份大模型 AI相关的工作，自己也能训练 GPT 了！通过微调，训练自己的垂直大模型，能独立训练开源多模态大模型，掌握更多技术方案。

到此为止，大概2个月的时间。你已经成为了一名“AI小子”。那么你还想往下探索吗？

• 为什么要做 RAG
• 什么是模型
• 什么是模型训练
• 求解器 & 损失函数简介
• 小实验2：手写一个简单的神经网络并训练它
• 什么是训练/预训练/微调/轻量化微调
• Transformer结构简介
• 轻量化微调
• 实验数据集的构建
• …

第四阶段（20天）：商业闭环

对全球大模型从性能、吞吐量、成本等方面有一定的认知，可以在云端和本地等多种环境下部署大模型，找到适合自己的项目/创业方向，做一名被 AI 武装的产品经理。

• 硬件选型
• 带你了解全球大模型
• 使用国产大模型服务
• 搭建 OpenAI 代理
• 热身：基于阿里云 PAI 部署 Stable Diffusion
• 在本地计算机运行大模型
• 大模型的私有化部署
• 基于 vLLM 部署大模型
• 案例：如何优雅地在阿里云私有部署开源大模型
• 部署一套开源 LLM 项目
• 内容安全
• 互联网信息服务算法备案
• …

学习是一个过程，只要学习就会有挑战。天道酬勤，你越努力，就会成为越优秀的自己。

如果你能在15天内完成所有的任务，那你堪称天才。然而，如果你能完成 60-70% 的内容，你就已经开始具备成为一名大模型 AI 的正确特征了。

这份完整版的大模型 AI 学习资料已经上传CSDN，朋友们如果需要可以微信扫描下方CSDN官方认证二维码免费领取【保证100%免费】

😝有需要的小伙伴，可以Vx扫描下方二维码免费领取==🆓