贡献指南

贡献新的 AI 模型实现

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

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

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

  2. 创建模型实现 确保您的客户端符合 通用模型 API。如果您的模型的输入和输出受支持，请使用现有的请求和响应类。如果不是，请为通用模型 API 创建新的类，并建立一个新的 Java 包。

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

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

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

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