RAGの有効化

RAGを有効にする：

1. IBM Cloud にベクターストアをプロビジョニングする。

   1. IBM Cloud に Milvus または Elasticsearch のベクターストアインスタンスをプロビジョニングする。 ベクターストアがすでに IBM Cloud で利用可能な場合は、この手順を省略できます。

      • Elasticsearch ベクター ストア インスタンスをプロビジョニングするには、 Databases for Elasticsearch プロビジョニング」を参照してください。

      • Milvus ベクター ストア インスタンスをプロビジョニングするには、 watsonx.data のプロビジョニング」を参照してください。

        Milvus は の一部である。 IBM watsonx.data watsonx.data エンタープライズプランで Milvus インスタンスをプロビジョニングできます。

   2. オプション： IBM watsonx.ai Studio のインスタンスをプロビジョニングして、コードリポジトリのインデックスを作成します。

2. Milvus または Elasticsearch で、コードリポジトリのインデックスを作成または更新します。 詳しくは、 IBM watsonx.ai Studioでコード・リポジトリにインデックスを付けるを 参照してください。

   接続資産を設定する：

   1. watsonx Code Assistant サービス インスタンスの既存の配置スペースを使用します。

   2. ベクターストアに作成されるインデックスごとに接続アセットを作成します。 詳細については、 接続アセットの作成を 参照してください。

3. Visual Studio Code で Git パーソナルアクセストークンを設定し、RAG 対応のプロンプトを使用します。

   1. GitHub のプロフィールアイコンをクリックし、 [設定 ] > [ 開発者設定 ] > [ パーソナルアクセストークン ] > [ トークン (クラシック) ] に進みます。
   2. 個人アクセストークンをコピーします。
   3. Visual Studio Code で、[ 表示] をクリックし、[ コマンドパレット ]をクリックする。
   4. WCA を検索し、[ Enter GitHub Personal Access Token for WCA ] をクリックします。
   5. GitHub の個人アクセストークンを入力し、 Enter または Return を押します。
   6. チャットメッセージで、 @repo < instruction > または @docs < instruction > を入力すると、参照されたリポジトリまたはベクターストア内のドキュメントからのコンテキストを使用する応答が生成されます。 < instruction > パラメータをプロンプトメッセージに置き換える。

   • 参照先のリポジトリを使用するための構文例

     @repo how is a chat message processed?
     

     watsonx Code Assistant は、以下の条件に基づいてインデックス化されたリポジトリを使用する：

     • Visual Studio Code で1つのリポジトリが開かれている場合、 watsonx Code Assistant はデフォルトとして、開かれたリポジトリのコンテキストを検索する。

     • Visual Studio Code で複数のリポジトリが開かれている場合、 watsonx Code Assistant は、最近アクセスされたファイルに関連付けられているリポジトリのコンテキストを検索する。

     • Watsonx Code Assistant は、チャットで 構文を入力すると、インデックスが作成されたリポジトリで ファイルをチェックします。 @repo < instruction > repo.yaml 1つ以上のYAML設定ファイルが設定されている場合、 watsonx Code Assistant、設定されているすべてのリポジトリを使用してレスポンスを生成します。 YAMLコンフィギュレーションが設定されていない場合、 watsonx Code Assistant、選択されたリポジトリが使用されます。

   • 参照されるドキュメント・コレクションを使用するためのサンプル構文：

     @docs What are the steps to setup a connection to the user data store?
     

     Watsonx Code Assistant は、以下の条件に基づいてインデックス化された文書コレクションを使用します：

     • ドキュメントが Visual Studio Code で開かれている場合、 watsonx Code Assistant はデフォルトとして、開かれたリポジトリのコンテキストを検索します。

     • 複数の文書 コ レ ク シ ョ ンが Visual Studio Code で開かれてい る 場合、 watsonx Code Assistant は最近ア ク セ ス さ れた文書か ら コ ン テ キ ス ト を検索 し ます。

     • Watsonx Code Assistant は、チャットで 構文を入力すると、インデックスが作成されたリポジトリで ファイルをチェックします。 @docs < instruction > docs.yaml 1つ以上のYAML設定ファイルが設定されている場合、 watsonx Code Assistant、レスポンスを生成するために設定されたすべてのドキュメントコレクションを使います。 YAMLコンフィギュレーションが設定されていない場合、 watsonx Code Assistant、デプロイメントスペース内の docs_<filename> の名前を持つすべてのドキュメントが使用されます。

   オプション: インデックス化されたリポジトリやドキュメントコレクションに対してYAMLコンフィギュレーションをセットアップする必要がある場合は、 RAGのYAMLコンフィギュレーションのセットアップを 参照してください。

RAG用のYAMLコンフィギュレーションの設定

オプションでYAMLコンフィギュレーションを設定することで、 watsonx Code Assistant、複数のリポジトリを同時に検索したり、ベクターストアでインデックス化された特定のコードリポジトリやドキュメントを使用したりすることができます。 YAML 設定を設定しない場合、 watsonx Code Assistant は Visual Studio Code で開かれたリポジトリをデフォルトとして使用します。

watsonx Code Assistant は、許可されたリポジトリやドキュメント・コレクションのみにアクセスできるように、APIキーの認証方法を使用しています。

特定のインデックス付きリポジトリ用にYAML設定をセットアップするには、以下の手順を実行します：

1. リポジトリのルートレベルに .wca/repo フォルダーを作成します。

2. 以下のフィールドを持つYAMLファイルを作成する：

   repo:
      - url: git@github.ibm.com:code-assistant/<my-code>.git
   

   複数のリポジトリで watsonx Code Assistant を設定する必要がある場合は、レスポンスの生成に使用する必要があるリポジトリごとに repo.yaml ファイルを作成してください。

特定のドキュメント・コレクションに対してYAML設定を行うには、以下の手順を実行します：

1. リポジトリのルートレベルに .wca/docs フォルダーを作成します。

2. 以下のフィールドを持つYAMLファイルを作成する：

   docs:
      - url: my_collection
   

ユース・ケース・シナリオ

ユースケースシナリオでは、RAGがどのように機能し、インデックスが付けられたリポジトリやドキュメントからどのようにデータが検索されるかを説明する。