此版本仍在开发中,尚未被视为稳定版本。最新的快照版本请使用 Spring AI 1.0.0-SNAPSHOT! |
贡献准则
代码格式化和 Javadoc
在提交 PR 之前,请运行以下命令以确保正确的格式和 Javadoc 处理
./mvnw spring-javaformat:apply javadoc:javadoc -Pjavadoc
这是一个支持 Javadoc 处理的配置文件,以避免在开发时构建时间过长。-Pjavadoc
贡献新的 AI 模型实现
本节概述了贡献新 AI 模型实现的步骤。 AI 模型差异很大,输入和输出各不相同 — 从聊天模型 将文本输入转换为文本输出,转换为生成图像的文本到图像模型 从文本描述中。 复杂模型甚至可以处理多种类型的输入和输出,例如组合文本、 图像和视频,以生成混合媒体输出。
要贡献新模型,请遵循以下步骤:
-
创建低级客户端 API 类:如果没有适合 AI 模型的现有 Java 客户端, 您需要开发一个低级客户端 API 类。这通常涉及使用 Spring Framework 中的类,类似于类。
RestClient
OpenAiApi
-
创建 Model 实现确保您的客户端符合通用模型 API。 如果您的模型的输入和输出受支持,请使用现有的请求和响应类。 如果没有,请为 Generic Model API 创建新类并建立新的 Java 包。
-
实现自动配置和 Spring Boot Starter:此步骤涉及创建 必要的自动配置和 Spring Boot Starter 轻松实例化新模型 Spring Boot 应用程序。
-
编写测试:所有新类都应附带全面的测试。 现有测试可以作为构建和实现测试的有用参考。
-
记录您的贡献:确保您的文档遵循现有格式, 有关建议的结构和格式的示例,请参阅 Open AI Chat 文档。
通过遵循这些准则,我们可以大大扩展框架的支持模型范围 同时遵循通用的实现和文档模式。