结构化输出转换器

截至 2024 年 02 月 05 日，旧的 OutputParser、BeanOutputParser、ListOutputParser 和 MapOutputParser 类已弃用，取而代之的是新的 StructuredOutputConverter、BeanOutputConverter、ListOutputConverter 和 MapOutputConverter 实现。后者是前者的直接替换，并提供相同的功能。更改的主要原因是命名，因为没有进行任何解析，但也与 Spring 的 org.springframework.core.convert.converter 包保持一致，从而带来了一些改进的功能。

LLM 能够生成结构化输出对于依赖于可靠解析输出值的后续应用程序非常重要。开发人员希望能够快速将 AI 模型的结果转换为数据类型，例如 JSON、XML 或 Java 类，这些数据类型可以传递到其他应用程序函数和方法。

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

Structured Output Converter Architecture

使用通用补全 API 从大型语言模型 (LLM) 生成结构化输出需要仔细处理输入和输出。结构化输出转换器在 LLM 调用之前和之后发挥着至关重要的作用，确保实现所需的输出结构。

在 LLM 调用之前，转换器会将格式说明附加到提示中，为模型提供有关生成所需输出结构的明确指导。这些说明充当蓝图，使模型的响应符合指定的格式。

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

StructuredOutputConverter 是将模型输出转换为结构化输出的尽力而为的方法。无法保证 AI 模型会按要求返回结构化输出。模型可能无法理解提示或无法按要求生成结构化输出。请考虑实施验证机制以确保模型输出符合预期。

StructuredOutputConverter 不用于 LLM 的函数调用，因为此功能默认情况下会提供结构化输出。

结构化输出 API

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

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

}

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

public interface FormatProvider {
	String getFormat();
}

下图显示了使用结构化输出 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 实现。

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().getContent());

生成 Schema 中的属性排序

BeanOutputConverter 支持通过 @JsonPropertyOrder 注解在生成的 JSON Schema 中自定义属性排序。此注解允许您指定属性在 Schema 中出现的精确顺序，而不管它们在类或记录中的声明顺序如何。

例如，要确保 ActorsFilms 记录中属性的特定排序

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

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

泛型 Bean 类型

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

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().getContent());

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().getContent());

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().getContent());

支持的 AI 模型

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

内置 JSON 模式

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

OpenAI 结构化输出可以确保您的模型生成的响应严格符合您提供的 JSON Schema。您可以在保证模型生成的 message 为有效 JSON 的 JSON_OBJECT 与使用提供的 Schema 保证模型生成的响应与您提供的 Schema 匹配（spring.ai.openai.chat.options.responseFormat 选项）的 JSON_SCHEMA 之间进行选择。
Azure OpenAI - 提供一个 spring.ai.azure.openai.chat.options.responseFormat 选项，用于指定模型必须输出的格式。将其设置为 { "type": "json_object" } 将启用 JSON 模式，这将保证模型生成的 message 为有效 JSON。
Ollama - 提供一个 spring.ai.ollama.chat.options.format 选项，用于指定返回响应的格式。目前，唯一接受的值是 json。
Mistral AI - 提供一个 spring.ai.mistralai.chat.options.responseFormat 选项，用于指定返回响应的格式。将其设置为 { "type": "json_object" } 将启用 JSON 模式，这将保证模型生成的 message 为有效 JSON。