聊天模型 API

聊天模型 API 使开发人员能够将 AI 驱动的聊天补全功能集成到其应用程序中。它利用预训练的语言模型，例如 GPT (生成式预训练 Transformer)，以自然语言对用户输入生成类似人类的回应。

该 API 通常通过向 AI 模型发送 Prompt 或部分对话来实现功能，然后模型根据其训练数据和对自然语言模式的理解生成对话的补全或延续。完成的响应随后返回给应用程序，应用程序可以将其呈现给用户或用于进一步处理。

Spring AI Chat Model API 旨在成为一个简单且可移植的接口，用于与各种AI 模型进行交互，使开发人员能够以最少的代码更改在不同模型之间切换。这种设计与 Spring 的模块化和互换性理念相符。

此外，借助 Prompt（用于输入封装）和 ChatResponse（用于输出处理）等配套类，聊天模型 API 统一了与 AI 模型的通信。它管理请求准备和响应解析的复杂性，提供了直接且简化的 API 交互。

您可以在可用实现部分找到更多关于可用实现的信息，并在聊天模型比较部分找到详细的比较信息。

API 概览

本节提供了 Spring AI 聊天模型 API 接口和相关类的指南。

ChatModel

以下是 ChatModel 接口定义

public interface ChatModel extends Model<Prompt, ChatResponse> {

	default String call(String message) {...}

    @Override
	ChatResponse call(Prompt prompt);
}

带有 String 参数的 call() 方法简化了初始使用，避免了更复杂的 Prompt 和 ChatResponse 类的复杂性。在实际应用中，更常见的是使用接受 Prompt 实例并返回 ChatResponse 的 call() 方法。

StreamingChatModel

以下是 StreamingChatModel 接口定义

public interface StreamingChatModel extends StreamingModel<Prompt, ChatResponse> {

    default Flux<String> stream(String message) {...}

    @Override
	Flux<ChatResponse> stream(Prompt prompt);
}

stream() 方法接受 String 或 Prompt 参数，类似于 ChatModel，但它使用响应式 Flux API 流式传输响应。

Prompt

Prompt 是一个 ModelRequest，它封装了 Message 对象的列表和可选的模型请求选项。以下列表显示了 Prompt 类的截断版本，不包括构造函数和其他实用方法

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

    private final List<Message> messages;

    private ChatOptions modelOptions;

	@Override
	public ChatOptions getOptions() {...}

	@Override
	public List<Message> getInstructions() {...}

    // constructors and utility methods omitted
}

Message

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

接口定义如下

public interface Content {

	String getText();

	Map<String, Object> getMetadata();
}

public interface Message extends Content {

	MessageType getMessageType();
}

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

public interface MediaContent extends Content {

	Collection<Media> getMedia();

}

Message 接口有多种实现，对应于 AI 模型可以处理的消息类别

Spring AI Message API

聊天补全端点根据对话角色区分消息类别，这通过 MessageType 进行有效映射。

例如，OpenAI 识别不同对话角色的消息类别，如 system（系统）、user（用户）、function（函数）或 assistant（助手）。

虽然术语 MessageType 可能暗示特定的消息格式，但在本文档中，它有效地指定了消息在对话中扮演的角色。

对于不使用特定角色的 AI 模型，UserMessage 实现充当标准类别，通常代表用户生成的查询或指令。要理解实际应用以及 Prompt 和 Message 之间的关系，特别是在这些角色或消息类别的上下文中，请参阅Prompts 部分的详细解释。

聊天选项

表示可以传递给 AI 模型的选项。ChatOptions 类是 ModelOptions 的子类，用于定义一些可以传递给 AI 模型的可移植选项。ChatOptions 类定义如下

public interface ChatOptions extends ModelOptions {

	String getModel();
	Float getFrequencyPenalty();
	Integer getMaxTokens();
	Float getPresencePenalty();
	List<String> getStopSequences();
	Float getTemperature();
	Integer getTopK();
	Float getTopP();
	ChatOptions copy();

}

此外，每个特定模型的 ChatModel/StreamingChatModel 实现都可以有自己的可以传递给 AI 模型的选项。例如，OpenAI 聊天补全模型有自己的选项，如 logitBias、seed 和 user。

这是一个强大的功能，允许开发人员在启动应用程序时使用模型特定的选项，然后在运行时使用 Prompt 请求覆盖它们。

Spring AI 提供了一个复杂的系统，用于配置和使用聊天模型。它允许在启动时设置默认配置，同时也提供了在每个请求基础上覆盖这些设置的灵活性。这种方法使开发人员能够轻松地使用不同的 AI 模型并根据需要调整参数，所有这些都在 Spring AI 框架提供的一致接口内完成。

以下流程图说明了 Spring AI 如何处理聊天模型的配置和执行，结合了启动时和运行时选项

chat options flow

  1. 启动时配置 - ChatModel/StreamingChatModel 使用“启动”聊天选项进行初始化。这些选项在 ChatModel 初始化期间设置，用于提供默认配置。

  2. 运行时配置 - 对于每个请求，Prompt 可以包含运行时聊天选项：这些可以覆盖启动时选项。

  3. 选项合并过程 - “合并选项”步骤结合了启动时和运行时选项。如果提供了运行时选项，它们将优先于启动时选项。

  4. 输入处理 - “转换输入”步骤将输入指令转换为原生、模型特定的格式。

  5. 输出处理 - “转换输出”步骤将模型的响应转换为标准化的 ChatResponse 格式。

启动时和运行时选项的分离允许进行全局配置和请求特定的调整。

ChatResponse

ChatResponse 类的结构如下

public class ChatResponse implements ModelResponse<Generation> {

    private final ChatResponseMetadata chatResponseMetadata;
	private final List<Generation> generations;

	@Override
	public ChatResponseMetadata getMetadata() {...}

    @Override
	public List<Generation> getResults() {...}

    // other methods omitted
}

ChatResponse 类保存 AI 模型的输出，每个 Generation 实例包含单个 Prompt 可能产生的多个输出之一。

ChatResponse 类还携带了关于 AI 模型响应的 ChatResponseMetadata 元数据。

Generation

最后，Generation 类继承自 ModelResult，用于表示模型输出（助手消息）及相关元数据

public class Generation implements ModelResult<AssistantMessage> {

	private final AssistantMessage assistantMessage;
	private ChatGenerationMetadata chatGenerationMetadata;

	@Override
	public AssistantMessage getOutput() {...}

	@Override
	public ChatGenerationMetadata getMetadata() {...}

    // other methods omitted
}

可用实现

此图说明了统一接口 ChatModel 和 StreamingChatModel 如何用于与来自不同提供商的各种 AI 聊天模型进行交互，从而允许轻松集成和切换不同的 AI 服务，同时为客户端应用程序维护一致的 API。

spring ai chat completions clients
在聊天模型比较部分找到可用聊天模型的详细比较。

聊天模型 API

Spring AI 聊天模型 API 构建在 Spring AI 的 通用模型 API 之上，提供了特定于聊天的抽象和实现。这允许轻松集成和切换不同的 AI 服务，同时为客户端应用程序维护一致的 API。以下类图说明了 Spring AI 聊天模型 API 的主要类和接口。

spring ai chat api