贡献指南

代码格式和 Javadoc

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

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

-Pjavadoc 是一个启用 Javadoc 处理的配置文件，以便在开发时避免漫长的构建时间。

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

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

**创建低级客户端 API 类**：如果现有的 Java 客户端不适合 AI 模型，则需要开发一个低级客户端 API 类。这通常涉及利用 Spring Framework 中的 RestClient 类，类似于 OpenAiApi 类。
**创建模型实现** 确保您的客户端符合通用模型 API。如果您的模型的输入和输出受支持，请使用现有的请求和响应类。如果不是，请为通用模型 API 创建新的类并建立一个新的 Java 包。
**实现自动配置和 Spring Boot 启动器**：此步骤涉及创建必要的自动配置和 Spring Boot 启动器，以便使用 Spring Boot 应用程序轻松实例化新模型。
**编写测试**：所有新类都应附带全面的测试。现有的测试可以作为构建和实施测试的有用参考。
**记录您的贡献**：确保您的文档遵循现有格式，例如，有关建议的结构和格式，请参阅Open AI 聊天文档。

通过遵循这些指南，我们可以在遵循通用实现和文档模式的同时，极大地扩展框架支持的模型范围。