貢獻指南

程式碼格式化和 Javadoc

在提交 PR 之前，請執行以下命令以確保正確的格式化和 Javadoc 處理

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

-Pjavadoc 是一個 profile，用於啟用 Javadoc 處理，從而在開發時避免冗長的構建時間。

貢獻新的 AI 模型實現

本節概述了貢獻新的 AI 模型實現的步驟。AI 模型差異很大，具有不同的輸入和輸出——從將文字輸入轉換為文字輸出的聊天模型，到從文字描述生成影像的文字到影像模型。複雜的模型甚至可以處理多種型別的輸入和輸出，例如結合文字、影像和影片以產生混合媒體輸出。

要貢獻新模型，請遵循以下步驟

  1. 建立低階客戶端 API 類：如果沒有適合該 AI 模型的現有 Java 客戶端，您需要開發一個低階客戶端 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 聊天文件。

透過遵循這些指南，我們可以極大地擴充套件框架支援的模型範圍，同時遵循通用的實現和文件模式。