- オートメーションをトリガーするイベント
- イベント発生時に ARIA が受け取るプロンプト
W&B Multi-tenant Cloud でのみ利用できます。ARIA は個人の entity では動作せず、チームの project でのみ動作します。また、組織管理者が Smart features を有効にしている必要があります。詳しくは、ガバナンスとセキュリティを参照してください。
要件
ARIA にプロンプトを送信するオートメーションを作成する前に、以下を確認してください。- 組織で ARIA が有効になっている必要があります。Action type リストに Trigger ARIA が表示されない場合、その組織、スコープ、またはデプロイメントでは ARIA を利用できません。この場合、オプションは説明なしでリストに表示されません。詳しくは ガバナンスとセキュリティ を参照してください。
- オートメーションのスコープとなる project、registry、またはコレクションへの書き込みアクセス権が必要です。
- W&B オートメーションのスコープを registry に設定して ARIA にプロンプトを送信するには、同じ組織内のチームに所属している必要があります。各 ARIA 会話はチームに関連付けられるため、その組織内のどのチームにも所属していない場合は、registry をスコープとするオートメーションを作成できません。
オートメーションを作成する
オートメーションを適用するスコープに応じて、Registry または Project を選択します。続いて、以下の手順に従い、ARIA にプロンプトを送信するオートメーションを作成します。オートメーションをより広い範囲に適用するには、グローバルな Automations ハブから作成し、Team または Organization スコープを選択します。手順は以下と同じです。これらのスコープでは、W&B がサポートするのはアーティファクトイベントとコレクションイベントのみです。詳しくは Automations ハブを参照してください。
- Registry
- Project
Registry 管理者は、その Registry 内でオートメーションを作成できます。
- W&B にログインします。
- Registry 名をクリックして、詳細を表示します。
- Registry をスコープとするオートメーションを作成するには、Automations タブをクリックし、Create automation をクリックします。Registry をスコープとするオートメーションは、その Registry 内のすべてのコレクション (今後作成されるものを含む) に自動的に適用されます。
- 監視するイベントを選択します。 選択したイベントに応じて追加のフィールドが表示されるので、入力します。たとえば、An artifact alias is added を選択した場合は、Alias regex を指定する必要があります。 Next step をクリックします。
- ARIA 会話をホストするチームを選択します。Registry はチームではなく組織に属しますが、ARIA 会話はいずれかのチームに属している必要があります。詳しくはオートメーションによって作成された会話を表示するを参照してください。
- Action type を Trigger ARIA に設定します。
- Prompt フィールドに、ARIA に送信するプロンプトを記述します。詳しくはプロンプトを記述するを参照してください。Next step をクリックします。
- オートメーションの名前を入力します。必要に応じて、説明も入力します。
- Create automation をクリックします。
ARIA でオートメーションを作成・管理する
ARIA は、必要に応じてオートメーションの作成、削除、有効化、無効化を行えます。 ARIA にオートメーションの作成を依頼します。 既存のオートメーションについて ARIA に質問します。 ARIA にオートメーションのリネームを依頼します。 確認すると、ARIA がオートメーションをリネームします。チャットで ARIA のオートメーションを表示する
ARIA を開き、チャットヘッダーの Reveal chat history をクリックします。次に、チャット履歴サイドバーの下部にある Customize セクションを開き、My automations を選択します。 My automations は、ARIA のメインパネルで会話ビューの横に開くのではなく、会話ビューと置き換わる形で表示されます。会話を選択するか新しいチャットを開始すると、会話に戻ります。このペインの状態はリロード時に保持されないため、ページを更新した場合も会話に戻ります。 このペインに一覧表示されるのは、自分が作成したオートメーションのうち、ARIA にプロンプトを送信するものだけです。他の action を使用するオートメーションや、チームメイトの ARIA オートメーションは表示されません。 このペインは読み取り専用です。オートメーションが有効か無効かは確認できますが、有効化、無効化、編集、削除を行うには、View all automations をクリックして、新しいタブで Automations ページを開きます。オートメーションの表示と管理を参照してください。 名前で検索するか、Previous と Next で結果を 20 件ずつ切り替えて表示できます。一覧には、各オートメーションの名前、Event type、Scope が表示されます。 オートメーションをクリックすると詳細ビューが開き、Description、Scope、Created by、Created、Status (Enabled または Disabled) 、Event type、および送信される Prompt ARIA が表示されます。 Automation history セクションには、各実行の Triggered 時刻と Status、および Conversation 列が一覧表示されます。Open thread をクリックすると、その実行で作成された会話が開きます。値が No thread の場合、その実行では会話が作成されなかったことを示します。実行は最大 6 か月間表示されます。 一覧または詳細ビューから戻るには、Back to chat または Back to My automations を使用します。 オートメーションを作成するには、Create automation をクリックします。フォームは開かず、代わりに次のプロンプトがユーザーに代わって送信された状態で新しい ARIA チャットが開始されます。 請求情報への読み取り専用アクセス権しかない場合、Create automation は無効になります。My automations は個人アカウントでは使用できません。オートメーションを表示するには組織を選択してください。このペインを使用するために個別の機能フラグは必要ありません。要件で説明されているものと同じアクセスチェックを満たしていれば使用できます。プロンプトを記述する
ARIA action で設定する項目はプロンプトのみです。ARIA のチャットウィンドウでメッセージを書くのと同じ要領でプロンプトを記述し、テンプレート変数 を使って ARIA が調べる run、アーティファクト、またはメトリクスを指定します。 次の制約に注意してください。- プロンプトは必須で、最大 4,000 文字です。W&B はテンプレート変数を置換した後にも長さを再チェックします。そのため、置換後の値が長いと、保存できたプロンプトでもオートメーションの実行時に失敗することがあります。このチェックに失敗したプロンプトは、オートメーションの 実行履歴 に失敗した実行として記録されます。
- イベントに該当しないテンプレート変数は、変数名のままではなく空文字列に解決されます。選択したイベントに対応する変数のみを使用してください。
- ARIA はオートメーションが実行されるたびに新しい会話を開始します。以前の会話を引き継ぐことはなく、同じオートメーションの過去の実行内容も記憶しません。
テンプレート変数
テンプレート変数は${variable_name} という構文で記述します。プロンプトで使用できる変数は、オートメーションが監視するイベントによって異なります。
次の変数は、すべてのイベントで使用できます。
イベントによっては、上記の変数に加えて次の変数も使用できます。
個々の変数に関する注意事項は次のとおりです。
${artifact_version}は、wandb-artifact://_id/QXJ0aWZhY3Q6NTE3ODg5ODg3のようなアーティファクトのインスタンスに解決されます。バージョンを名前で参照するには、${artifact_version_string}を使用してください。${artifact_metadata.KEY}は、イベントをトリガーしたアーティファクトのバージョンからカスタムメタデータの値を読み取ります。KEYは目的のメタデータキーに置き換えてください。サポートされるのはトップレベルのメタデータキーのみです。
オートメーションによって作成された会話を表示する
オートメーションは、そのオートメーションを作成したユーザーのアカウントで ARIA 会話を作成します。この会話は、そのユーザーが自分で開始した会話と並んで、ARIA のチャット履歴サイドバーに表示されます。イベントを発生させたユーザーを特定するには、プロンプトに${event_author} を含めてください。
会話が作成される場所は、オートメーションのスコープによって異なります。
- project スコープおよびチームスコープのオートメーション: 会話は、イベントが発生した project に作成されます。
-
Registry スコープのオートメーション: Registry はチームではなく組織に属しますが、ARIA 会話はいずれかのチームに属している必要があります。そのため会話は、オートメーションの作成時に選択したチーム内の
wandb_agent_default_projectという名前の project に作成されます。Registry ではなく、この project を確認してください。wandb_agent_default_projectは、ユーザーが開いた project に紐付かない会話を保持するために、W&B がチームごとに管理しているプレースホルダー project です。ユーザーが自分で作成する必要はなく、通常はこれらの会話以外には何も含まれていません。
thread_id を含む応答本文が表示されます。その会話を開くには、ARIA の My automations ペインにある Open thread リンクを使用します。このリンクは同じ thread_id をもとに生成されています。なお、オートメーションによって作成された会話は、チャット履歴上で他の会話と区別されずに表示されます。
オートメーションの表示と管理
オートメーションは、project または registry の Automations タブ、あるいはグローバルな Automations ハブで表示と管理を行えます。オートメーションの一覧では、action は ARIA と表示されます。 ARIA にプロンプトを送信するオートメーションは、ARIA 会話が作成者のユーザーとして実行されるため、作成者本人しか編集できません。project または registry への書き込み権限を持つチームメンバーは、オートメーションを表示および削除できますが、Edit オプションは使用できません。 オートメーションの所有権は移譲できません。代わりに、オートメーションを削除し、新しい所有者に作成し直してもらってください。作成者がチームを離れたオートメーションを復旧する場合も、同じ手順で対応します。制限事項
ARIA オートメーションには次の制限があります。- ARIA オートメーションは、W&B Multi-tenant Cloud のチーム project でのみ利用できます。また、組織管理者が Smart features を有効にしている必要があります。
- 各オートメーションが開始できる ARIA 会話は、1 分あたり最大 3 件です。この上限を超えた実行は、ステータス Skipped としてオートメーションの履歴に記録されます。これは、オートメーションがイベントに一致したものの、action は実行されなかったことを示します。
- オートメーションを作成したユーザーが project への書き込みアクセス権を失った場合や、そのユーザーのアカウントが無効化された場合は、以降の実行はすべて失敗します。失敗はオートメーションの実行履歴に表示されます。
- オートメーションを編集できるのは、その作成者のみです。
wandbPython ライブラリは ARIA オートメーションに対応していません。API でオートメーションを管理するを参照してください。- チャット内の My automations ペインは読み取り専用です。オートメーションの有効化、無効化、編集、削除は、Automations タブまたはハブから行ってください。