Prompt Engineering 学习笔记（学习书目：吴恩达《ChatGPT Prompt Engineering for Developers》）

环境配置

使用 OpenAI 提供的 ChatGPT API，因此需要先准备 ChatGPT 的 API_KEY（也可直接访问 官网 在线测试），并安装 Python 与 openai 相关第三方库。

1. Python 下载

Python 官网下载 即可。

安装时记得勾选 Add python.exe to PATH 让其自动配置环境变量。安装完成后按 Win+R，输入 cmd，在命令行执行 python，若显示版本信息则安装成功。

2. OpenAI 配置

按 Win+R，输入 cmd 打开命令行，安装第三方库：

1
2
pip install openai
pip install -U python-dotenv

可将 api_key 添加到系统环境变量（也可在代码中直接设置）：

1
2
3
4
# OPENAI_API_KEY 是你想设置的环境变量名
# api_key 是该变量的值
# /M 表示添加到系统环境变量
setx OPENAI_API_KEY "api_key" /M

简单测试一下

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# 1. 导入第三方库
import openai
import os
from dotenv import load_dotenv, find_dotenv

# 2. 读取系统中的环境变量
_ = load_dotenv(find_dotenv())

# 3. 设置 API_KEY
# 3.1）可从系统环境变量中读取
openai.api_key = os.getenv('OPENAI_API_KEY')
# 3.2）也可直接提供
# openai.api_key = 'API_KEY'

# 4. 封装 OpenAI 接口
def get_completion(prompt, model="gpt-3.5-turbo"):
		messages = [{"role": "user", "content": prompt}]
		response = openai.ChatCompletion.create(
				model=model,
				messages=messages,
				temperature=0,
		)
		return response.choices[0].message["content"]

# 5. 需要总结的文本
text = f"""
你应该提供尽可能清晰、具体的指示，以表达你希望模型执行的任务。
这将引导模型朝向所需的输出，并降低收到无关或不正确响应的可能性。
不要将写清晰的提示与写简短的提示混淆。
在许多情况下，更长的提示可以为模型提供更多的清晰度和上下文信息，从而导致更详细和相关的输出。
"""

# 6. 指令内容
prompt = f"""
把用三个反引号括起来的文本总结成一句话。
```{text}```
"""

# 7. 输出
response = get_completion(prompt)
print(response)

常见报错

  • openai.error.Timeout: Request timed out: HTTPSConnectionPool(host='api.openai.com', port=443)
    请求超时，一般需要可用网络环境。

  • openai.error.AuthenticationError: No API key provided.
    获取不到 API Key，检查环境变量是否设置正确，必要时重启终端或系统。