貢献ガイドライン

コードフォーマットと Javadoc

PR を送信する前に、適切なフォーマットと Javadoc 処理を確実に行うために次のコマンドを実行してください。

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

-Pjavadoc は、開発時に長いビルド時間を回避するために Javadoc 処理を有効にするプロファイルです。

新しい AI モデルの実装に貢献する

このセクションでは、新しい AI モデルの実装に貢献する手順の概要を説明します。AI モデルは、テキスト入力をテキスト出力に変換するチャットモデルから、テキストの説明からイメージを生成する Text-to-Image モデルまで、多様な入力と出力を備え、大きく異なります。複雑なモデルでは、テキスト、イメージ、ビデオを組み合わせて混合メディア出力を生成するなど、複数の型の入出力を処理することもできます。

新しいモデルを提供するには、次の手順に従います。

  1. 低レベルのクライアント API クラスを作成する : AI モデルに適合する既存の Java クライアントがない場合は、低レベルのクライアント API クラスを開発する必要があります。これには、OpenAiApi クラスと同様に、Spring Framework の RestClient クラスを利用することがよくあります。

  2. モデル実装を作成するクライアントが汎用モデル API に準拠していることを確認してください。モデルの入力と出力がサポートされている場合は、既存のリクエストクラスとレスポンスクラスを使用します。そうでない場合は、汎用モデル API の新しいクラスを作成し、新しい Java パッケージを確立します。

  3. 自動構成と Spring Boot スターターの実装 : この手順には、Spring Boot アプリケーションで新しいモデルを簡単にインスタンス化するために必要な自動構成と Spring Boot スターターの作成が含まれます。

  4. テストを書く : すべての新しいクラスには包括的なテストが伴う必要があります。既存のテストは、テストを構築および実装するための有用な参照として役立ちます。

  5. 貢献をドキュメント化する : ドキュメントが既存の形式に従っていることを確認してください。推奨される構造と形式の例については、Open AI チャットのドキュメントを参照してください。

これらのガイドラインに従うことで、共通の実装とドキュメントのパターンに従いながら、フレームワークでサポートされるモデルの範囲を大幅に拡張できます。