Python使用OpenAI的API_python项目设置 openai api 密钥

OpenAI API

OpenAI API可以应用于几乎所有涉及生成自然语言、代码或图像的任务。提供了一系列不同能力级别的模型，适用于不同任务的，并且能够微调自己的自定义模型。

OpenAI API参考：https://platform.openai.com/docs/api-reference

安装OpenAI库

或安装其他的开源大语言模型

pip install openai
1

设置OpenAI API秘钥

设置OpenAI API秘钥有如下2种方式

import os
from openai import OpenAI

# 方式一
# 设置OpenAI的BASE_URL、API_Key
# client = OpenAI(api_key="", base_url="")

# 方式二
# 设置OpenAI的BASE_URL、API_Key
os.environ["OPENAI_BASE_URL"] = "https://xxx.com/v1"
os.environ["OPENAI_API_KEY"] = "sk-fDqouTlU62yjkBhF46284543Dc8f42438a9529Df74B4Ce65"
client = OpenAI()
1
2
3
4
5
6
7
8
9
10
11
12

列出模型信息

列出当前可用的模型，并提供每个模型的基本信息

models = client.models.list()
print(models)
1
2

SyncPage[Model](data=[Model(id='gpt-3.5-turbo-1106', created=1698959748, object='model', owned_by='system'),
                      Model(id='gpt-3.5-turbo-instruct', created=1692901427, object='model', owned_by='system'),
                      Model(id='gpt-3.5-turbo-16k-0613', created=1685474247, object='model', owned_by='openai')],
                object='list')
1
2
3
4

各项参数：

created: 模型创建的时间戳，单位为Unix时间戳（自1970年1月1日（00:00:00 GMT）以后的秒数）

id: 模型的唯一标识符

object: 表示的是当前对象的类型

owned_by: 表示的是模型的所有者
1
2
3
4
5
6
7

获取模型ID列表

model_list = []

for model in models.data:
    model_list.append(model.id )

print(model_list)
1
2
3
4
5
6

根据模型ID获取指定模型实例

from openai import OpenAI
client = OpenAI()

gpt = client.models.retrieve("gpt-3.5-turbo")
print(gpt)
1
2
3
4
5

Model(id='gpt-3.5-turbo', created=1677610602, object='model', owned_by='openai')
1

Chat聊天

使用Chat聊天API实现对话任务，以消息列表作为输入，并返回模型生成的消息作为输出。尽管聊天格式旨在使多轮对话变得简单，但它同样适用于没有任何对话的单轮任务。

from openai import OpenAI  # 导入OpenAI库

client = OpenAI()  # 创建OpenAI客户端对象

# 调用模型
completion = client.chat.completions.create(
    model="gpt-3.5-turbo",
    messages=[
        {"role": "system", "content": "你是一个乐于助人的助手。"},
        {"role": "user", "content": "你好!"}
    ]
)

# 输出模型回复
print(completion.choices[0].message)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

ChatCompletionMessage(content='你好! 有什么问题我可以帮助你解答吗？', role='assistant', function_call=None, tool_calls=None)
1

消息角色

messages是一个列表，包含多个消息。每个消息都有一个role和content。

消息角色有三种：system、user和assistant。每一种角色都有不同的含义和作用。

system：系统消息主要用于设定对话的背景或上下文。可以帮助模型理解它在对话中的角色和任务。例如，通过系统消息来设定一个场景，让模型知道它是在扮演一个知识丰富的AI助手。

user：用户消息包含用户想要模型回答或完成的请求。用户消息可以是一个问题、一段话，或者任何其他用户希望模型响应的内容。

assistant：助手消息是模型的回复。
1
2
3
4
5

请求参数说明

使用OpenAI时，调用大模型API，大概会涉及以下参数：

响应参数说明

使用OpenAI时，调用大模型API后，模型响应内容，大概会涉及以下参数：

文本生成

文本生成补全（Completion）是该API的核心功能，提供了一个灵活和强大的接口。用户输入一些文本作为提示词（Prompt），API会返回匹配用户提供的指令或上下文的补全文本。

from openai import OpenAI  # 导入OpenAI库

client = OpenAI()  # 创建OpenAI客户端对象

response = client.completions.create(
  model="gpt-3.5-turbo-instruct",
  prompt="你好，很高兴",
  temperature=0.5
)
print(response.choices[0].text)
1
2
3
4
5
6
7
8
9
10

认识你！我是一个人工智能助手
1

语音生成

接受三个关键输入：

模型

应转换为音频的文本

用于生成音频的语音
1
2
3
4
5

from openai import OpenAI  # 导入OpenAI库

client = OpenAI()  # 创建OpenAI客户端对象

speech_file_path = "./speech.mp3"  # 定义要保存生成语音文件的路径

# 向OpenAI API 发送请求，生成语音文件
response = client.audio.speech.create(
  model="tts-1",  # 指定使用的语音生成模型
  voice="alloy",  # 指定使用的语音风格
  input="Today is a wonderful day to build something people love!"  # 要转换为语音的输入文本
)

# 将生成的语音文件保存到本地磁盘
response.stream_to_file(speech_file_path)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

语音选项:alloy、echo、fable、onyx、nova、shimmer

支持的输出格式：默认响应格式为“mp3”，但也可以使用“opus”、“aac”、“flac”和“pcm”等其他格式。

Opus：用于互联网流媒体和通信，低延迟

AAC：用于数字音频压缩，YouTube、Android、iOS 首选

FLAC：用于无损音频压缩，受到音频爱好者存档的青睐

WAV：未压缩的 WAV 音频，适合低延迟应用，以避免解码开销

PCM：与 WAV 类似，但包含 24kHz 的原始样本（16 位有符号、低端），没有标头
1
2
3
4
5
6
7
8
9

旧版OpenAI API

安装OpenAI库

OpenAI API应该是从1.0.0版本开始进行了升级，写法相比新版API有所不同

pip install openai==0.28.1
1

设置OpenAI API秘钥

import os

os.environ["OPENAI_BASE_URL"] = "https://xxx.com/v1"
os.environ["OPENAI_API_KEY"] = "sk-BGFnOL9Q4c99B378B66cT3BlBKFJ28839b4813bc437B82c2"
1
2
3
4

Chat聊天

import openai

response = openai.ChatCompletion.create(
  model="gpt-3.5-turbo",
  messages=[
        {"role": "system", "content": "你是一个乐于助人的助手。"},
        {"role": "user", "content": "你好啊！"},
    ],
  temperature=0.8,
  max_tokens=30
)
print(response['choices'][0]['message']['content'])
1
2
3
4
5
6
7
8
9
10
11
12

文本生成

import openai

response = openai.completions.create(
  model="gpt-3.5-turbo-instruct",
  prompt="你是"
)
print(response.choices[0].text.strip())
1
2
3
4
5
6
7