貢獻指南

程式碼格式化與 Javadoc

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

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

-Pjavadoc 是一個設定檔，用於啟用 Javadoc 處理，以避免開發時建置時間過長。

貢獻新的 AI 模型實作

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

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

  1. 建立低階用戶端 API 類別：如果沒有現有的 Java 用戶端適合 AI 模型，您需要開發一個低階用戶端 API 類別。這通常涉及使用 Spring Framework 的 RestClient 類別，類似於 OpenAiApi 類別。

  2. 建立模型實作 確保您的用戶端符合 通用模型 API。如果您的模型的輸入和輸出受到支援，請使用現有的請求和回應類別。如果沒有，請為通用模型 API 建立新的類別並建立新的 Java 套件。

  3. 實作自動組態和 Spring Boot Starter：此步驟涉及建立必要的自動組態和 Spring Boot Starter，以便使用 Spring Boot 應用程式輕鬆實例化新模型。

  4. 編寫測試：所有新的類別都應附帶全面的測試。現有的測試可以作為組織和實作測試的有用參考。

  5. 記錄您的貢獻：確保您的文件遵循現有的格式。如需建議的結構和格式範例，請參閱 Open AI Chat 文件。

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