结构化输出转换器

自 2024 年 5 月 2 日起，旧的 OutputParser、BeanOutputParser、ListOutputParser 和 MapOutputParser 类已被弃用，取而代之的是新的 StructuredOutputConverter、BeanOutputConverter、ListOutputConverter 和 MapOutputConverter 实现。后者可以即时替换前者，并提供相同的功能。此次更改的主要原因是命名，因为这里并没有进行任何解析，同时也是为了与 Spring 的 org.springframework.core.convert.converter 包对齐，从而带来一些改进的功能。

LLM 生成结构化输出的能力对于依赖可靠解析输出值的下游应用至关重要。开发者希望能够快速将 AI 模型的结果转换为可传递给其他应用函数和方法的数据类型，例如 JSON、XML 或 Java 类。

Spring AI 的 Structured Output Converters 有助于将 LLM 输出转换为结构化格式。如下图所示，此方法围绕 LLM 文本补全端点运行

Structured Output Converter Architecture

使用通用补全 API 从大型语言模型 (LLM) 生成结构化输出需要仔细处理输入和输出。结构化输出转换器在 LLM 调用之前和之后都扮演着关键角色，确保实现期望的输出结构。

在 LLM 调用之前，转换器会将格式指令附加到提示词中，为模型生成期望的输出结构提供明确指导。这些指令充当蓝图，塑造模型的响应以符合指定的格式。

在 LLM 调用之后，转换器获取模型的输出文本并将其转换为结构化类型的实例。此转换过程涉及解析原始文本输出并将其映射到相应的结构化数据表示，例如 JSON、XML 或领域特定数据结构。

StructuredOutputConverter 是尽最大努力将模型输出转换为结构化输出。AI 模型不保证返回所请求的结构化输出。模型可能无法理解提示词或无法按照请求生成结构化输出。考虑实现验证机制以确保模型输出符合预期。
StructuredOutputConverter 不用于 LLM 工具调用，因为此功能默认提供结构化输出。

结构化输出 API

StructuredOutputConverter 接口允许您从基于文本的 AI 模型输出中获取结构化输出，例如将输出映射到 Java 类或值数组。接口定义如下：

public interface StructuredOutputConverter<T> extends Converter<String, T>, FormatProvider {

}

它结合了 Spring 的 Converter<String, T> 接口和 FormatProvider 接口

public interface FormatProvider {
	String getFormat();
}

下图显示了使用结构化输出 API 时的数据流。

Structured Output API

FormatProvider 为 AI 模型提供特定的格式化指南，使其能够生成可使用 Converter 转换为指定目标类型 T 的文本输出。以下是此类格式化指令的示例

  Your response should be in JSON format.
  The data structure for the JSON should match this Java class: java.util.HashMap
  Do not include any explanations, only provide a RFC8259 compliant JSON response following this format without deviation.

格式指令通常使用 PromptTemplate 添加到用户输入的末尾，如下所示

    StructuredOutputConverter outputConverter = ...
    String userInputTemplate = """
        ... user text input ....
        {format}
        """; // user input with a "format" placeholder.
    Prompt prompt = new Prompt(
       new PromptTemplate(
			   this.userInputTemplate,
          Map.of(..., "format", outputConverter.getFormat()) // replace the "format" placeholder with the converter's format.
       ).createMessage());

Converter<String, T> 负责将模型输出的文本转换为指定类型 T 的实例。

可用转换器

目前，Spring AI 提供了 AbstractConversionServiceOutputConverter、AbstractMessageOutputConverter、BeanOutputConverter、MapOutputConverter 和 ListOutputConverter 实现

Structured Output Class Hierarchy

  • AbstractConversionServiceOutputConverter<T> - 提供一个预配置的 GenericConversionService，用于将 LLM 输出转换为所需格式。未提供默认的 FormatProvider 实现。

  • AbstractMessageOutputConverter<T> - 提供一个预配置的 MessageConverter，用于将 LLM 输出转换为所需格式。未提供默认的 FormatProvider 实现。

  • BeanOutputConverter<T> - 配置指定 Java 类（例如 Bean）或 ParameterizedTypeReference，此转换器采用 FormatProvider 实现，指导 AI 模型生成符合从指定 Java 类派生的 DRAFT_2020_12 JSON Schema 的 JSON 响应。随后，它使用 ObjectMapper 将 JSON 输出反序列化为目标类的 Java 对象实例。

  • MapOutputConverter - 扩展了 AbstractMessageOutputConverter 的功能，提供了一个 FormatProvider 实现，指导 AI 模型生成符合 RFC8259 标准的 JSON 响应。此外，它还包含一个转换器实现，该实现利用提供的 MessageConverter 将 JSON 有效负载转换为 java.util.Map<String, Object> 实例。

  • ListOutputConverter - 扩展了 AbstractConversionServiceOutputConverter，并包含一个专为逗号分隔列表输出定制的 FormatProvider 实现。转换器实现利用提供的 ConversionService 将模型文本输出转换为 java.util.List。

使用转换器

以下章节提供了关于如何使用可用转换器生成结构化输出的指南。

Bean 输出转换器

以下示例展示了如何使用 BeanOutputConverter 为演员生成电影作品列表。

表示演员电影作品的目标记录

record ActorsFilms(String actor, List<String> movies) {
}

以下是如何使用高级、流畅的 ChatClient API 应用 BeanOutputConverter

ActorsFilms actorsFilms = ChatClient.create(chatModel).prompt()
        .user(u -> u.text("Generate the filmography of 5 movies for {actor}.")
                    .param("actor", "Tom Hanks"))
        .call()
        .entity(ActorsFilms.class);

或直接使用低级 ChatModel API

BeanOutputConverter<ActorsFilms> beanOutputConverter =
    new BeanOutputConverter<>(ActorsFilms.class);

String format = this.beanOutputConverter.getFormat();

String actor = "Tom Hanks";

String template = """
        Generate the filmography of 5 movies for {actor}.
        {format}
        """;

Generation generation = chatModel.call(
    new PromptTemplate(this.template, Map.of("actor", this.actor, "format", this.format)).create()).getResult();

ActorsFilms actorsFilms = this.beanOutputConverter.convert(this.generation.getOutput().getText());

生成 Schema 中的属性排序

BeanOutputConverter 通过 @JsonPropertyOrder 注解支持在生成的 JSON schema 中进行自定义属性排序。无论属性在类或记录中的声明顺序如何，此注解都允许您指定属性应出现在 schema 中的确切顺序。

例如，为了确保 ActorsFilms 记录中属性的特定顺序

@JsonPropertyOrder({"actor", "movies"})
record ActorsFilms(String actor, List<String> movies) {}

此注解适用于记录（records）和常规 Java 类。

泛型 Bean 类型

使用 ParameterizedTypeReference 构造函数指定更复杂的目标类结构。例如，表示演员及其电影作品列表

List<ActorsFilms> actorsFilms = ChatClient.create(chatModel).prompt()
        .user("Generate the filmography of 5 movies for Tom Hanks and Bill Murray.")
        .call()
        .entity(new ParameterizedTypeReference<List<ActorsFilms>>() {});

或直接使用低级 ChatModel API

BeanOutputConverter<List<ActorsFilms>> outputConverter = new BeanOutputConverter<>(
        new ParameterizedTypeReference<List<ActorsFilms>>() { });

String format = this.outputConverter.getFormat();
String template = """
        Generate the filmography of 5 movies for Tom Hanks and Bill Murray.
        {format}
        """;

Prompt prompt = new PromptTemplate(this.template, Map.of("format", this.format)).create();

Generation generation = chatModel.call(this.prompt).getResult();

List<ActorsFilms> actorsFilms = this.outputConverter.convert(this.generation.getOutput().getText());

Map 输出转换器

以下代码片段展示了如何使用 MapOutputConverter 将模型输出转换为 map 中的数字列表。

Map<String, Object> result = ChatClient.create(chatModel).prompt()
        .user(u -> u.text("Provide me a List of {subject}")
                    .param("subject", "an array of numbers from 1 to 9 under they key name 'numbers'"))
        .call()
        .entity(new ParameterizedTypeReference<Map<String, Object>>() {});

或直接使用低级 ChatModel API

MapOutputConverter mapOutputConverter = new MapOutputConverter();

String format = this.mapOutputConverter.getFormat();
String template = """
        Provide me a List of {subject}
        {format}
        """;

Prompt prompt = new PromptTemplate(this.template,
        Map.of("subject", "an array of numbers from 1 to 9 under they key name 'numbers'", "format", this.format)).create();

Generation generation = chatModel.call(this.prompt).getResult();

Map<String, Object> result = this.mapOutputConverter.convert(this.generation.getOutput().getText());

List 输出转换器

以下代码片段展示了如何使用 ListOutputConverter 将模型输出转换为冰淇淋口味列表。

List<String> flavors = ChatClient.create(chatModel).prompt()
                .user(u -> u.text("List five {subject}")
                            .param("subject", "ice cream flavors"))
                .call()
                .entity(new ListOutputConverter(new DefaultConversionService()));

或直接使用低级 ChatModel API

ListOutputConverter listOutputConverter = new ListOutputConverter(new DefaultConversionService());

String format = this.listOutputConverter.getFormat();
String template = """
        List five {subject}
        {format}
        """;

Prompt prompt = new PromptTemplate(this.template,
        Map.of("subject", "ice cream flavors", "format", this.format)).create();

Generation generation = this.chatModel.call(this.prompt).getResult();

List<String> list = this.listOutputConverter.convert(this.generation.getOutput().getText());

支持的 AI 模型

以下 AI 模型已经过测试，支持 List、Map 和 Bean 结构化输出。

模型

集成测试 / 示例

OpenAI

OpenAiChatModelIT

Anthropic Claude 3

AnthropicChatModelIT.java

Azure OpenAI

AzureOpenAiChatModelIT.java

Mistral AI

MistralAiChatModelIT.java

Ollama

OllamaChatModelIT.java

Vertex AI Gemini

VertexAiGeminiChatModelIT.java

内置 JSON 模式

一些 AI 模型提供专门的配置选项来生成结构化（通常是 JSON）输出。

  • OpenAI 结构化输出 可以确保您的模型生成严格符合您提供的 JSON Schema 的响应。您可以选择 JSON_OBJECT（保证模型生成的消息是有效的 JSON）或带有提供的 schema 的 JSON_SCHEMA（保证模型生成的响应与您提供的 schema 匹配）（spring.ai.openai.chat.options.responseFormat 选项）。

  • Azure OpenAI - 提供 spring.ai.azure.openai.chat.options.responseFormat 选项，用于指定模型必须输出的格式。设置为 { "type": "json_object" } 启用 JSON 模式，这保证了模型生成的消息是有效的 JSON。

  • Ollama - 提供 spring.ai.ollama.chat.options.format 选项，用于指定返回响应的格式。目前，唯一接受的值是 json。

  • Mistral AI - 提供 spring.ai.mistralai.chat.options.responseFormat 选项，用于指定返回响应的格式。将其设置为 { "type": "json_object" } 启用 JSON 模式，这保证了模型生成的消息是有效的 JSON。