✣ RUNWARE

サンプルガイド

runwareのGitHubサンプルを探す方法

眺めるだけのスクリーンショットではなく、応用できるコードをお探しですか?まず、プロジェクトに必要なタスク、モデル、レスポンスデータを明確にしましょう。このガイドでは、リポジトリの探し方と3つのワークフロー例を分けて紹介します。サンプルがそのまま動くと決めつけずに評価できます。

このケースでの課題

検索結果に表示されたリポジトリが関連しているように見えても、知りたいことには答えていない場合があります。リクエストをコピーする前に、サンプルが用途に合っているか確認しましょう。

アプリケーション開発者

ユーザーが入力した説明文から画像を生成する必要がありますが、リポジトリのサンプルでは入力、モデル、出力処理が固定されているかもしれません。サンプルのリクエストが成功しても、そのままユーザー向けの機能になるわけではありません。

プロンプトがリクエストのどこに入るか、レスポンスをどこで読み取るか、エラーがどこに表示されるかを追跡しましょう。全体的な手順を確認するには、リンク先の使い方ガイドをご覧ください。

runware aiの使い方

クリエイティブツールのチーム

同じブリーフから複数のビジュアル案を作りたい場合でも、サンプルには結果が1つしか示されず、選ばれたモデルが題材や希望するスタイルに適しているか説明されていないことがあります。

サンプルで指定されているモデルを記録し、同じブリーフを使って結果を比較してから、その設定を採用しましょう。

runwareのモデル

技術評価担当者

コードスニペットを見つけても、どのサービスを呼び出すのか、どの認証情報が必要なのか、レスポンスの形式が現在のサービスドキュメントと一致しているのか分からないことがあります。

まずサービスとドキュメントに記載されたリクエストの流れを確認しましょう。そのうえで、リポジトリのコードが製品の動作を保証するものと考えず、管理された環境でスニペットをテストしてください。

runwareとは

3つの具体的なワークフロー

次の3つのルートを順に確認しましょう。基本的なリクエストを把握し、モデルの選択を検討してから、サービスとサンプルが実際に何をカバーしているかを確認します。

出力例

以下の結果は、受け入れ確認の例であり、実際に取得したレスポンスでも、特定のGitHubリポジトリに関する主張でもありません。実際に観測される出力は、テストするサンプルによって異なります。

    1. プロトタイプ

      プロンプトから画像を生成するプロトタイプ

      入力:ユーザーが提供する短い商品画像の制作指示。期待されるアプリケーションの動作:返された画像を表示し、リクエストを完了できない場合はエラー状態が分かるようにする。有用なのは、リクエストの組み立て方とレスポンスの処理方法の両方を示すサンプルです。READMEに画像が表示されていても、自分のインターフェースでどちらも機能することの証明にはなりません。最新のドキュメントを確認し、実際のレスポンスをテストするまでは、レスポンスに特定のフィールドがあると決めつけて実装しないでください。

      1. サンプルのリクエストでプロンプトの値を見つけ、固定されたテキストをテスト用の制作指示に置き換えます。
      2. モデル識別子と必須のリクエストフィールドを最新のドキュメントで確認します。
      3. 実際のレスポンスを調べ、出力がない場合とリクエストエラーを別々に処理します。
      画像生成を見る
    2. 評価

      同一の制作指示による比較

      入力:複数のビジュアル案の試行で再利用する1つの制作指示。期待される評価結果:制作指示、使用したモデル、観測された各結果を記載した簡潔な比較記録。これにより、リポジトリ内のサンプル画像を再現可能なベンチマークと誤認せずに、ある方向性を選んだ理由をチームで説明できます。サンプルで設定を変更できる場合は、一度に1つずつ変更します。そうでなければ、確認できる設定だけを比較してください。

      1. 制作指示の全文を保存し、サンプルで指定されているモデルを記録します。
      2. 基準となる結果を取得してから、ドキュメントに記載された設定またはモデルの選択肢を1つだけ変更します。
      3. ビジュアルとしての適性を確認し、成功した結果とともに失敗も記録します。
      ビジュアルの方向性を見る
    3. 統合

      レスポンス処理の確認

      入力:本番環境以外から送信するテストリクエスト。期待されるエンジニアリング上の成果:コードが実際に受け取るレスポンスフィールドと、無効なリクエストや出力を取得できない場合の動作を記録すること。ギャラリーほど見栄えはしませんが、魅力的なコード例を信頼できる統合の候補にできるかどうかは、ここで決まります。シークレットをログに記録したり、サンプルがリトライ、保存、アクセス制御まで対応していると思い込んだりしないでください。

      1. テスト入力でサンプルを実行し、ドキュメントに記載されたレスポンスの構造を確認します。
      2. リクエストが拒否された場合や結果がない場合に、コードがどのように報告するかを確認します。
      3. 変更したコードを共有またはデプロイする前に、シークレットをソースファイルから移します。
      サービスを見る

    コンプライアンス上の注意点

    導入前にソースを確認する

    GitHubのサンプルは、含まれるすべての依存関係、画像、アセットの再利用を許可するものではなく、レビューすべきコードとして扱ってください。各リポジトリのライセンスを読み、依存関係を調べ、手順が現在のサービスドキュメントと一致することを確認してください。認証情報をコミットするファイルに含めず、テスト用プロンプトで機密性の高いユーザーコンテンツを送信しないでください。また、想定する用途に適用される利用規約を確認してください。サンプルのライセンスやメンテナーが明確でない場合は、確認を求めるか、ドキュメントがより充実したものを出発点にしてください。

    画像生成を試す
    • リポジトリのライセンスと依存関係を確認する。
    • 認証情報をコミットせずにリクエストをテストする。
    • アプリケーションの動作を約束する前に、実際の出力を確認する。

    シナリオ別FAQ

    画像生成やレスポンス処理など、実行したいタスクとサービス名を組み合わせてGitHubで検索してください。検索結果を信頼できる出発点として扱う前に、リポジトリのメンテナー、更新履歴、ライセンスを確認してください。

    そのまま動くとは限りません。サンプルが特定の認証情報、モデル識別子、ライブラリのバージョン、レスポンスのフィールドに依存している場合があります。組み込む前に現在のドキュメントと照合し、小規模なテストを実行してください。

    リクエストの入力、モデルの選択、結果とエラーの両方を処理するコードを確認してください。サンプル画像だけでは、アプリケーションが出力をどのように受け取り、表示するかは分かりません。

    まずライセンスとアセット固有の注意書きを確認してください。コードと画像では許可される利用方法が異なる場合があります。条件が不明確なら、リポジトリが再利用を許可していると決めつけず、自分のアセットを使用してください。

    テスト環境で実行して実際のレスポンスを確認するまで、出力は不明として扱ってください。確認できたフィールドを記録し、リクエストが失敗したときの動作も調べてください。

    モデルを探す
    モデルを探す