跳到主要内容

贡献指南

DeepSeek V3 中英对照 Contribution Guidelines

代码格式化和 Javadoc​

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

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

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

贡献一个新的 AI 模型实现​

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

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

  1. 创建低级客户端 API 类：如果没有现成的 Java 客户端适合 AI 模型，你需要开发一个低级客户端 API 类。这通常涉及使用 Spring Framework 中的 RestClient 类，类似于 OpenAiApi 类。

  2. 创建模型实现：确保你的客户端符合通用模型 API。如果你的模型的输入和输出受支持，则使用现有的请求和响应类。如果不支持，则为通用模型 API 创建新的类，并建立一个新的 Java 包。在记录个人身份信息（PII）时，使用 PII_MARKER Slf4j 标记进行标记。

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

  4. 编写测试：所有新类都应附带全面的测试。现有的测试可以作为编写和实现测试的有用参考。

  5. 记录你的贡献：确保你的文档遵循现有格式。有关建议的结构和格式示例，请参阅 Open AI Chat 文档。

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