本篇文章主要对Spring AI 提示词的实现源码进行剖析，并提供使用案例。对于如何写好提示词，提示的技术框架等，后续会出专题进行详尽的讨论。

提示词重要性

众所周知，ChatGPT 使用得好不好，和你的提问有很大的关系，这个提问又叫提示词、指令或者是prompt。

研究人员可利用提示工程来提高大语言模型处理复杂任务场景的能力，如问答和算术推理能力。开发人员可通过提示工程设计和研发出强大的技术，实现和大语言模型或其他生态工具的高效接轨。

但是虽然提示词很重要，但是在某些场景下，我们不得不承认，提示词是无法解决问题，后面会有文章说明。 比如一个场景：大模型对外部数据依赖比较严重时，问答系统，知识库系统等，那么需要什么技术解决呢？

提示词模板类结构

PromptTemplateStringActions 顶层接口

package org.springframework.ai.chat.prompt;

import java.util.Map;

public interface PromptTemplateStringActions {

    // 根据模版以及填充词 生成提示词
    String render();
    // 根据模版生成提示词，并提供填充占位符的model，如果已经存在则会覆盖之前设置的
    String render(Map<String, Object> model);

}

PromptTemplateActions 接口

PromptTemplateActions 是 PromptTemplateStringActions 的子类，提供了两个生成提示词的接口，与父接口唯一不同的是返回值的对象不同。

package org.springframework.ai.chat.prompt;

import java.util.Map;

public interface PromptTemplateActions extends PromptTemplateStringActions {
    // 根据提示词模板和填充词 生成Prompt对象
    Prompt create();

    // 根据提示词模板和填充词，并提供额外的model map 生成Prompt对象
    Prompt create(Map<String, Object> model);
}

对于PromptTemplateStringActions和PromptTemplateActions 两个接口的设计看着有些冗余，目前还不知道作者这么设计的意图是什么？咱们继续看其实现类，里面的实现是否相同以及使用的场景是啥？

经过思考一番后，作者设计意图是遵循设计六大原则的 单一职责和接口隔离原则，其次是在使用上更为方便。

PromptTemplate 实现类

这里只有关键核心代码

public class PromptTemplate implements PromptTemplateActions, PromptTemplateMessageActions {

    private ST st;

    protected String template;
    
    // 可以根据Resource和String两种类型方式创建一个PromptTemplate对象
    public PromptTemplate(Resource resource) {
       try (InputStream inputStream = resource.getInputStream()) {
          this.template = StreamUtils.copyToString(inputStream, Charset.defaultCharset());
       }
       catch (IOException ex) {
          throw new RuntimeException("Failed to read resource", ex);
       }
       try {
          this.st = new ST(this.template, '{', '}');
       }
       catch (Exception ex) {
          throw new IllegalArgumentException("The template string is not valid.", ex);
       }
    }

    public PromptTemplate(String template) {
       this.template = template;
       // If the template string is not valid, an exception will be thrown
       try {
          this.st = new ST(this.template, '{', '}');
       }
       catch (Exception ex) {
          throw new IllegalArgumentException("The template string is not valid.", ex);
       }
    }

    public PromptTemplate(String template, Map<String, Object> model) {
       this.template = template;
       // If the template string is not valid, an exception will be thrown
       try {
          this.st = new ST(this.template, '{', '}');
          for (Entry<String, Object> entry : model.entrySet()) {
             add(entry.getKey(), entry.getValue());
          }
       }
       catch (Exception ex) {
          throw new IllegalArgumentException("The template string is not valid.", ex);
       }
    }

    public PromptTemplate(Resource resource, Map<String, Object> model) {
       try (InputStream inputStream = resource.getInputStream()) {
          this.template = StreamUtils.copyToString(inputStream, Charset.defaultCharset());
       }
       catch (IOException ex) {
          throw new RuntimeException("Failed to read resource", ex);
       }
       // If the template string is not valid, an exception will be thrown
       try {
          this.st = new ST(this.template, '{', '}');
          for (Entry<String, Object> entry : model.entrySet()) {
             this.add(entry.getKey(), entry.getValue());
          }
       }
       catch (Exception ex) {
          throw new IllegalArgumentException("The template string is not valid.", ex);
       }
    }

    public void add(String name, Object value) {
       this.st.add(name, value);
       this.dynamicModel.put(name, value);
    }

    // ------------  以下实现接口方法 -----------
    // Render Methods
    @Override
    public String render() {
       // validate方法就校验传入的map方法，与提示词模版中的占位符是否一致，如果不一致则抛出异常
       // 由于篇幅将校验方法删除了，详细内容可以看源码。
       validate(this.dynamicModel);
       // 生成提示词
       return st.render();
    }

    @Override
    public String render(Map<String, Object> model) {
       validate(model);
       for (Entry<String, Object> entry : model.entrySet()) {
          // 如果model中的key已经存在，则从st的map中移除
          if (this.st.getAttribute(entry.getKey()) != null) {
             this.st.remove(entry.getKey());
          }
          if (entry.getValue() instanceof Resource) {
             this.st.add(entry.getKey(), renderResource((Resource) entry.getValue()));
          }
          else {
             this.st.add(entry.getKey(), entry.getValue());
          }

       }
       return this.st.render();
    }

    private String renderResource(Resource resource) {
       try {
          return resource.getContentAsString(Charset.defaultCharset());
       }
       catch (IOException e) {
          throw new RuntimeException(e);
       }
    }
    
    
    // 根据生成的提示词，返回一个用户消息
    @Override
    public Message createMessage() {
       return new UserMessage(render());
    }

     // 根据生成的提示词，返回一个用户消息
    @Override
    public Message createMessage(List<Media> mediaList) {
       return new UserMessage(render(), mediaList);
    }

    // 根据生成的提示词，返回一个用户消息
    @Override
    public Message createMessage(Map<String, Object> model) {
       return new UserMessage(render(model));
    }
    // 根据提示词，返回一个提示词对象
    @Override
    public Prompt create() {
       return new Prompt(render(new HashMap<>()));
    }
    // 根据提示词，返回一个提示词对象
    @Override
    public Prompt create(Map<String, Object> model) {
       return new Prompt(render(model));
    }

}

实现类的实现是比较简单的，其魔法在于使用了 org.stringtemplate.v4.ST 模版解析，如果大家想深入了解其实现原理可以查看官网文档或者Github

Github：github.com/antlr/strin…

另外像Java还有类似的Freemark、Velocity等模版引擎，那么ST具有什么优势和其适应场景呢？在这里只是引出一个话题，大家可以根据自身情况进行学习。

PrompteTemplate三个子类

源码实现很简单，这里就不再贴代码了，简单介绍一下其作用；

• AssistantPromptTemplate：创建大模型回复提示词对象
• FunctionPromptTemplate：创建函数调用提示词对象
• SystemPromptTemplate：创建系统提示词对象

像 ChatPromptTemplate 实现与上面介绍的基本上相似，不再做分析。

提示词模板使用示例

第一个案例

当我们输入导演名称，查询导演的最受欢迎的电影是什么？哪年发行的，电影讲述的什么内容？

提示词模版 film.st

请问{director}导演最受欢迎的电影是什么？哪年发行的，电影讲述的什么内容？

代码实现

package com.ivy.controller;

import jakarta.annotation.Resource;
import org.springframework.ai.chat.client.ChatClient;
import org.springframework.ai.chat.prompt.Prompt;
import org.springframework.ai.chat.prompt.PromptTemplate;
import org.springframework.ai.openai.OpenAiChatModel;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Map;

@RestController
public class PromptTemplateController {

    @Resource
    private OpenAiChatModel openAiChatModel;


    @Value("classpath:film.st")
    private org.springframework.core.io.Resource template;

    @GetMapping("/prompt")
    public String prompt(String director) {

        Map<String, Object> map = Map.of("director", director);
        PromptTemplate promptTemplate = new PromptTemplate(template, map);
        Prompt prompt = promptTemplate.create();

        ChatClient chatClient = ChatClient.builder(openAiChatModel)
                .build();
        return chatClient.prompt(prompt).call().content();
    }
}

使用Postman验证

第二个小案例

当我们输入编程语言、描述、方法名称，生成一个方法

提示词模版设计 code.st

/**
  * @language {language}
  * @method {methodName}
  * @describe {description}
  */

代码实现

package com.ivy.controller;

import jakarta.annotation.Resource;
import org.springframework.ai.chat.client.ChatClient;
import org.springframework.ai.chat.prompt.Prompt;
import org.springframework.ai.chat.prompt.PromptTemplate;
import org.springframework.ai.openai.OpenAiChatModel;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Map;

@RestController
public class PromptTemplateController {

    @Resource
    private OpenAiChatModel openAiChatModel;
    
    @Value("classpath:code.st")
    private org.springframework.core.io.Resource codeTemplate;

    @GetMapping("/code")
    public String code(String language, String methodName, String description) {
        PromptTemplate promptTemplate = new PromptTemplate(codeTemplate);
        Prompt prompt = promptTemplate.create(
                Map.of("language", language, "methodName", methodName, "description", description)
        );
        ChatClient chatClient = ChatClient.builder(openAiChatModel)
                .build();
        return chatClient.prompt(prompt).call().content();
    }
}

Postman验证

当输入language=java&methodName=quickSort&description=写一个快速排序算法 时

当输入language=python&methodName=quickSort&description=写一个快速排序算法 时

代码示例

github.com/fangjieDevp…

总结

本篇文章主要对Spring AI 框架的提示词模板设计进行源码分析，目前看设计上还是比较简单，底层使用了org.stringtemplate.v4.ST框架实现。然后提供了两个小示例来演示使用。比如第一个小示例，相当于提问三个方面的问题，大家有没有什么想法，将这三个方面的内容组成一个Film对象格式化返回呢？Spring AI框架已经提供了这方面的支持，请看后续文章。

对于提示词工程相关的技术也会出一些系列文章，对提示词技术进行讲解与实践，敬请期待！！

如果文章对你有帮助，点个赞吧！如果有问题请评论！