# Retriever設定

ダッシュボードでRetrieverのパフォーマンス改善機能をご利用いただけます。

Retrieverとは、質問に対して関連性のあるドキュメントを取り出す役割を果たしています。

Retriever設定では、アップロードした文書とユーザーの質問の類似性を高めるようにモデルをトレーニングしたり、プロジェクトにアップロードされている文書と質問タイプに合わせてRAGの最適な設定をすることができる機能です。Retrieverの性能向上により、より正確な回答を生成することができます。

この機能を使用するためには、まずナレッジベース＞ Retrieverの設定タブに移動し、「Retrieverのパフォーマンス改善」ボタンをクリックしてください。

<figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2FMwKbSIw7eh0UA2r34w6I%2F%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88%202024-10-21%2017.48.03.png?alt=media&#x26;token=bf8a49ca-7ae5-4b66-ac91-d281d2ae894d" alt=""><figcaption></figcaption></figure>

Retrieverのパフォーマンス改善は直接ファイルをアップロードし、リクエストボタンを押していただければ完了です。

パフォーマンス改善のリクエスト後にAllganize担当者によって実行され、実行結果による性能改善度は最終レポート「ダウンロード」を通じて確認することができます。

## 1.Retrieverのトレーニング <a href="#retriever-training" id="retriever-training"></a>

レトリーバートレーニングは、アップロードした文書とユーザーの質問の類似性を高めるようにモデルをトレーニングする機能です。

この機能は、与えられた文書セットを理解し、ユーザーの質問に適した文書を見つけるモデルを訓練します。これにより、ユーザーが求める情報をより正確に検索し、効果的に活用できるようになります。

<mark style="color:red;">**※パフォーマンス改善のリクエスト時に、トレーニングもONにした場合、データ数によっては完了までに日数を要しますのでご注意ください。またトレーニングにはクレジットが消費されます。**</mark>

<figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2FF6XsV3FEqterYwv0ZlvR%2F%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88%202024-10-21%2017.51.32.png?alt=media&#x26;token=d542989e-d15c-43dd-a7ec-db2e491ad1ff" alt=""><figcaption></figcaption></figure>

## 2.Retrieverの最適化 <a href="#retriever-optimization" id="retriever-optimization"></a>

Retrieverの最適化は、プロジェクトにアップロードされている文書と質問に合わせてRAGの最適な重みを見つけることができる機能です。最適化のみを実施する場合、RetrieverのトレーニングはOFFにし、直接アップロードでデータを入力し、リクエストボタンを押してください。

パフォーマンス改善のリクエスト後に、Allganize担当者によって「回答の根拠となったドキュメントに付与されたフィードバック」とアップロードされたデータセットを利用して最適化が実行され、実行結果による性能改善度は最終レポート「ダウンロード」を通じて確認することができます。

#### **「回答の根拠となったドキュメントに付与されたフィードバック」**

会話履歴から管理画面にログインできるメンバーが回答の根拠となるページに対してフィードバックを与えた履歴を集計したデータです。\
直接アップロードするデータセットと一緒に最適化が実行されますので、より多くの精度向上を望めます。

<figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2F36io5AsKGzttzF3igQ1x%2F%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88%202024-10-21%2017.53.05.png?alt=media&#x26;token=a540fe28-ab17-446e-a596-fd22088af0cf" alt=""><figcaption></figcaption></figure>

### 2-1.データセットのアップロード <a href="#dataset" id="dataset"></a>

'サンプルファイルをダウンロード'を通じて、どのような内容のファイルをアップロードすべきかテストデータを確認することができます。サポートしているファイル形式はxls、xlsx、csvです。

<figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2FQo9jndC0fMCl2aj9qmEn%2F%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88%202024-10-21%2017.56.45.png?alt=media&#x26;token=0e056b84-8ec8-45e4-8823-24b5ba22d46a" alt=""><figcaption></figcaption></figure>

ファイルの基本構成は、\
①質問\
②質問に該当する回答を含むファイル名(ファイルの拡張子含む)\
③ページ番号\
で構成されています。 \
同じ質問に対して3つの文書が存在する場合には、質問と該当のドキュメントを3行に分けて記載してください。

<figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2FLU8OmWylh36Er5BequVH%2Fimage.png?alt=media&#x26;token=5099bc18-9da4-4139-ba83-23826a933664" alt=""><figcaption></figcaption></figure>

## 3.追加データを生成 <a href="#additionaldata" id="additionaldata"></a>

データセットの数は**50個以上作成**することを推奨します。\
データセットが少ない場合には、このオプションを使用してLLMモデルを使用してアップロードされたデータ+集計されたフィードバックデータと同様のパターンの質問データセットを自動的に生成することができます。\
**ただし、このオプションを使用する場合は、追加クレジットが発生します。**

※データセットの数が50個未満でも最適化リクエストは可能ですが、データが多ければ多いほどRetrieverの最適化に良い影響を与えます。

<figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2FHjLT1LYd6OjrGZz9yt6W%2Fimage.png?alt=media&#x26;token=9508f8fb-53f3-48c7-90b8-7ea28ec42ff7" alt=""><figcaption></figcaption></figure>

### 最適化のリクエストを出す <a href="#request-optimization" id="request-optimization"></a>

実際に最適化リクエストをしてみましょう。

データセットファイルをアップロードした後(Retrieverの最適化のみの場合はトレーニング機能はOFF)、'次へ'ボタンを押すと

<figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2FIkbafMbN2zKKyIFuOTrd%2F%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88%202024-10-22%209.17.53.png?alt=media&#x26;token=e3873986-6466-4ce9-8af8-126bf349e483" alt=""><figcaption></figcaption></figure>

1. トレーニングデータ数(ONにしてリクエストした場合はデータ数が表示される)
2. 集計されたフィードバックデータ数
3. アップロードされたデータセットファイル名
4. 必要な推定クレジット

が表示されます。内容を確認した後、「OK」ボタンを押すと

<figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2FpsV0cF3WTI6gbRB6129i%2F%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88%202024-10-22%209.23.20.png?alt=media&#x26;token=475e8a74-8601-4210-9986-a4613f3d425a" alt=""><figcaption></figcaption></figure>

最適化リクエストが完了します。リクエストを行った後、担当のカスタマーサクセスへ、リクエストを送信した旨をご連絡ください。その後カスタマーサクセス担当がRetrieverの最適化作業を行います。この作業には2～3営業日かかる場合があります。

最適化リクエスト後のダッシュボード上でのキャンセルはできませんので、キャンセルをご希望の場合もカスタマーサクセス担当者にご連絡ください。

<figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2FdpcmRfkUZgJirwdEVEdr%2F%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88%202024-10-22%209.26.37.png?alt=media&#x26;token=ba03c278-4ed3-4ae4-9c42-f2248038b6a2" alt=""><figcaption></figcaption></figure>

### Retriverの最適化後 <a href="#after-optimization" id="after-optimization"></a>

最適化が完了した後は以下のような画面が表示されます。

<figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2FmdJIgGue1u3Z2wWfI8n8%2F%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88%202024-10-22%209.28.17.png?alt=media&#x26;token=18e552d7-c572-4003-96ea-bb3e3c6f90f1" alt=""><figcaption></figcaption></figure>

1. 最適化を要求したバージョンが表示されます。1次最適化後、追加最適化を要請した時は、V1 > V2 > V3のようにバージョンがアップグレードされて表示されます。
2. 最適化リクエストを送信した時刻が表示されます
3. トレーニングに使われたページ数が表示されます
4. アップロードしたデータセットのファイル名が表示されます
5. 反映されたフィードバックデータの数が表示されます
6. 実際の最適化が完了した時刻が表示され、最適化前の精度と最適化後の精度を確認することができます。さらに ダウンロードボタンから最終レポートを受け取ることができます。

改善作業が完了すると、ダッシュボードで最適化前と最適化後のパフォーマンスを一目で比較することができ、5. 最適化の結果をダウンロードすることで、レトリーバーのどの部分が改善されたかを把握することができます。

### レポート内容 <a href="#report" id="report"></a>

最終レポートには、

①最終精度、変化した設定値

<figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2FCnCRmwulUTyVnAaTZAea%2Fimage.png?alt=media&#x26;token=9905f9e1-fdf7-4675-98d8-f67423326cd0" alt=""><figcaption></figcaption></figure>

②使用されたデータ数

<figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2FtJf3R0G73Ovqn5ui8fo0%2Fimage.png?alt=media&#x26;token=6ca789dd-82fb-451b-834a-385b1283032e" alt=""><figcaption></figcaption></figure>

④実際のデータセットが含まれます

<figure><img src="https://3244404108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FR2CRA2CisD1pVQUgqd1g%2Fuploads%2FrPaLz2zmU2vPDH3c9G2S%2Fimage.png?alt=media&#x26;token=e89e960f-e61a-4569-a5ac-d33b2cff763e" alt=""><figcaption></figcaption></figure>

生成型回答の正確な性能評価と改善度は実際のチャット画面上で確認してください。


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.allganize.ai/alli-llm-app-market/knowledge-base/retriever-setting.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
