Contribution Guidelines

Contributing a New AI Model Implementation

本节概述了为新的人工智能模型实施做出贡献的步骤。人工智能模型差异很大，输入和输出多种多样——从将文本输入翻译成文本输出的聊天模型，到根据文本描述生成图像的文本到图像模型。复杂模型甚至可以处理多种类型的输入和输出，例如组合文本、图像和视频以生成混合媒体输出。

要为新模型做出贡献，请遵循以下步骤：

  1. Create a Low-Level Client API Class: 如果没有现有的 Java 客户端适合 AI 模型，你需要开发一个低级客户端 API 类。这通常涉及利用 Spring Framework 中的 RestClient 类，类似于 OpenAiApi 类。

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

  3. Implement Auto-Configuration and a Spring Boot Starter: 此步骤涉及创建必要的自动配置和 Spring Boot Starter，以便使用 Spring Boot 应用程序轻松实例化新模型。

  4. Write Tests: 所有新类都应附有综合测试。现有测试可作为构建和实施你的测试的有用参考。

  5. Document Your Contribution：确保您的文档遵循现有格式，有关建议的结构和格式，请参阅 Open AI Chat documentation。

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