prompt-poet：简化AI提示设计的利器-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00394/article/details/146536993

prompt-poet：简化AI提示设计的利器

prompt-poet Streamlines and simplifies prompt design for both developers and non-technical users with a low code approach. 项目地址: https://gitcode.com/gh_mirrors/pr/prompt-poet

在当今人工智能迅速发展的时代，构建高效、精准的AI交互体验变得愈发重要。prompt-poet 是一个开源项目，它通过低代码的方法，极大地简化和优化了AI提示（prompt）的设计过程。下面，让我们一起探索这个项目的魅力所在。

项目介绍

prompt-poet 是一个旨在帮助开发者和非技术用户设计提示的Python库。它使用YAML和Jinja2模板语言，提供灵活、动态的提示创建方法，从而提升与AI模型交互的效率和品质。prompt-poet 通过减少字符串操作的时间，让用户可以更加专注于为他们的用户打造最佳的提示。

项目技术分析

prompt-poet 的核心是一个强大的模板系统，它结合了YAML和Jinja2的优势。YAML为模板提供结构，而Jinja2则负责数据的绑定和逻辑控制。这种组合使得prompt-poet既易于使用，又具有高度的扩展性。

在技术实现上，prompt-poet 支持以下特性：

模板渲染与加载：Jinja2首先处理模板，执行控制流逻辑，然后YAML格式化输出，形成一个结构化的Python数据结构。
动态列表解析：支持在模板中解析列表，实现复杂的提示逻辑。
上下文截断：提供截断机制，以适应长对话上下文。
模态适应性：根据用户的交流方式（文本或音频）调整提示内容。
特定查询处理：根据用户查询的内容，动态添加相关示例或上下文。

项目技术应用场景

prompt-poet 的应用场景非常广泛，以下是一些典型的使用案例：

问答机器人：为问答机器人设计提示，提供一致的交互体验。
教育辅助：为学生提供作业帮助，动态生成相关的教学示例。
对话系统：优化对话系统的提示设计，提高自然语言理解的准确性。
内容生成：自动生成文章、报告等内容的草稿。

项目特点

prompt-poet 的以下特点使其在AI提示设计领域独树一帜：

低代码：无需深入的编程知识，即可快速设计复杂提示。
灵活性与动态性：通过YAML和Jinja2的组合，支持高度自定义的提示设计。
效率提升：减少字符串操作，提高开发效率。
易于集成：可以轻松集成到现有的AI项目中。

下面，我们将深入探讨prompt-poet 的安装和使用方法，以及如何在不同的应用场景中充分利用它的功能。

安装与基本使用

安装prompt-poet 非常简单，只需要一行命令：

pip install prompt-poet

接下来，让我们看看如何使用prompt-poet 设计一个基本的提示：

import os
import getpass

from prompt_poet import Prompt
from langchain import ChatOpenAI

# 设置OpenAI API密钥（如有需要）。
os.environ["OPENAI_API_KEY"] = getpass.getpass()

# 定义模板。
raw_template = """
- name: system instructions
  role: system
  content: |
    Your name is {{ character_name }} and you are meant to be helpful and never harmful to humans.

- name: user query
  role: user
  content: |
   {{ username}}: {{ user_query }}

- name: response
  role: user
  content: |
    {{ character_name }}:
"""

# 模板数据。
template_data = {
  "character_name": "Character Assistant",
  "username": "Jeff",
  "user_query": "Can you help me with my homework?"
}

# 创建提示。
prompt = Prompt(
    raw_template=raw_template,
    template_data=template_data
)

# 创建并调用模型。
model = ChatOpenAI(model="gpt-4o-mini")
response = model.invoke(prompt.messages)

在这个例子中，我们定义了一个包含系统指令、用户查询和响应的模板，然后使用prompt-poet 的Prompt类来生成提示，并通过ChatOpenAI模型获取响应。

动态模板与高级特性

prompt-poet 的强大之处在于其模板的动态性和灵活性。以下是一些高级特性的示例：

列表解析

{% for message in current_chat_messages %}
- name: chat_message
  role: user
  content: |
    {{ message.author }}: {{ message.content }}
{% endfor %}

这个例子展示了如何迭代一个消息列表，并为每个消息创建一个提示部分。

截断旧消息

{% for message in current_chat_messages %}
- name: chat_message
  role: user
  truncation_priority: 1
  content: |
    {{ message.author }}: {{ message.content }}
{% endfor %}

当上下文长度超出限制时，这个特性允许我们根据指定的截断优先级来截断消息。

模态适应性

{% if modality == "audio" %}
- name: special audio instruction
  role: system
  content: |
    {{ username }} is currently using audio. Keep your answers succinct.
{% endif %}

根据用户的交流方式，动态调整提示内容。

特定查询处理

{% if extract_user_query_topic(user_query) == "homework_help" %}
{% for homework_example in fetch_few_shot_homework_examples(username, character_name) %}
- name: homework_example_{{ loop.index }}
  role: user
  content: |
    {{ homework_example }}
{% endfor %}
{% endif %}

这个特性允许我们根据用户查询的主题动态添加相关的上下文或示例。