W&B Multi-tenant Cloud でのみ利用できます。
ARIA が付与されたシークレットを使用する仕組み
ARIA に個人シークレットへのアクセスを付与すると、会話内で次にメッセージを送信した時点から、ARIA のサンドボックスにシークレットと同じ名前の環境変数が設定されます。新しいチャットを開始する必要はありません。アクセスを取り消した場合も同様で、次のメッセージ以降、その変数はサンドボックスから削除されます。 次の点に注意してください。- チャットに表示されるサンドボックスの出力では、シークレットの値はマスクされます。
- 付与されたシークレットで、
WANDB_API_KEYなどのマネージド環境変数を置き換えることはできません。名前がマネージド変数と競合するシークレットや、環境変数名として無効なシークレットはスキップされ、サンドボックスには渡されません。 - ARIA が使用できるのは、会話が属する組織内であなたが付与したシークレットのみです。
個人シークレットを作成する
個人シークレットを作成して ARIA が使用できるようにするには、次の手順を実行します。- ページの右上にある User menu ドロップダウンを選択し、Settings を選択します。
- Personal secrets セクションまでスクロールします。
- New secret をクリックします。個人シークレットがまだない場合は、代わりに Create new secret をクリックします。
-
シークレットの Name を環境変数の形式で入力します。使用できる文字は英字、数字、アンダースコア (
_) で、先頭に数字は使用できません。例:GITHUB_TOKEN同じ名前のチームシークレットが存在する場合は、ドロワーにその旨が表示されます。個人シークレットはチームシークレットよりも優先されます。 - 機密性の高い値を Value フィールドに貼り付けます。
- シークレットの作成と同時に ARIA にアクセスを許可するには、Allow ARIA to use this secret をオン (デフォルト) のままにします。ARIA にアクセスを許可せずにシークレットを保存する場合は、オフにします。
- Save secret をクリックします。
ARIA のアクセス権を付与または失効させる
ARIA が使用できる個人シークレットは、ユーザー設定または ARIA パネルからいつでも変更できます。どちらの方法で変更した場合も、会話で次のメッセージを送信した時点から反映されます。ユーザー設定から
ユーザー設定の Personal secrets セクションでは、各シークレットの行に ARIA access スイッチがあります。オンにすると、そのシークレットへのアクセス権が ARIA に付与されます。オフにすると、アクセス権が失効します。
ARIA パネルから
- ARIA のチャットウィンドウでチャット履歴サイドバーが非表示になっている場合は、 (Reveal chat history) をクリックして開きます。
- Customize セクションで Secrets をクリックします。ペインには現在の組織内の個人シークレットが一覧表示され、サマリーには ARIA が使用できるシークレットの数が表示されます。
- ARIA にアクセスを許可するにはシークレットのスイッチをオンにします。アクセスを失効させるにはオフにします。
GitHub リポジトリを接続する
ARIA でシークレットを使用する最も一般的な用途は、GitHub との接続です。GitHub の個人用アクセストークンを個人シークレットとして保存しておくと、ARIA はリポジトリのコードを読み取れるようになります。トークンで許可されていれば、ブランチへのコミットやプルリクエストの作成も可能です。GitHub 側ではトークン以外に何もインストールや認可を行わないため、ARIA が実行できる操作は作成したトークンによって決まります。 開始するには、チャットウィンドウで Connect my GitHub repo 候補チップをクリックするか、/connect-github を送信します。このチップは project の workspace など大半のページに表示されますが、スタンドアロンの ARIA ビューには表示されません。ARIA が接続するリポジトリと書き込みを許可するかどうかを尋ね、続いて以下の手順を案内します。
- GitHub の個人用アクセストークンを作成する
GitHub で Settings > Developer settings > Personal access tokens に移動し、トークンを作成します。
- Fine-grained token (推奨) : リソース所有者を自分のアカウント、またはリポジトリを所有する組織に設定し、Repository access の対象を接続するリポジトリに限定します。次に、ARIA に許可する操作に応じて Repository permissions を設定します。読み取りのみの場合は Contents を Read-only に、コミットも行う場合は Read and write に設定します。プルリクエストを作成する場合は、Pull requests を Read and write に設定します。読み取り専用の Metadata アクセスは GitHub によって自動的に付与されます。トークンを使用するには、組織の所有者による承認が必要になる場合があります。
- Classic token:
repoスコープでは、プライベートリポジトリでの読み取り、コミット、ブランチ操作、プルリクエストが可能です。パブリックリポジトリの場合はpublic_repoで対応できます。SAML SSO を使用している組織では、Configure SSO からその組織に対してもトークンを承認してください。
- トークンを個人シークレットとして保存し、ARIA にアクセスを許可する
個人シークレットを作成する の手順に従って、トークンを保存します。名前には慣例の GITHUB_TOKEN、または環境変数名として有効な任意の名前を付けます。また、ARIA からのアクセスが有効になっていることを確認してください。
次に送信するメッセージ以降、トークンは指定した名前の環境変数として ARIA のサンドボックスで利用できるようになります。
- GitHub へのネットワークアクセスを承認する
デフォルトでは、ARIA がコードを実行するサンドボックスは Weights & Biases のサービスにはアクセスできますが、それ以外のほとんどのドメインへのアクセスはブロックされます。そのため、GitHub にアクセスするには、ネットワークアクセスの許可も必要です。ARIA は GitHub へのアクセスが必要になると、タスクに必要なドメインへのアクセスをチャット内でリクエストし、その理由を説明したうえで、ユーザーの応答を待ちます。GitHub API の呼び出しには api.github.com、クローンやプッシュには github.com へのアクセスが必要です。承認する場合は Grant access を、拒否する場合は Deny をクリックします。許可は、リクエストのきっかけとなったメッセージだけでなく、現在のチャットセッションが終わるまで有効です。ただし、他のチャットには引き継がれません。詳しくは、ネットワークアクセスを許可するを参照してください。
接続後に ARIA でできること
トークンを付与してネットワークアクセスを承認したら、普段の言葉で ARIA にリポジトリでの作業を依頼できます。トークンの権限に応じて、ARIA は次の操作を実行できます。- コードの読み取りと分析 (リポジトリのクローンや特定のファイルの取得など) 。
- ブランチへの変更のコミットとプッシュ。
- 変更内容を含むプルリクエストの作成。
User prompt
接続のトラブルシューティング
GitHub へのリクエストが失敗した場合、ARIA は GitHub から返されたエラーを報告し、解決策を提案します。主な原因は次のとおりです。401 Bad credentials: GitHub がトークンを拒否しました。トークンの入力ミス、有効期限切れ、または失効が考えられます。新しいトークンを作成し、Personal secrets でシークレットの値を更新してから、リクエストを再送信してください。- 存在するはずのリポジトリで
404 Not Foundが返される: トークンからプライベートリポジトリを参照できない場合、GitHub は 403 ではなく 404 を返します。トークンがリポジトリにアクセスできるかどうかを確認してください。- fine-grained トークンの場合は、リソース所有者がリポジトリを所有するアカウントまたは組織であること、リポジトリが Repository access に含まれていること、さらに組織で承認が必須となっている場合は組織の所有者がトークンを承認済みであることを確認してください。
- classic トークンの場合は、
repoスコープが付与されていること、および SAML SSO を使用している組織ではその組織に対して認可されていることを確認してください。
- コミットまたはプルリクエストの作成時に
403 Forbiddenが返される: トークンにリポジトリの読み取り権限はあるものの、書き込み権限がありません。Contents と Pull requests にそれぞれ Read and write を付与するか、repoスコープを持つ classic トークンを使用してください。 - ARIA からシークレットが設定されていないと応答がある: シークレットの ARIA access スイッチをオンにしてから、改めてメッセージを送信してください。最後のメッセージ以降にアクセスを許可したシークレットは、次のメッセージを送信するまで ARIA からは参照できません。