RUNWARE

サンプルガイド

runware examples github の検索結果をどう調べるか

眺めるだけのスクリーンショットではなく、応用できるコードを探していますか?まず、プロジェクトに必要なタスク、モデル、レスポンスデータを特定しましょう。このガイドでは、リポジトリの探し方と、3 つのワークフロー例を分けて説明します。掲載しているモデルのリンク先はRunwareのGitHubリポジトリではなくモデルAPIです。モデルAPIへのリクエストには、リンク先にあるモデルAPIのサンプルを使用してください。

このケースで困ること

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

アプリケーション開発者

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

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

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

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

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

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

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

    始める
    始める