【大模型从入门到精通1】openAI api的入门介绍1

1.1 引言

本章深入探讨了如何将OpenAI的API实际集成到应用程序中，特别关注使用GPT模型生成基于文本的响应。本指南专为机器学习工程师、数据科学家、软件开发者及相关专业人士设计，旨在通过先进的AI功能增强应用。

OpenAI API简介

OpenAI通过其API提供了多种语言模型的访问，包括生成式预训练变换器（GPT）模型。这些模型能够理解和生成类似人类的文字，使它们成为从自动客户服务到内容生成等多种应用的强大工具。

OpenAI版本要求

pip install openai==0.28

获取API密钥

为了使用OpenAI API，需要一个API密钥。此密钥既是唯一标识符也是访问令牌。您可以通过在OpenAI平台上创建账户并订阅一个合适的计划来获取API密钥。至关重要的是保持此密钥的安全，不要将其暴露在代码库或版本控制系统中。

import openai# 设置您的OpenAI API密钥
openai.api_key = 'your_api_key_here'response = openai.Completion.create(engine="gpt-3.5-turbo",prompt="什么是人工智能？",max_tokens=100
)print(response.choices[0].text)

这个示例展示了如何使用OpenAI API生成文本的基本方法。请将 'your_api_key_here' 替换为您的实际API密钥。该代码向API发送一个提示并打印生成的响应。

为了访问OpenAI的API，您必须拥有一个API密钥，它用于验证您的请求。以下是获取和保护您的API密钥的步骤：

1. 创建OpenAI账户：访问OpenAI的网站并注册账户。
2. 选择计划：选择符合您需求的订阅计划。OpenAI提供包括开发和测试的免费层级以及更广泛使用的付费层级在内的多种计划。
3. 获取您的API密钥：订阅后，您可以在账户仪表板的API部分找到您的API密钥。此密钥对于您的账户是唯一的，应保持机密。

API交互的安全实践

安全地管理您的API密钥涉及将它们存储在环境变量中。这种做法可以将敏感信息排除在源代码之外，降低意外暴露的风险。在本地开发中使用.env文件，在生产环境中使用安全保险库或密钥管理服务。

构建API请求

与OpenAI API通信需要构建包含模型、输入提示以及其他参数（如温度，影响响应创造性的参数）的请求。

• 模型选择：根据您的应用需求选择合适的GPT模型。
• 输入提示：您希望模型回应的问题或陈述。
• 参数调整：调整诸如温度等参数以控制输出的随机性。

在Python中发送请求

使用openai Python包向API发送请求。确保通过pip安装该包，并设置好您的API密钥。

解释API响应

当OpenAI API返回响应时，它会包含生成的文本以及可用于了解响应生成过程的元数据。以下是需要考虑的关键方面：

• 响应结构：理解响应的JSON结构，通常包括choices字段，其中生成的文本存储在text键下。响应还可能包含指示请求消耗的令牌数量的使用信息。

{"id": "cmpl-XYZ123", // 请求的唯一标识符。"object": "text_completion", // 对象类型，表明这是一个文本完成。"created": 1613679373, // 请求创建的时间戳。"model": "gpt-3.5-turbo", // 用于生成文本完成的模型。"choices": [{"text": "这是对您的提示生成的文本响应。","index": 0,"logprobs": null,"finish_reason": "length"}],"usage": {"prompt_tokens": 5,"completion_tokens": 10,"total_tokens": 15}
}

处理错误

实现健壮的错误处理来捕捉并响应请求过程中可能出现的任何问题。这包括HTTP错误、API速率限制和无效参数。在代码中使用try-catch块来优雅地管理这些场景。

import openai
import os# 从环境变量加载OpenAI API密钥
openai.api_key = os.getenv("OPENAI_API_KEY")try:# 尝试向OpenAI API发送请求以生成文本response = openai.Completion.create(engine="gpt-3.5-turbo",prompt="这是一个示例提示",max_tokens=50)# 打印响应中第一个选择生成的文本print(response.choices[0].text)except openai.error.InvalidRequestError as e:# 捕获并处理无效请求的情况print(f"无效请求: {e}")except openai.error.RateLimitError as e:# 捕获并处理超出API速率限制的情况print(f"速率限制已超过: {e}")except openai.error.OpenAIError as e:# 捕获并处理其他特定于OpenAI的错误print(f"OpenAI错误: {e}")except Exception as e:# 捕获并处理与OpenAI API无关的任何其他异常print(f"发生其他错误: {e}")

加工元数据

利用响应中提供的元数据来深入了解模型性能和请求成本。这有助于优化未来的请求和管理您的API使用情况。