qstensils

• Alat yang disediakan
• Tentang Amazon q
• Penggunaan
• Keamanan

Alat yang disediakan

Penafian : Skrip yang disediakan dalam repositori ini mencerminkan keadaan Amazon Q untuk bisnis seperti yang diluncurkan pada Desember 2023 oleh AWS dalam mode pratinjau. Karena mode pratinjau ini, fitur Amazon Q dan implementasinya dapat berubah kapan saja selama pratinjau dan untuk ketersediaan umum. Perubahan tersebut mungkin memerlukan pembaruan untuk repositori ini.

Proyek ini mengumpulkan beragam alat dan skrip utilitas untuk mengeksplorasi dan mengoperasikan Amazon Q untuk bisnis. Kami akan menambahkan skrip baru berdasarkan permintaan Anda: jangan ragu untuk memotong tiket di sini jika Anda memiliki kebutuhan atau ide!

Kami saat ini memberikan utilitas berikut:

1. Q_LIST_APPLIKASI Untuk menginventarisasi aplikasi yang ada di wilayah tertentu dari akun AWS. Struktur JSON yang dikembalikan merinci berbagai komponen (indeks, sumber data, retriever, dll.) Dari aplikasi Amazon Q tersebut.
2. Q_LIST_DATA_SOURCE_SYNC_JOBS untuk mencantumkan sejarah pekerjaan sinkronisasi indeks yang dieksekusi pada sumber data Q yang diberikan. Skrip ini menambahkan metrik tambahan seperti durasi pekerjaan total, tingkat pemindaian dokumen dan durasi pemindaian rata -rata per dokumen.
3. Q_List_Documents untuk mencantumkan semua dokumen indeks Amazon Q dan mendapatkan semua metadata yang terkait, khususnya status mereka. Daftar yang dikembalikan dapat disaring (melalui inklusi atau pengecualian) untuk mengembalikan hanya sebagian kecil dari dokumen -dokumen tersebut misalnya berdasarkan status pengindeksan mereka.
4. Q_LIST_CONVERSATIONS untuk mendapatkan semua daftar semua percakapan masa lalu antara aplikasi yang diberikan dan pengguna seperti yang diingat oleh Amazon Q.
5. Q_Chat untuk dapat skrip percakapan (berdasarkan pesan tunggal atau berganda) dengan asisten Amazon Q.

Semua skrip itu mengembalikan struktur JSON yang dapat diproses lebih lanjut dalam pipa shell dengan berbagai utilitas seperti JQ, SED, AWK, dll.

Skrip -skrip itu bergantung pada Python AWS SDK. Semua API yang terkait dengan Q untuk bisnis dijelaskan secara rinci dalam dokumentasi publik SDK Boto3.

Tentang Amazon q

Amazon Q adalah asisten bertenaga yang sepenuhnya dikelola, generatif yang dapat dikonfigurasi untuk menjawab pertanyaan, memberikan ringkasan, menghasilkan konten, dan menyelesaikan tugas berdasarkan data di perusahaan Anda. Amazon Q memberikan informasi langsung dan relevan kepada penggunanya, dan membantu merampingkan tugas dan mempercepat pemecahan masalah.

Aplikasi Amazon Q bergantung pada korpus dokumen untuk membangun indeks Q spesifiknya. Korpus dokumen ini disimpan dalam satu atau lebih repositori dokumen (S3, JIRA, SUIP, dll.) Disebut sumber data Q. Jawaban atas pertanyaan pengguna oleh asisten akan disiapkan melalui leverage teknologi RAG.

Retrieval-Augmented Generation (RAG) adalah teknik pemrosesan bahasa alami (NLP). Ini terdiri dari sistem berbasis model bahasa, biasanya model bahasa besar (LLM), yang mengakses sumber pengetahuan eksternal untuk menyelesaikan tugas. Hal ini memungkinkan lebih banyak kontekstualitas, konsistensi faktual, meningkatkan keandalan respons yang dihasilkan, dan membantu mengurangi masalah "halusinasi".

Keamanan

Script dari proyek ini mengasumsikan bahwa pengguna AWS yang tercermin oleh variabel lingkungan bernama AWS_ACCESS_KEY_ID dan AWS_SECRET_ACCESS_KEY memiliki kredensial IAM yang tepat dalam hal otorisasi untuk mengakses API Amazon Q di akun AWS. Lihat contoh kebijakan IAM di bagian keamanan dokumentasi Q untuk semua detail.

Penggunaan

Dari direktori /src proyek ini, perintah berikut dapat digunakan untuk mendapatkan semua opsi perintah

untuk 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

untuk 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

untuk 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

untuk 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