贡献指南

代码格式与 Javadoc

在提交 PR 之前，请运行以下命令以确保正确的格式与 Javadoc 处理

./mvnw spring-javaformat:apply javadoc:javadoc -Pjavadoc

-Pjavadoc 是一个启用 Javadoc 处理的 profile，以避免开发时漫长的构建时间。

贡献一个新的 AI 模型实现

本节概述贡献一个新 AI 模型实现的步骤。 AI 模型差异很大，输入输出各异——从把文本输入转换为文本输出的聊天模型， 到从文本描述生成图像的文本生成图像模型。 复杂的模型甚至能处理多种类型的输入与输出，例如结合文本、 图像与视频以产出混合媒体输出。

要贡献一个新模型，请遵循以下步骤：

1. 创建一个底层客户端 API 类：如果没有现成的 Java 客户端适合该 AI 模型， 你就需要开发一个底层客户端 API 类。这通常会像 MistralAiApi 类那样， 利用 Spring Framework 的 RestClient 类。

2. 创建一个模型实现 确保你的客户端遵循通用模型 API。 如果模型的输入输出受支持，就复用既有的请求与响应类。 若不支持，则为通用模型 API 创建新类，并建立一个新 Java 包。 在记录个人身份信息（PII）时，用 PII_MARKER Slf4j 标记来标注它。

3. 实现自动配置和一个 Spring Boot Starter：这一步涉及创建 必要的自动配置与 Spring Boot Starter，以便在 Spring Boot 应用中 轻松实例化新模型。

4. 编写测试：所有新类都应配有全面的测试。 既有测试可作为组织和实现你测试的有用参考。

5. 为你的贡献编写文档：确保你的文档遵循既有格式， 关于所建议结构与格式的示例，请参阅 Open AI 聊天文档。

通过遵循这些指南，我们能以一套通用的实现与文档模式， 极大地扩展框架所支持的模型范围。