Skip to content

Commit

Permalink
Merge pull request #97 from rukasakurai/5.internal-document-search/cl…
Browse files Browse the repository at this point in the history
…arify-permissions

5.internal document search: Clarify required permissions
  • Loading branch information
marumaru1019 authored Jan 15, 2024
2 parents 2cc3c42 + 4d57dc0 commit 38d511b
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions 5.internal-document-search/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,13 @@

デモアプリは以下のように動作します。

## Architecture
### Architecture
![RAG Architecture](assets/appcomponents.png)

## UI
### UI
![Chat screen](assets/chatscreen.png)

## セットアップガイド

> **重要:** このサンプルをデプロイするには、**Azure Open AI サービスが有効になっているサブスクリプションが必要です**。Azure Open AI サービスへのアクセス申請は[こちら](https://aka.ms/oaiapply)から行ってください。
### 事前準備

#### クラウド実行環境
### クラウド実行環境
このデモをデプロイすると以下のリソースが Azure サブスクリプション上に作成されます。
| サービス名 | SKU | Note |
| --- | --- | --- |
Expand All @@ -32,6 +26,14 @@
|Azure Application Insights||ワークスペース ベース|
|Azure Log Analytics|||

## セットアップガイド
### 事前準備
**重要:** このサンプルをデプロイするには、
- **Azureサブスクリプション**: Azure Open AI サービスが有効になっているサブスクリプションが必要です。Azure Open AI サービスへのアクセス申請は[こちら](https://aka.ms/oaiapply)から行ってください。
- **Azure権限**:
- Microsoft.Authorization/roleAssignments/write 権限が必要です。例えば、[Role Based Access Control Administrator](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#role-based-access-control-administrator-preview)[User Access Administrator](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#user-access-administrator)、 または [Owner](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#owner)のような権限が必要です。
- Azure アカウントにはサブスクリプションレベルで Microsoft.Resources/deployments/write 権限も必要です。例えば、[Contributor](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#contributor)、または [Owner](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#owner)のような権限が必要です。

#### ローカル開発環境
このデモをデプロイするためには、ローカルに以下の開発環境が必要です。
> **重要** このサンプルは Windows もしくは Linux 環境で動作します。ただし、WSL2 の環境では正常に動作しません。
Expand Down Expand Up @@ -177,4 +179,4 @@ PoC/検証等の目的で小さく始めた後に、本番稼働を視野にい
生成AIの「良さ」や「精度」を一様に評価するのは困難ではありますが、以下の様なことを考慮すると、エンドユーザの検索結果に対する満足度を高めることができる可能性があります。
- **PDFファイルの分割方法**: 本サンプルでは与えられたPDFを機械的にページ単位で分割していますが。PDFファイルの分割方法の改善することにより検索結果の良さを高めることができる可能性があります。
- **画像・複雑な図表・PDF以外のファイルフォーマットの扱い**: 本サンプルはPDFファイルの扱いを前提としており、画像や複雑な図表を検索結果で活用することはできません。画像・複雑な図表・PDF以外のファイルフォーマットの扱いも重要なユースケースの場合、ナレッジベース設計を見直す必要がある可能性があります。
- **各モデルの最大トークン数による制約**: 本サンプルの文書検索の結果から返答を作成する過程において、最大トークン数の制約から文書の1024トークンのみを利用しています。この制約により、文書の内容を十分に活用できていない可能性があります。この制約を緩和することにより、検索結果の精度を高めることができる可能性があります。
- **各モデルの最大トークン数による制約**: 本サンプルの文書検索の結果から返答を作成する過程において、最大トークン数の制約から文書の1024トークンのみを利用しています。この制約により、文書の内容を十分に活用できていない可能性があります。この制約を緩和することにより、検索結果の精度を高めることができる可能性があります。

0 comments on commit 38d511b

Please sign in to comment.