How to Use OpenAI API in Python(export openai key)

export openai key的进一步展开说明

OpenAI API: 使用Python增强代码的自然语言处理能力

介绍OpenAI

OpenAI是一个由营利性组织OpenAI LP和其母公司非营利性组织OpenAI Inc组成的人工智能研究实验室。

组织成立于2015年，由一群技术行业领袖共同创建，包括埃隆·马斯克（Elon Musk）、山姆·奥特曼（Sam Altman）、格雷格·布洛克曼（Greg Brockman）和伊利亚·苏茨克弗（Ilya Sutskever）。OpenAI的目标是以造福全人类为主旨，推动人工智能的发展与进步。

OpenAI的研究重点是开发和改进自然语言处理、机器学习和机器视觉等技术。组织的使命是创建安全有益的人工智能系统，以帮助解决全球一些最紧急的问题。

他们在人工智能领域做出了重大贡献。他们的一些重要项目包括GPT⑶（Generative Pre-trained Transformer 3），这是一个能够生成类似人类文本的语言模型，和DALL-E，这是一个能够根据文本描写生成原创图象的人工智能系统。

OpenAI API是甚么？

OpenAI API是一个强大的工具，为你的代码提供了自然语言处理（NLP）的能力。它是一个基于云的服务，允许你访问最早进的语言模型，用于分析和理解文本数据。

OpenAI API提供了多种语言模型，每一个模型都有其本身的优势和劣势。

OpenAI API能做甚么？

OpenAI API的一些奇异的地方：

使用GPT生成文本

GPT⑷（Generative Pre-trained Transformer 4）是OpenAI开发的最强大的语言模型之一。它是一个基于深度学习的模型，使用无监督学习来生成类似人类的文本。

此模型已训练了1万亿个参数，并且是目前可用的最大的语言模型，能够完成以下复杂任务：

文本补全：OpenAI API可以为给定的提示生成文本补全。这在各种利用中非常有用，从聊天机器人到文本编辑器都可以利用。

文本分类：OpenAI API可以将文本分类为情感、主题和意图等种别。这在垃圾邮件过滤、内容审核和客户支持等利用中非常有用。

语言翻译：OpenAI API可以将一种语言的文本翻译成另外一种语言。这在国际交换、文档翻译和语言学习等利用中非常有用。

问答：OpenAI API可以根据给定的上下文回答问题。这在虚拟助手、客户支持和教育资源等利用中非常有用。

文本摘要：OpenAI API可以将长篇文本摘要成较短的摘要。这在新闻文章、研究论文和法律文件等利用中非常有用。

语言生成：OpenAI API可以根据给定的提示生成联贯的段落文本。这在创意写作、聊天机器人和虚拟助手等利用中非常有用。

使用DALL-E生成图象

OpenAI API还可以根据你提供的描写生成图象。这是通过使用DALL-E模型实现的，DALL-E是一种能够根据文本描写生成高质量图象的神经网络模型。

DALL-E是OpenAI开发的一种语言模型，它可以从文本描写中生成各种图象，包括对象、场景和生物，使其成为创意利用的强大工具。

使用CLIP理解图象

CLIP（Contrastive Language-Image Pre-Training）是OpenAI开发的一种语言模型，可以理解文本和视觉信息。

它经过大量图象及其对应的标题的训练，可以根据文本描写辨认图象中的对象、场景和概念。

这使得CLIP在图象分类、物体检测、形状检测和其他计算机视觉任务中是一种有价值的工具。

使用Whisper进行语音到文本转换

OpenAI API不但限于文本的自然语言处理，还提供了一种独特的语音辨认工具称为Whisper。

Whisper是一种基于端到真个深度学习语音辨认系统，可以将音频文件转录为文本。

使用Codex进行编程

Codex是为编程任务专门开发的一种语言模型，由OpenAI开发。它可以理解代码的自然语言描写，并生成相应的代码片断。

Codex经过大量代码数据集的训练，可以在多种编程语言（包括Python、JavaScript、Ruby和Go等）中生成代码。

设置Python中的OpenAI API

在你的Python项目中使用OpenAI API之前，需要设置OpenAI账户，安装OpenAI Python包并认证你的API密钥。

注册OpenAI账户

要注册OpenAI账户，访问OpenAI网站并点击“注册”按钮。你将被要求输入你的电子邮件地址并创建一个密码。

输入完信息后，点击“创建账户”按钮。

创建API密钥

创建OpenAI账户后，需要创建一个API密钥。要创建一个API密钥，转到OpenAI网站的“API”选项卡，并点击“创建API密钥”按钮。

然后，你将被要求为API密钥命名并选择其权限。创建API密钥后，将其复制到剪贴板。

安装OpenAI Python包

要安装OpenAI Python包，可使用pip，即Python包管理器。打开命令提示符或终端，并运行以下命令：

pip install openai

这将在你的系统中安装OpenAI Python包及其所有依赖项。

认证API密钥

要认证你的OpenAI API密钥，你需要将其设置为OpenAI Python包的默许API密钥。

你可以在Python脚本中运行以下命令来实现：

import openai openai.api_key = “YOUR_API_KEY”

将“YOUR_API_KEY”替换为你在第2步中复制到剪贴板的API密钥。

设置你的OpenAI API密钥

为了保护你的API密钥的安全，应避免将其硬编码到代码中。斟酌以下两种方法：

将OpenAI API密钥存储为环境变量，或

使用openai_secret_manager库来安全管理API密钥

使用环境变量

要使用环境变量设置API密钥，请依照以下步骤操作：

打开终端或命令提示符窗口。输入以下命令：

export OPENAI_API_KEY=

用你的实际API密钥替换，然后履行该命令。

现在，你的API密钥已作为环境变量存储在系统中。

简单吧？现在，让我们验证一下我们的API密钥会不会已正确设置。

要在代码中访问API密钥，可使用以下代码：

import os api_key = os.environ[“OPENAI_API_KEY”]

这段代码将获得OPENAI_API_KEY环境变量的值，并将其存储在一个名为api_key的变量中。现在，你可使用api_key变量来对OpenAI API要求进行身份验证。

使用OpenAI Secret Manager

openai_secret_manager库提供了一种安全的方式来管理你的API密钥。

使用此库时，请依照以下步骤操作：

通过在终端或命令提示符中运行以下命令来安装openai_secret_manager库：

pip install openai_secret_manager

在代码中导入openai_secret_manager库：

from openai_secret_manager import get_secret

使用openai_secret_manager库提供的get_secret()函数来检索你的API密钥。

你可以通过向项目添加以下代码来完成此操作：

import openai_secret_manager assert “openai” in openai_secret_manager.get_services() secrets = openai_secret_manager.get_secret(“openai”) openai.api_key = secrets[“api_key”]

完成这些步骤后，你就能够在Python项目中开始使用OpenAI API了。

现在，让我们学习如何向API发送要求并处理接收到的响应。

使用Python向OpenAI API发送要求

要使用Python向OpenAI API发送要求，你需要创建一个要求对象并设置相应的参数。

openai包提供了一个方便的Completion.create()方法用于创建要求对象。

示例：

import openai openai.api_key = “YOUR_API_KEY” prompt = “Hello, my name is” response = openai.Completion.create( engine=”davinci”, prompt=prompt, max_tokens=5, n=1, stop=None, temperature=0.5, )

OpenAI Completion Create参数

engine参数指定用于完成的语言模型。

prompt参数指定要完成的提示。

max_tokens参数指定完成的最大标记数。

n参数指定要生成的完成数。

stop参数指定完成的停止序列。

temperature参数控制生成的完成的多样性。

在Python中处理OpenAI API响应

当你向OpenAI API发送要求时，将收到一个响应对象。

响应对象包括生成的完成和其他元数据。

下面是如何访问生成的完成：

completion_text = response.choices[0].text

在此示例中，我们通过获得响应对象的choices列表中第一个元素的text属性来访问生成的完成。

如果指定了多个完成，你可以通过迭代choices列表来访问其他完成。

响应对象还包括其他元数据，如生成完成所花费的时间、要求的ID和所使用的语言模型的ID。你可使用响应对象的适当属性访问这些元数据。

在Python代码中使用ChatGPT API

现在，你了解了怎么发送和处理OpenAI API响应，可以在你的Python代码中开始使用ChatGPT API。

使用API的基本工作流程以下：

创建一个OpenAI API客户端对象

调用openai.Completion.create()方法生成自然语言响应

处理响应

以下是演示该工作流程的示例代码片断：

import openai openai.api_key = “your-api-key” #if you use the method we defined earlier def generate_response(prompt): response = openai.Completion.create( engine=”text-davinci-002″, prompt=prompt, max_tokens=60, n=1, stop=None, temperature=0.5, ) return response.choices[0].text.strip() prompt = “What is the capital of India?” response = generate_response(prompt) print(response)

使用Codex将自然语言转换为代码

可使用两种方法使用Codex来使用OpenAI Python库生成自然语言的代码：

将engine设置为davinci-codex的OpenAI Completion函数

使用OpenAI Code函数

让我们了解一下这两种方法。

使用davinci-codex设置为engine的OpenAI Completion函数的示例：

import openai import json #认证API密钥 openai.api_key = “YOUR_API_KEY” #设置engine为davinci-codex engine = “davinci-codex” #定义自然语言提示 prompt = ( “Write a Python function to calculate the factorial of a number.” ) #设置完成的参数 parameters = { “prompt”: prompt, “max_tokens”: 100, “n”: 1, “stop”: ”

“, “temperature”: 0.5, “frequency_penalty”: 0, “presence_penalty”: 0, } #生成代码完成响应 response = openai.Completion.create(engine=engine, **parameters) #从响应中提取代码 code = response.choices[0].text.strip() #打印生成的代码 print(code)

使用OpenAI Python库中的Code方法：

import openai openai.api_key = “your_api_key” response = openai.Code.create( prompt=’Write a Python function to calculate the factorial of a number.’, language=’python’ ) print(response[“code”])

Codex可用于生成各种编程语言的代码，包括Python、JavaScript、Ruby等。

它还可以用于生成特定任务的代码片断或完成部份代码示例。

使用DALL-E生成图象

以下是使用DALL-E OpenAI Python库生成图象的示例：

response = openai.Image.create( prompt=”A blue bird sitting on a branch”, size=”256×256″ ) image_url = response[“data”][0][“url”]

然后，你可使用Pillow Python库下载和显示生成的图象：

from PIL import Image import requests from io import BytesIO response = requests.get(image_url) img = Image.open(BytesIO(response.content)) img.show()

总结

恭喜你，你已学会了怎样在Python中使用OpenAI API！在本文中，我们讨论了OpenAI API是甚么，怎样设置账户，怎么安装OpenAI Python包，如何验证API密钥和怎样在项目中使用API。我们还提供了一个使用API在代码中完成一个句子的示例。

请记住，OpenAI API是一个强大的工具，可以帮助你提高代码的自然语言处理能力。通过正确的技能和创造力，你可使用OpenAI API构建出可以理解和分析自然语言数据的使人惊叹的项目。

那末，你还在等甚么？开始在你的项目中使用OpenAI API，并看看它怎么改变你编写代码的方式！

参考文献：

export openai key的常见问答Q&A