openAI Python库版本：1.52.1
文章目录
第二章 提示原则
二、原则二 给模型时间去思考
在设计 Prompt 时，给予语言模型充足的推理时间非常重要。语言模型与人类一样，需要时间来思考并解决复杂问题。如果让语言模型匆忙给出结论，其结果很可能不准确。例如，若要语言模型推断一本书的主题，仅提供简单的书名和一句简介是不足够的。这就像让一个人在极短时间内解决困难的数学题，错误在所难免。
相反，我们应通过 Prompt 指引语言模型进行深入思考。可以要求其先列出对问题的各种看法，说明推理依据，然后再得出最终结论。在 Prompt 中添加逐步推理的要求，能让语言模型投入更多时间逻辑思维，输出结果也将更可靠准确。
综上所述，给予语言模型充足的推理时间，是 Prompt Engineering 中一个非常重要的设计原则。这将大大提高语言模型处理复杂问题的效果，也是构建高质量 Prompt 的关键之处。开发者应注意给模型留出思考空间，以发挥语言模型的最大潜力。
2.1 指定完成任务所需的步骤
复杂任务需求
接下来我们将通过给定一个复杂任务，给出完成该任务的一系列步骤，来展示这一策略的效果。
首先我们描述了杰克和吉尔的故事，并给出提示词执行以下操作：
首先，用一句话概括三个反引号限定的文本。
第二，将摘要翻译成英语。
第三，在英语摘要中列出每个名称。
第四，输出包含以下键的 JSON 对象：英语摘要和人名个数。要求输出以换行符分隔。
代码示例（原）
text = f"""
在一个迷人的村庄里，兄妹杰克和吉尔出发去一个山顶井里打水。\
他们一边唱着欢乐的歌，一边往上爬，\
然而不幸降临——杰克绊了一块石头，从山上滚了下来，吉尔紧随其后。\
虽然略有些摔伤，但他们还是回到了温馨的家中。\
尽管出了这样的意外，他们的冒险精神依然没有减弱，继续充满愉悦地探索。
"""
# example 1
prompt_1 = f"""
执行以下操作：
1-用一句话概括下面用三个反引号括起来的文本。
2-将摘要翻译成英语。
3-在英语摘要中列出每个人名。
4-输出一个 JSON 对象，其中包含以下键：english_summary，num_names。
请用换行符分隔您的答案。
Text:
```{text}```
"""
response = get_completion(prompt_1)
print("prompt 1:")
print(response)
prompt 1 结果:
1-两个兄妹在山上打水时发生意外，但最终平安回家。
2-In a charming village, siblings Jack and Jill set off to fetch water from a well on top of a hill. While singing joyfully, they climbed up, but unfortunately, Jack tripped on a stone and rolled down the hill, with Jill following closely behind. Despite some minor injuries, they made it back to their cozy home. Despite the mishap, their adventurous spirit remained undiminished as they continued to explore with delight.
3-Jack, Jill
4-{"english_summary": "In a charming village, siblings Jack and Jill set off to fetch water from a well on top of a hill. While singing joyfully, they climbed up, but unfortunately, Jack tripped on a stone and rolled down the hill, with Jill following closely behind. Despite some minor injuries, they made it back to their cozy home. Despite the mishap, their adventurous spirit remained undiminished as they continued to explore with delight.", "num_names": 2}
代码示例（基于原代码修改）
# -*- coding: utf-8 -*-
# test2.py
import os
from dotenv import load_dotenv, find_dotenv
import openai
import json
def get_openai_key():
"""
自动查找 .env 文件并加载 OpenAI API 密钥。
"""
load_dotenv(find_dotenv())
return os.getenv('OPENAI_API_KEY')
def get_custom_openai_client():
return openai.OpenAI(
# 如果使用自定义 API 端点（如 https://xiaoai.plus/v1），取消下面一行的注释并设置你的 API 基础 URL
base_url='https://xiaoai.plus/v1',
api_key=get_openai_key()
)
def get_completion(prompt):
"""
调用 OpenAI API 获取完成内容。
参数:
prompt (str): 要发送给模型的提示内容。
返回:
str: 模型生成的回复内容。
"""
try:
client = get_custom_openai_client()
response = client.chat.completions.create(
model="gpt-4o-mini", # 根据需要选择合适的模型
messages=[
{"role": "user", "content": prompt}
]
)
return response.choices[0].message.content.strip()
except Exception as e:
print("获取完成内容失败，错误信息：", e)
return None
if __name__ == "__main__":
# 定义要处理的文本
text = f"""
在一个迷人的村庄里，兄妹杰克和吉尔出发去一个山顶井里打水。\
他们一边唱着欢乐的歌，一边往上爬，\
然而不幸降临——杰克绊了一块石头，从山上滚了下来，吉尔紧随其后。\
虽然略有些摔伤，但他们还是回到了温馨的家中。\
尽管出了这样的意外，他们的冒险精神依然没有减弱，继续充满愉悦地探索。
"""
# 构建新的提示
prompt_1 = f"""
执行以下操作：
1-用一句话概括下面用三个反引号括起来的文本。
2-将摘要翻译成英语。
3-在英语摘要中列出每个人名。
4-输出一个 JSON 对象，其中包含以下键：english_summary，num_names。
请用换行符分隔您的答案。
Text:
```{text}```
"""
# 使用 get_completion 函数生成结果
response = get_completion(prompt_1)
print("prompt 1:")
print(response)
if response:
try:
# 尝试将响应解析为 JSON 格式
result = json.loads(response)
print("\n解析后的 JSON 对象：")
print(json.dumps(result, ensure_ascii=False, indent=4))
except json.JSONDecodeError:
# 如果响应不是有效的 JSON，则直接打印原始响应
print("\n响应内容不是有效的 JSON 格式：")
# print(response)
存在问题
上述输出仍然存在一定问题，例如，键“姓名”会被替换为法语（译注：在英文原版中，要求从英语翻译到法语，对应指令第三步的输出为 ‘Noms:’，为Name的法语，这种行为难以预测，并可能为导出带来困难）
改进prompt（进一步告知大模型需要的输出格式）
因此，我们将Prompt加以改进，该 Prompt 前半部分不变，同时确切指定了输出的格式。
代码示例（原）
prompt_2 = f"""
1-用一句话概括下面用<>括起来的文本。
2-将摘要翻译成英语。
3-在英语摘要中列出每个名称。
4-输出一个 JSON 对象，其中包含以下键：English_summary，num_names。
请使用以下格式：
文本：<要总结的文本>
摘要：<摘要>
翻译：<摘要的翻译>
名称：<英语摘要中的名称列表>
输出 JSON：<带有 English_summary 和 num_names 的 JSON>
Text: <{text}>
"""
response = get_completion(prompt_2)
print("\nprompt 2:")
print(response)
prompt 2 结果:
Summary: 在一个迷人的村庄里，兄妹杰克和吉尔在山顶井里打水时发生了意外，但他们的冒险精神依然没有减弱，继续充满愉悦地探索。
Translation: In a charming village, siblings Jack and Jill set off to fetch water from a well on top of a hill. Unfortunately, Jack tripped on a rock and tumbled down the hill, with Jill following closely behind. Despite some minor injuries, they made it back home safely. Despite the mishap, their adventurous spirit remained strong as they continued to explore joyfully.
Names: Jack, Jill
JSON Output: {"English_summary": "In a charming village, siblings Jack and Jill set off to fetch water from a well on top of a hill. Unfortunately, Jack tripped on a rock and tumbled down the hill, with Jill following closely behind. Despite some minor injuries, they made it back home safely. Despite the mishap, their adventurous spirit remained strong as they continued to explore joyfully.", "num_names": 2}
代码示例（基于原代码修改）
# -*- coding: utf-8 -*-
# test2.py
import os
from dotenv import load_dotenv, find_dotenv
import openai
import json
def get_openai_key():
"""
自动查找 .env 文件并加载 OpenAI API 密钥。
"""
load_dotenv(find_dotenv())
return os.getenv('OPENAI_API_KEY')
def get_custom_openai_client():
return openai.OpenAI(
# 如果使用自定义 API 端点（如 https://xiaoai.plus/v1），取消下面一行的注释并设置你的 API 基础 URL
base_url='https://xiaoai.plus/v1',
api_key=get_openai_key()
)
def get_completion(prompt):
"""
调用 OpenAI API 获取完成内容。
参数:
prompt (str): 要发送给模型的提示内容。
返回:
str: 模型生成的回复内容。
"""
try:
client = get_custom_openai_client()
response = client.chat.completions.create(
model="gpt-4o-mini", # 根据需要选择合适的模型
# model="o1-mini", # 根据需要选择合适的模型
messages=[
{"role": "user", "content": prompt}
]
)
return response.choices[0].message.content.strip()
except Exception as e:
print("获取完成内容失败，错误信息：", e)
return None
if __name__ == "__main__":
# 定义要处理的文本
text = f"""
在一个迷人的村庄里，兄妹杰克和吉尔出发去一个山顶井里打水。\
他们一边唱着欢乐的歌，一边往上爬，\
然而不幸降临——杰克绊了一块石头，从山上滚了下来，吉尔紧随其后。\
虽然略有些摔伤，但他们还是回到了温馨的家中。\
尽管出了这样的意外，他们的冒险精神依然没有减弱，继续充满愉悦地探索。
"""
# 构建新的提示
prompt_2 = f"""
1-用一句话概括下面用<>括起来的文本。
2-将摘要翻译成英语。
3-在英语摘要中列出每个名称。
4-输出一个 JSON 对象，其中包含以下键：English_summary，num_names。
请使用以下格式：
文本：<要总结的文本>
摘要：<摘要>
翻译：<摘要的翻译>
名称：<英语摘要中的名称列表>
输出 JSON：<带有 English_summary 和 num_names 的 JSON>
Text: <{text}>
"""
# 使用 get_completion 函数生成结果
response = get_completion(prompt_2)
print("prompt 1:")
print(response)
if response:
try:
# 尝试将响应解析为 JSON 格式
result = json.loads(response)
print("\n解析后的 JSON 对象：")
print(json.dumps(result, ensure_ascii=False, indent=4))
except json.JSONDecodeError:
# 如果响应不是有效的 JSON，则直接打印原始响应
print("\n响应内容不是有效的 JSON 格式：")
# print(response)
2.2 指导模型在下结论之前找出一个自己的解法
在设计 Prompt 时，我们还可以通过明确指导语言模型进行自主思考，来获得更好的效果。
举个例子，假设我们要语言模型判断一个数学问题的解答是否正确。仅仅提供问题和解答是不够的，语言模型可能会匆忙做出错误判断。
相反，我们可以在 Prompt 中先要求语言模型自己尝试解决这个问题，思考出自己的解法，然后再与提供的解答进行对比，判断正确性。这种先让语言模型自主思考的方式，能帮助它更深入理解问题，做出更准确的判断。
代码示例（原）
接下来我们会给出一个问题和一份来自学生的解答，要求模型判断解答是否正确：
prompt = f"""
判断学生的解决方案是否正确。
问题:
我正在建造一个太阳能发电站，需要帮助计算财务。
土地费用为 100美元/平方英尺
我可以以 250美元/平方英尺的价格购买太阳能电池板
我已经谈判好了维护合同，每年需要支付固定的10万美元，并额外支付每平方英尺10美元
作为平方英尺数的函数，首年运营的总费用是多少。
学生的解决方案：
设x为发电站的大小，单位为平方英尺。
费用：
土地费用：100x
太阳能电池板费用：250x
维护费用：100,000美元+100x
总费用：100x+250x+100,000美元+100x=450x+100,000美元
"""
response = get_completion(prompt)
print(response)
学生的解决方案是正确的。他正确地计算了土地费用、太阳能电池板费用和维护费用，并将它们相加得到了总费用。
但是注意，学生的解决方案实际上是错误的。（维护费用项100x应为10x，总费用450x应为360x）
我们可以通过指导模型先自行找出一个解法来解决这个问题。
在接下来这个 Prompt 中，我们要求模型先自行解决这个问题，再根据自己的解法与学生的解法进行对比，从而判断学生的解法是否正确。同时，我们给定了输出的格式要求。通过拆分任务、明确步骤，让模型有更多时间思考，有时可以获得更准确的结果。在这个例子中，学生的答案是错误的，但如果我们没有先让模型自己计算，那么可能会被误导以为学生是正确的。
prompt = f"""
请判断学生的解决方案是否正确，请通过如下步骤解决这个问题：
步骤：
首先，自己解决问题。
然后将您的解决方案与学生的解决方案进行比较，对比计算得到的总费用与学生计算的总费用是否一致，并评估学生的解决方案是否正确。
在自己完成问题之前，请勿决定学生的解决方案是否正确。
使用以下格式：
问题：问题文本
学生的解决方案：学生的解决方案文本
实际解决方案和步骤：实际解决方案和步骤文本
学生计算的总费用：学生计算得到的总费用
实际计算的总费用：实际计算出的总费用
学生计算的费用和实际计算的费用是否相同：是或否
学生的解决方案和实际解决方案是否相同：是或否
学生的成绩：正确或不正确
问题：
我正在建造一个太阳能发电站，需要帮助计算财务。
- 土地费用为每平方英尺100美元
- 我可以以每平方英尺250美元的价格购买太阳能电池板
- 我已经谈判好了维护合同，每年需要支付固定的10万美元，并额外支付每平方英尺10美元;
作为平方英尺数的函数，首年运营的总费用是多少。
学生的解决方案：
设x为发电站的大小，单位为平方英尺。
费用：
1. 土地费用：100x美元
2. 太阳能电池板费用：250x美元
3. 维护费用：100,000+100x=10万美元+10x美元
总费用：100x美元+250x美元+10万美元+100x美元=450x+10万美元
实际解决方案和步骤：
"""
response = get_completion(prompt)
print(response)
运行结果：
实际解决方案和步骤：
1. 土地费用：每平方英尺100美元，所以总费用为100x美元。
2. 太阳能电池板费用：每平方英尺250美元，所以总费用为250x美元。
3. 维护费用：固定费用为10万美元，额外费用为每平方英尺10美元，所以总费用为10万美元+10x美元。
4. 总费用：将上述三项费用相加，得到总费用为100x美元+250x美元+10万美元+10x美元=360x+10万美元。
学生计算的总费用：450x+10万美元
实际计算的总费用：360x+10万美元
学生计算的费用和实际计算的费用是否相同：否
学生的解决方案和实际解决方案是否相同：否
学生的成绩：不正确
代码示例（基于原代码修改）
# -*- coding: utf-8 -*-
# test2.py
import os
from dotenv import load_dotenv, find_dotenv
import openai
import json
def get_openai_key():
"""
自动查找 .env 文件并加载 OpenAI API 密钥。
"""
load_dotenv(find_dotenv())
return os.getenv('OPENAI_API_KEY')
def get_custom_openai_client():
return openai.OpenAI(
# 如果使用自定义 API 端点（如 https://xiaoai.plus/v1），取消下面一行的注释并设置你的 API 基础 URL
base_url='https://xiaoai.plus/v1',
api_key=get_openai_key()
)
def get_completion(prompt):
"""
调用 OpenAI API 获取完成内容。
参数:
prompt (str): 要发送给模型的提示内容。
返回:
str: 模型生成的回复内容。
"""
try:
client = get_custom_openai_client()
response = client.chat.completions.create(
model="gpt-4o-mini", # 根据需要选择合适的模型
# model="o1-mini", # 根据需要选择合适的模型
messages=[
{"role": "user", "content": prompt}
]
)
return response.choices[0].message.content.strip()
except Exception as e:
print("获取完成内容失败，错误信息：", e)
return None
if __name__ == "__main__":
# 构建新的提示
prompt = f"""
请判断学生的解决方案是否正确，请通过如下步骤解决这个问题：
步骤：
首先，自己解决问题。
然后将您的解决方案与学生的解决方案进行比较，对比计算得到的总费用与学生计算的总费用是否一致，并评估学生的解决方案是否正确。
在自己完成问题之前，请勿决定学生的解决方案是否正确。
使用以下格式：
问题：问题文本
学生的解决方案：学生的解决方案文本
实际解决方案和步骤：实际解决方案和步骤文本
学生计算的总费用：学生计算得到的总费用
实际计算的总费用：实际计算出的总费用
学生计算的费用和实际计算的费用是否相同：是或否
学生的解决方案和实际解决方案是否相同：是或否
学生的成绩：正确或不正确
问题：
我正在建造一个太阳能发电站，需要帮助计算财务。
- 土地费用为每平方英尺100美元
- 我可以以每平方英尺250美元的价格购买太阳能电池板
- 我已经谈判好了维护合同，每年需要支付固定的10万美元，并额外支付每平方英尺10美元;
作为平方英尺数的函数，首年运营的总费用是多少。
学生的解决方案：
设x为发电站的大小，单位为平方英尺。
费用：
1. 土地费用：100x美元
2. 太阳能电池板费用：250x美元
3. 维护费用：100,000+100x=10万美元+10x美元
总费用：100x美元+250x美元+10万美元+100x美元=450x+10万美元
实际解决方案和步骤：
"""
# 使用 get_completion 函数生成结果
response = get_completion(prompt)
print("prompt 1:")
print(response)
if response:
try:
# 尝试将响应解析为 JSON 格式
result = json.loads(response)
print("\n解析后的 JSON 对象：")
print(json.dumps(result, ensure_ascii=False, indent=4))
except json.JSONDecodeError:
# 如果响应不是有效的 JSON，则直接打印原始响应
print("\n响应内容不是有效的 JSON 格式：")
# print(response)
