qstensils

• 提供されたツール
• AmazonについてQ
• 使用法
• 安全

提供されたツール

免責事項：このリポジトリで提供されているスクリプトは、2023年12月にAWSでプレビューモードで開始されたサービスのAmazon Qのサービス状態を反映しています。このプレビューモードにより、Amazon Qの機能とその実装は、プレビュー中および一般的な可用性のためにいつでも変更される可能性があります。このような変更には、このリポジトリの更新が必要になる場合があります。

このプロジェクトは、多様なツールとユーティリティスクリプトを収集して、Amazon Qをビジネス向けに調査および運用します。あなたの需要に基づいて新しいスクリプトを追加します：あなたが必要またはアイデアがあるならば、ここでチケットを自由にカットしてください！

現在、次のユーティリティを提供しています。

1. q_list_applications AWSアカウントの特定の地域に存在するアプリケーションをインベントリする。返されたJSON構造は、これらのAmazon Qアプリケーションのさまざまなコンポーネント（インデックス、データソース、レトリーバーなど）を詳述しています。
2. q_list_data_source_surce_jobs指定されたqデータソースで実行されたインデックス同期ジョブの履歴をリストします。このスクリプトには、総職務期間、ドキュメントスキャンレート、ドキュメントごとの平均スキャン期間などのメトリックが追加されます。
3. Q_List_Documents Amazon Qインデックスのすべてのドキュメントをリストし、関連するメタデータ、特にそのステータスをすべて取得します。返されたリストは（包含または除外を介して）フィルタリングして、たとえばインデックス作成ステータスに基づいてこれらのドキュメントのほんの一部のみを返すことができます。
4. q_list_conversations特定のアプリケーションとユーザーの間のすべての過去の会話のすべてのリストを取得するには、Amazon Q.
5. Q_Chat Amazon Qのアシスタントとの会話をスクリプト化できる（単一または複数のメッセージに基づく）

これらすべてのスクリプトは、JQ、SED、AWKなどのさまざまなユーティリティを備えたシェルパイプラインでさらに処理できるJSON構造を返します。

これらのスクリプトは、Python AWS SDKに依存しています。ビジネスのためのQに関連するすべてのAPIは、SDK Boto3公開文書で詳細に説明されています。

AmazonについてQ

Amazon Qは、完全に管理された生成パワーアシスタントであり、質問に回答し、要約を提供し、コンテンツを生成し、企業のデータに基づいて完全なタスクを構成できます。 Amazon Qは、ユーザーに即時かつ関連する情報を提供し、タスクの合理化と問題解決を加速するのに役立ちます。

Amazon Qアプリケーションは、特定のQインデックスを構築するためにドキュメントのコーパスに依存しています。このドキュメントのコーパスは、Qデータソースと呼ばれる1つ以上のドキュメントリポジトリ（S3、Jira、QUIPなど）に保存されています。アシスタントによるユーザーの質問への回答は、RAGテクノロジーのレバレッジを通じて作成されます。

検索された生成（RAG）は、自然言語処理（NLP）手法です。言語モデルベースのシステム、通常は大規模な言語モデル（LLM）で構成され、外部の知識ソースにアクセスしてタスクを完了します。これにより、より多くの文脈性、事実上の一貫性が可能になり、生成された応答の信頼性が向上し、「幻覚」の問題を軽減するのに役立ちます。

安全

このプロジェクトのスクリプトは、 AWS_ACCESS_KEY_IDとAWS_SECRET_ACCESS_KEYという名前の環境変数に反映されるAWSユーザーが、AWSアカウントのAmazon QのAPIにアクセスするための認可に関して適切なIAM資格情報を持っていると想定しています。すべての詳細については、QドキュメントのセキュリティセクションのIAMポリシーの例を参照してください。

使用法

このプロジェクトの /SRCディレクトリから、次のコマンドを使用してすべてのコマンドオプションを取得できます

list_applications.pyの場合

 %python3 q_list_applications.py -h
usage: q_list_applications.py [-h] [-v]

list applications, indexes, retrievers, web experiences, plugins, etc. running in Amazon Q for business

options:
  -h, --help     show this help message and exit
  -v, --verbose  verbose mode

q_list_data_source_sync_jobs

 % python3 q_list_data_source_sync_jobs.py -h
usage: q_list_data_source_sync_jobs.py [-h] [-a APP_ID] [-i IDX_ID] [-d DS_ID] [-v]

list synchronization jobs executed for a given data source of an Amazon Q application

options:
  -h, --help            show this help message and exit
  -a APP_ID, --app_id APP_ID
                        Q application id
  -i IDX_ID, --idx_id IDX_ID
                        Q data source id
  -d DS_ID, --ds_id DS_ID
                        Q data source id
  -v, --verbose         verbose mode

q_list_documents.pyの場合

 % python3 q_list_documents.py  -h                                                                                                   
usage: q_list_documents.py [-h] [-a APP_ID] [-i IDX_ID] [-incl INCLUDE] [-excl EXCLUDE] [-inv] [-v]

list documents indexed by Amazon Q

options:
  -h, --help            show this help message and exit
  -a APP_ID, --app_id APP_ID
                        Q application id
  -i IDX_ID, --idx_id IDX_ID
                        Q index id
  -incl INCLUDE, --include INCLUDE
                        comma-separated list of status to include
  -excl EXCLUDE, --exclude EXCLUDE
                        comma-separated list of status to exclude
  -inv, --inventory     with document inventory
  -v, --verbose         verbose mode

q_list_conversations.pyの場合

 % python3 q_list_conversations.py -h
usage: q_list_conversations.py [-h] [-a APP_ID] [-u USR_ID] [-v]

list documents indexed by Amazon Q

options:
  -h, --help            show this help message and exit
  -a APP_ID, --app_id APP_ID
                        Q application id
  -u USR_ID, --usr_id USR_ID
                        Q user id
  -v, --verbose         verbose mode

q_chat.pyの場合

 % python3 q_chat.py  -h
usage: q_chat.py [-h] [-a APP_ID] [-u USR_ID] [-p PROMPT] [-f FILE] [-c CNV_ID] [-m MSG_ID] [-d] [-v]

ask a question to a Q application and get answer

options:
  -h, --help            show this help message and exit
  -a APP_ID, --app_id APP_ID
                        Q application id
  -u USR_ID, --usr_id USR_ID
                        Q index id
  -p PROMPT, --prompt PROMPT
                        question prompt or path to file with list of prompts
  -f FILE, --file FILE  path to attachment file
  -c CNV_ID, --cnv_id CNV_ID
                        Q conversation id (only to continue an existing conversation)
  -m MSG_ID, --msg_id MSG_ID
                        Q parent message id (only to continue an existing conversation)
  -d, --details         full conversation details
  -v, --verbose         verbose mode