Skip to main content
特定のイベントが発生したときに ARIA へ プロンプト を送信するには、W&B のオートメーションを使用します。イベントが発生するたびに、オートメーションは新しい ARIA の会話を開始し、設定された プロンプト を送信します。 ARIA に プロンプト を送信するオートメーションは、主に次の 2 つの要素で構成されます。
  • オートメーションをトリガーするイベント
  • イベント発生時に ARIA が受け取る プロンプト。
このワークフローは、experiment の結果を調べたり、runs を要約または report にまとめたり、しきい値を超えたメトリクスを調査したりする際に使用します。 ARIA への プロンプト 送信は、W&B のオートメーションが実行できるアクションの 1 つです。他の送信先へ通知を送るオートメーションを作成するには、Create a Slack automation または Create a webhook automation を参照してください。 また、W&B のオートメーションの作成や管理を ARIA に任せることもできます。詳細については、ARIA でオートメーションを作成・管理するを参照してください。
W&B Multi-tenant Cloud でのみ利用できます。ARIA はチームの project で動作し、個人の entity では動作しません。また、組織の 組織管理者 が Smart features を有効にする必要があります。ガバナンスとセキュリティを参照してください。

Requirements

ARIA にプロンプトを送信するオートメーションを作成する前に、以下を確認してください。
  • 組織で ARIA が有効になっている必要があります。Action type の一覧に Trigger ARIA が表示されない場合、お使いの組織、スコープ、またはデプロイメントでは ARIA を利用できません。この場合、一覧には理由が示されないまま、選択肢が非表示になります。Governance and security を参照してください。
  • オートメーションのスコープとする project、Registry、またはコレクションに対する書き込み権限が必要です。
  • W&B のオートメーションを Registry にスコープ設定して ARIA にプロンプトを送信するには、同じ組織内のチームに所属している必要があります。ARIA の各会話はチームに関連付けられるため、その組織内のチームに所属していない場合は、Registry をスコープとするオートメーションを作成できません。
ARIA オートメーションが実行されるたびに ARIA 会話が開始され、自分で開始した会話と同様に組織の使用量としてカウントされます。

オートメーションを作成する

オートメーションを適用したい スコープ に応じて、Registry または Project を選択してください。その後、次の step に従って、ARIA に プロンプト を送信するオートメーションを作成します。
オートメーションをより広範に適用するには、グローバルな Automations ハブから作成し、Team または Organization スコープ を選択してください。step は以下と同じです。これらの スコープ では、W&B は artifact およびコレクションのイベントのみをサポートします。Automations ハブ を参照してください。
Registry 管理者は、その registry でオートメーションを作成できます。
  1. W&B にログインします。
  2. registry 名をクリックして詳細を表示します。
  3. registry をスコープとするオートメーションを作成するには、Automations タブをクリックし、Create automation をクリックします。registry をスコープとするオートメーションは、そのすべてのコレクション (今後作成されるものを含む) に自動的に適用されます。
  4. 監視する イベント を選択します。 イベントに応じて表示される追加のフィールドを入力します。たとえば、An artifact alias is added を選択した場合は、Alias regex を指定する必要があります。 Next step をクリックします。
  5. ARIA の会話をホストするチームを選択します。オートメーションによって作成された会話を表示する を参照してください。
  6. Action typeTrigger ARIA に設定します。
  7. Prompt フィールドに、ARIA に送信する プロンプト を記述します。プロンプト を記述する を参照してください。Next step をクリックします。
  8. オートメーションの名を指定します。必要に応じて説明を入力します。
  9. Create automation をクリックします。
これでオートメーションが実行中となり、選択したイベントが registry で発生するたびに新しい ARIA の会話を開始します。

ARIA でオートメーションを作成・管理する

ARIA は、必要に応じてオートメーションの作成、削除、有効化、無効化を実行できます。 ARIA にオートメーションの作成を依頼します: 既存のオートメーションについて ARIA に問い合わせます:

プロンプトを記述する

ARIA の アクション で設定する必要があるのはプロンプトのみです。ARIA のチャットウィンドウでメッセージを書くのと同じ要領で記述し、ARIA に調べさせる run、artifact、メトリクスを指定するために テンプレート変数 を含めてください。 次の制約に注意してください。
  • プロンプトは必須で、最大 4,000 文字です。W&B は テンプレート変数 を置換した後にもう一度長さをチェックするため、保存に成功したプロンプトでも、置換後の値が長い場合はオートメーションの実行時に失敗することがあります。このチェックに失敗したプロンプトは、オートメーションの実行履歴に失敗した 実行 として記録されます。
  • イベントに該当しない テンプレート変数 は、変数名そのものではなく空文字列に解決されます。対象のイベントに記載されている変数のみを使用してください。
  • ARIA はオートメーションが実行されるたびに新しい会話を開始します。以前の会話を引き継ぐことはなく、同じオートメーションの過去の 実行 を記憶することもありません。
変数を挿入するには、Prompt フィールドの下のリストで、その変数の横にある をクリックします。W&B は変数をプロンプトの末尾に追加します。このリストには、選択したイベントに該当する変数のみが表示されます。 たとえば、次のプロンプトは新しく link されたモデルバージョンをそれぞれ調査します。
オートメーションを保存する前に、プロンプト の文面を考える手助けを ARIA に依頼できます。

テンプレート変数

テンプレート変数は ${variable_name} という構文を使用します。プロンプトで使用できる変数は、オートメーションが監視するイベントによって異なります。 以下の変数は、すべてのイベントで使用できます。 イベントに応じて、上記に加えて以下の変数も使用できます。 個々の変数に関する注意点は以下のとおりです。
  • ${artifact_version} は、wandb-artifact://_id/QXJ0aWZhY3Q6NTE3ODg5ODg3 のような artifact インスタンスに解決されます。バージョンを名前で参照するには、${artifact_version_string} を使用してください。
  • ${artifact_metadata.KEY} は、イベントをトリガーした artifact バージョンからカスタムメタデータの値を読み取ります。KEY は取得したいメタデータのキーに置き換えてください。サポートされるのはトップレベルのメタデータキーのみです。
各スコープで使用できるイベントについては、Automation events and scopes を参照してください。

オートメーションによって作成された会話を表示する

オートメーションは、イベントのきっかけとなるアクションを実行したユーザーではなく、そのオートメーションを作成したユーザーのアカウントで ARIA 会話を作成します。会話は、そのユーザーの ARIA チャット履歴の Past conversations に、自分で開始した会話と並んで表示されます。イベントを発生させたユーザーを特定するには、プロンプトに ${event_author} を含めてください。 会話が作成される場所は、オートメーションのスコープによって異なります。
  • project スコープおよびチームスコープのオートメーション: 会話は、イベントが発生した project に作成されます。
  • Registry スコープのオートメーション: Registry はチームではなく組織に属しますが、ARIA 会話はチームに属している必要があります。この場合、会話はオートメーションの作成時に選択したチームの wandb_agent_default_project という project に作成されます。Registry ではなく、そちらを確認してください。 wandb_agent_default_project は、開いている project に紐づかない会話を保持するために、W&B がチームごとに用意しているプレースホルダー project です。ユーザーが作成する必要はなく、通常はこれらの会話以外は空の状態です。
オートメーションが実行されたことを確認するには、その 実行履歴 を開きます。ARIA の実行が成功した場合、W&B が送信したプロンプトと、会話の thread_id を含むレスポンスボディが表示されます。なお、実行から会話へのリンクは提供されておらず、オートメーションが作成した会話がチャット履歴内で区別して表示されることもありません。

オートメーションの表示と管理

オートメーションの表示と管理は、project または Registry の Automations タブ、あるいはグローバルな Automations ハブから行えます。オートメーションの一覧では、アクションは ARIA と表示されます。 ARIA にプロンプトを送信するオートメーションを編集できるのは、その作成者のみです。ARIA の会話がそのユーザーとして実行されるためです。project または Registry への書き込み権限を持つチームメンバーは、オートメーションの表示と削除は可能ですが、オートメーションの Edit オプションは利用できません。 オートメーションの所有権を移譲することはできません。代わりに、オートメーションを削除し、新しい所有者に作成し直してもらってください。作成者がチームを離れたオートメーションを復旧する場合も、同じ手順を使用します。

制限事項

  • ARIA オートメーションは、W&B Multi-tenant Cloud の team project でのみ利用可能で、かつ 組織管理者 が Smart features を有効化している必要があります。
  • 1 つのオートメーションが開始できる ARIA 会話は、1 分あたり最大 3 件です。この上限を超えた実行は、ステータス Skipped としてオートメーションの履歴に記録されます。これは、オートメーションが イベント に一致したものの アクション を実行しなかったことを示します。
  • オートメーションを作成したユーザーが project への書き込み権限を失った場合、またはそのアカウントが無効化された場合、それ以降の実行はすべて失敗します。失敗はオートメーションの実行履歴に表示されます。
  • オートメーションを編集できるのは、その作成者のみです。
  • wandb Python ライブラリは ARIA オートメーションをサポートしていません。API でオートメーションを管理するを参照してください。

次のステップ