提示

提示词是引导 AI 模型生成特定输出的输入。这些提示词的设计和措辞显著影响模型的响应。

在 Spring AI 中与 AI 模型交互的最低层，处理提示词有点类似于在 Spring MVC 中管理“视图”。这涉及创建包含动态内容占位符的扩展文本。然后根据用户请求或应用程序中的其他代码替换这些占位符。另一个类比是包含某些表达式占位符的 SQL 语句。

随着 Spring AI 的发展，它将引入与 AI 模型交互的更高级别的抽象。本节中描述的基础类在角色和功能方面可以比作 JDBC。例如，ChatModel 类类似于 JDK 中的核心 JDBC 库。ChatClient 类可以比作 JdbcClient，它建立在 ChatModel 之上，并通过 Advisor 提供更高级的构造，以考虑与模型的过去交互，用额外的上下文文档增强提示词，并引入代理行为。

提示词的结构在 AI 领域中随时间演变。最初，提示词是简单的字符串。随着时间的推移，它们逐渐包含特定输入的占位符，例如“USER:”，AI 模型可以识别。OpenAI 甚至通过在 AI 模型处理之前将多个消息字符串分类为不同的角色，为提示词引入了更多的结构。

API 概述

提示词

通常使用 ChatModel 的 call() 方法，该方法接受 Prompt 实例并返回 ChatResponse。

Prompt 类充当有序的 Message 对象序列和请求 ChatOptions 的容器。每个 Message 在提示词中都扮演独特的角色，内容和意图各不相同。这些角色可以涵盖各种元素，从用户查询到 AI 生成的响应，再到相关的背景信息。这种安排可以通过多个消息构建提示词，每个消息在对话中扮演特定角色，从而实现与 AI 模型的复杂而详细的交互。

以下是 Prompt 类的截断版本，为简洁起见省略了构造函数和实用方法

public class Prompt implements ModelRequest<List<Message>> {

    private final List<Message> messages;

    private ChatOptions chatOptions;
}

消息

Message 接口封装了 Prompt 文本内容、元数据属性集合以及称为 MessageType 的分类。

该接口定义如下

public interface Content {

	String getContent();

	Map<String, Object> getMetadata();
}

public interface Message extends Content {

	MessageType getMessageType();
}

多模态消息类型还实现了 MediaContent 接口，提供 Media 内容对象列表。

public interface MediaContent extends Content {

	Collection<Media> getMedia();

}

Message 接口的各种实现对应于 AI 模型可以处理的不同类别的消息。模型根据对话角色区分消息类别。

这些角色由 MessageType 有效映射，如下所述。

角色

每条消息都被分配了一个特定的角色。这些角色对消息进行分类，为 AI 模型阐明提示词每个部分的上下文和目的。这种结构化方法增强了与 AI 通信的细微差别和有效性，因为提示词的每个部分在交互中都扮演着独特而明确的角色。

主要角色是

系统角色：指导 AI 的行为和响应风格，为 AI 如何解释和回复输入设置参数或规则。这类似于在开始对话之前向 AI 提供指令。
用户角色：代表用户的输入——他们向 AI 提出的问题、命令或陈述。此角色至关重要，因为它构成了 AI 响应的基础。
助手角色：AI 对用户输入的响应。它不仅仅是一个答案或反应，对于保持对话流程至关重要。通过跟踪 AI 之前的响应（其“助手角色”消息），系统确保了连贯且与上下文相关的交互。助手消息还可能包含函数工具调用请求信息。它就像 AI 中的一个特殊功能，在需要执行计算、获取数据或除对话之外的其他任务等特定功能时使用。
工具/函数角色：工具/函数角色侧重于响应工具调用助手消息返回附加信息。

角色在 Spring AI 中表示为枚举，如下所示

public enum MessageType {

	USER("user"),

	ASSISTANT("assistant"),

	SYSTEM("system"),

	TOOL("tool");

    ...
}

提示词模板

Spring AI 中提示词模板的关键组件是 PromptTemplate 类，旨在促进创建结构化提示词，然后将其发送到 AI 模型进行处理

public class PromptTemplate implements PromptTemplateActions, PromptTemplateMessageActions {

    // Other methods to be discussed later
}

此类使用 TemplateRenderer API 渲染模板。默认情况下，Spring AI 使用 StTemplateRenderer 实现，该实现基于 Terence Parr 开发的开源 StringTemplate 引擎。模板变量由 {} 语法标识，但您也可以配置分隔符以使用其他语法。

public interface TemplateRenderer extends BiFunction<String, Map<String, Object>, String> {

	@Override
	String apply(String template, Map<String, Object> variables);

}

Spring AI 使用 TemplateRenderer 接口处理变量到模板字符串的实际替换。默认实现使用 [StringTemplate]。如果需要自定义逻辑，可以提供自己的 TemplateRenderer 实现。对于不需要模板渲染的场景（例如，模板字符串已完成），可以使用提供的 NoOpTemplateRenderer。

使用带有 '<' 和 '>' 分隔符的自定义 StringTemplate 渲染器示例

PromptTemplate promptTemplate = PromptTemplate.builder()
    .renderer(StTemplateRenderer.builder().startDelimiterToken('<').endDelimiterToken('>').build())
    .template("""
            Tell me the names of 5 movies whose soundtrack was composed by <composer>.
            """)
    .build();

String prompt = promptTemplate.render(Map.of("composer", "John Williams"));

此接口实现支持提示词创建的不同方面

PromptTemplateStringActions 专注于创建和渲染提示词字符串，代表提示词生成最基本的形式。

PromptTemplateMessageActions 专为通过生成和操作 Message 对象来创建提示词而定制。

PromptTemplateActions 旨在返回 Prompt 对象，该对象可以传递给 ChatModel 以生成响应。

尽管这些接口可能在许多项目中不会被广泛使用，但它们展示了提示词创建的不同方法。

实现的接口是

public interface PromptTemplateStringActions {

	String render();

	String render(Map<String, Object> model);

}

方法 String render()：将提示词模板渲染成最终字符串格式，无需外部输入，适用于没有占位符或动态内容的模板。

方法 String render(Map<String, Object> model)：增强渲染功能以包含动态内容。它使用 Map<String, Object>，其中映射键是提示词模板中的占位符名称，值是要插入的动态内容。

public interface PromptTemplateMessageActions {

	Message createMessage();

    Message createMessage(List<Media> mediaList);

	Message createMessage(Map<String, Object> model);

}

方法 Message createMessage()：创建不带额外数据的 Message 对象，用于静态或预定义的消息内容。

方法 Message createMessage(List<Media> mediaList)：创建包含静态文本和媒体内容的 Message 对象。

方法 Message createMessage(Map<String, Object> model)：扩展消息创建以集成动态内容，接受 Map<String, Object>，其中每个条目表示消息模板中的占位符及其对应的动态值。

public interface PromptTemplateActions extends PromptTemplateStringActions {

	Prompt create();

	Prompt create(ChatOptions modelOptions);

	Prompt create(Map<String, Object> model);

	Prompt create(Map<String, Object> model, ChatOptions modelOptions);

}

方法 Prompt create()：生成不带外部数据输入的 Prompt 对象，适用于静态或预定义的提示词。

方法 Prompt create(ChatOptions modelOptions)：生成不带外部数据输入且带有聊天请求特定选项的 Prompt 对象。

方法 Prompt create(Map<String, Object> model)：扩展提示词创建功能以包含动态内容，接受 Map<String, Object>，其中每个映射条目是提示词模板中的占位符及其关联的动态值。

方法 Prompt create(Map<String, Object> model, ChatOptions modelOptions)：扩展提示词创建功能以包含动态内容，接受 Map<String, Object>，其中每个映射条目是提示词模板中的占位符及其关联的动态值，以及聊天请求的特定选项。

示例用法

下面显示了一个来自 AI Workshop on PromptTemplates 的简单示例。

PromptTemplate promptTemplate = new PromptTemplate("Tell me a {adjective} joke about {topic}");

Prompt prompt = promptTemplate.create(Map.of("adjective", adjective, "topic", topic));

return chatModel.call(prompt).getResult();

下面显示了另一个来自 AI Workshop on Roles 的示例。

String userText = """
    Tell me about three famous pirates from the Golden Age of Piracy and why they did.
    Write at least a sentence for each pirate.
    """;

Message userMessage = new UserMessage(userText);

String systemText = """
  You are a helpful AI assistant that helps people find information.
  Your name is {name}
  You should reply to the user's request with your name and also in the style of a {voice}.
  """;

SystemPromptTemplate systemPromptTemplate = new SystemPromptTemplate(systemText);
Message systemMessage = systemPromptTemplate.createMessage(Map.of("name", name, "voice", voice));

Prompt prompt = new Prompt(List.of(userMessage, systemMessage));

List<Generation> response = chatModel.call(prompt).getResults();

这展示了如何通过使用 SystemPromptTemplate 创建一个带有系统角色并传入占位符值的 Message 来构建 Prompt 实例。然后将带有 user 角色的消息与带有 system 角色的消息组合形成提示词。然后将该提示词传递给 ChatModel 以获取生成性响应。

使用自定义模板渲染器

您可以通过实现 TemplateRenderer 接口并将其传递给 PromptTemplate 构造函数来使用自定义模板渲染器。您也可以继续使用默认的 StTemplateRenderer，但使用自定义配置。

默认情况下，模板变量由 {} 语法标识。如果您计划在提示词中包含 JSON，您可能需要使用不同的语法来避免与 JSON 语法冲突。例如，您可以使用 < 和 > 分隔符。

PromptTemplate promptTemplate = PromptTemplate.builder()
    .renderer(StTemplateRenderer.builder().startDelimiterToken('<').endDelimiterToken('>').build())
    .template("""
            Tell me the names of 5 movies whose soundtrack was composed by <composer>.
            """)
    .build();

String prompt = promptTemplate.render(Map.of("composer", "John Williams"));

使用资源而不是原始字符串

Spring AI 支持 org.springframework.core.io.Resource 抽象，因此您可以将提示词数据放在可以直接在 PromptTemplate 中使用的文件中。例如，您可以在 Spring 管理的组件中定义一个字段来检索 Resource。

@Value("classpath:/prompts/system-message.st")
private Resource systemResource;

然后直接将该资源传递给 SystemPromptTemplate。

SystemPromptTemplate systemPromptTemplate = new SystemPromptTemplate(systemResource);

提示词工程

在生成式 AI 中，提示词的创建是开发人员的一项关键任务。这些提示词的质量和结构显著影响 AI 输出的有效性。投入时间和精力设计周到的提示词可以大大提高 AI 的结果。

共享和讨论提示词是 AI 社区中的常见做法。这种协作方法不仅创建了一个共享学习环境，而且还导致识别和使用高效的提示词。

这方面的研究通常涉及分析和比较不同的提示词，以评估它们在各种情况下的有效性。例如，一项重要的研究表明，以“深呼吸，一步一步地解决这个问题”开头提示词显著提高了解决问题的效率。这突显了精心选择的语言对生成式 AI 系统性能的影响。

掌握提示词最有效的用法，尤其是在 AI 技术快速发展的情况下，是一个持续的挑战。您应该认识到提示词工程的重要性，并考虑利用社区和研究的见解来改进提示词创建策略。

创建有效提示词

在开发提示词时，整合几个关键组件以确保清晰度和有效性非常重要

指令：向 AI 提供清晰直接的指令，类似于您与人交流的方式。这种清晰度对于帮助 AI“理解”预期内容至关重要。
外部上下文：在必要时包含相关的背景信息或 AI 响应的特定指导。这种“外部上下文”构成了提示词的框架，并帮助 AI 掌握整体场景。
用户输入：这是直接的部分——用户的直接请求或问题构成了提示词的核心。
输出指示器：这方面可能很棘手。它涉及指定 AI 响应的所需格式，例如 JSON。但是，请注意，AI 可能并不总是严格遵守此格式。例如，它可能会在实际 JSON 数据之前添加一个短语，例如“这是您的 JSON”，或者有时生成一个不准确的类似 JSON 的结构。

在制作提示词时，向 AI 提供预期问答格式的示例非常有益。这种做法有助于 AI“理解”您查询的结构和意图，从而获得更精确和相关的响应。尽管本文档没有深入探讨这些技术，但它们为进一步探索 AI 提示词工程提供了一个起点。

以下是进一步研究的资源列表。

简单技术

文本摘要:
将大量文本缩减为简洁的摘要，捕捉关键点和主要思想，同时省略不太重要的细节。
问答:
根据用户提出的问题，从提供的文本中提取特定答案。它旨在响应查询精确定位和提取相关信息。
文本分类:
系统地将文本分类到预定义的类别或组中，分析文本并根据其内容将其分配到最合适的类别。
对话:
创建交互式对话，AI 可以与用户进行来回交流，模拟自然的对话流程。
代码生成:
根据特定的用户需求或描述生成功能代码片段，将自然语言指令转换为可执行代码。

高级技术

零样本，少样本学习:
使模型能够在极少或没有特定问题类型的先验示例的情况下做出准确的预测或响应，使用学习到的泛化来理解和执行新任务。
思维链:
链接多个 AI 响应以创建连贯且上下文感知的对话。它有助于 AI 保持讨论的线索，确保相关性和连续性。
ReAct（推理 + 行动）:
在此方法中，AI 首先分析（推理）输入，然后确定最合适的行动方案或响应。它结合了理解和决策。

Microsoft 指南

提示词创建和优化框架:
Microsoft 提供了一种开发和优化提示词的结构化方法。此框架指导用户创建有效的提示词，从 AI 模型中获取所需的响应，从而优化交互的清晰度和效率。

Token

Token 在 AI 模型处理文本的方式中至关重要，它充当将单词（我们理解的）转换为 AI 模型可以处理的格式的桥梁。这种转换分两个阶段进行：单词在输入时转换为 token，然后这些 token 在输出时转换回单词。

分词是将文本分解为 token 的过程，是 AI 模型理解和处理语言的基础。AI 模型使用这种分词格式来理解和响应提示词。

为了更好地理解 token，可以将其视为单词的一部分。通常，一个 token 大约代表四分之三的单词。例如，莎士比亚的全部作品，总计大约 900,000 个单词，将转换为大约 120 万个 token。

使用 OpenAI 分词器 UI 进行实验，查看单词如何转换为 token。

除了在 AI 处理中的技术作用之外，token 还具有实际意义，尤其是在计费和模型功能方面

计费：AI 模型服务通常根据 token 使用量计费。输入（提示词）和输出（响应）都计入总 token 数，从而使较短的提示词更具成本效益。
模型限制：不同的 AI 模型具有不同的 token 限制，定义了它们的“上下文窗口”——它们一次可以处理的最大信息量。例如，GPT-3 的限制是 4K token，而 Claude 2 和 Meta Llama 2 等其他模型的限制是 100K token，一些研究模型可以处理多达 100 万个 token。
上下文窗口：模型的 token 限制决定了其上下文窗口。超出此限制的输入不会由模型处理。发送最少有效的处理信息集至关重要。例如，当查询“哈姆雷特”时，无需包含莎士比亚所有其他作品中的 token。
响应元数据：AI 模型响应的元数据包括使用的 token 数量，这是管理使用情况和成本的重要信息。