qstensils

• Outils fournis
• À propos d'Amazon Q
• Usage
• Sécurité

Outils fournis

Avertissement : Les scripts fournis dans ce référentiel reflètent l'état de service Amazon Q pour les affaires lors de son lancement en décembre 2023 par AWS en mode prévisualisation. En raison de ce mode d'aperçu, les fonctionnalités d'Amazon Q et de leur implémentation peuvent changer à tout moment pendant l'aperçu et pour la disponibilité générale. Ces modifications peuvent nécessiter des mises à jour de ce référentiel.

Ce projet rassemble divers outils et scripts utilitaires pour explorer et explorer Amazon Q pour les entreprises. Nous ajouterons de nouveaux scripts en fonction de votre demande: n'hésitez pas à couper un billet ici si vous avez un besoin ou une idée!

Nous fournissons actuellement les services publics suivants:

1. Q_LIST_APPLATIONS Pour inventaire les applications existant dans une région donnée d'un compte AWS. La structure JSON renvoyée détaille les différents composants (indices, source de données, retrievers, etc.) de ces applications Amazon Q.
2. Q_LIST_DATA_SOURCE_SYNC_JOBS Pour répertorier l'historique des travaux d'index de synchronisation exécutés sur une source de données Q donnée. Ce script ajoute une métrique supplémentaire comme la durée totale du travail, le taux de balayage de document et la durée moyenne de numérisation par document.
3. Q_List_Documents pour répertorier tous les documents d'un index Amazon Q et obtenir toutes leurs métadonnées associées, en particulier leur statut. La liste renvoyée peut être filtrée (via l'inclusion ou l'exclusion) pour retourner une fraction de ces documents par exemple en fonction de leur statut d'indexation.
4. Q_List_Conversations Pour obtenir toute la liste de toutes les conversations passées entre une application donnée et un utilisateur, comme l'observait Amazon Q.
5. Q_Chat pour pouvoir scripter des conversations (basées sur des messages uniques ou multiples) avec l'assistant d'Amazon Q.

Tous ces scripts renvoient les structures JSON qui peuvent être traitées davantage dans des pipelines de coquille avec divers utilitaires comme JQ, SED, AWK, etc.

Ces scripts reposent sur le SDK Python AWS. Toutes les API liées à Q pour les entreprises sont décrites en détail dans la documentation publique SDK Boto3.

À propos d'Amazon Q

Amazon Q est un assistant entièrement géré et générateur-AI qui peut être configuré pour répondre aux questions, fournir des résumés, générer du contenu et effectuer des tâches en fonction des données de votre entreprise. Amazon Q fournit des informations immédiates et pertinentes à ses utilisateurs, et aide à rationaliser les tâches et à accélérer la résolution de problèmes.

Une application Amazon Q s'appuie sur un corpus de documents pour construire son index Q spécifique. Ce corpus de documents est stocké dans un ou plusieurs référentiels de documents (S3, Jira, Quip, etc.) appelés Q Sources de données. Les réponses aux questions des utilisateurs par l'assistant seront préparées grâce à l'effet de levier de la technologie des chiffons.

La génération de la récupération (RAG) est une technique de traitement du langage naturel (NLP). Il est composé d'un système basé sur des modèles de langage, généralement un modèle grand langage (LLM), qui accède aux sources de connaissances externes pour effectuer des tâches. Cela permet plus de contextualité, de cohérence factuelle, améliore la fiabilité des réponses générées et aide à atténuer le problème des "hallucinations".

Sécurité

Les scripts de ce projet supposent que l'utilisateur AWS reflété par les variables d'environnement nommé AWS_ACCESS_KEY_ID et AWS_SECRET_ACCESS_KEY a des informations d'identification IAM appropriées en termes d'autorisations pour accéder aux API d'Amazon Q dans le compte AWS. Voir les exemples de politique IAM dans la section de sécurité de la documentation Q pour tous les détails.

Usage

À partir du répertoire / src de ce projet, les commandes suivantes peuvent être utilisées pour obtenir toutes les options de commande

pour 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

pour 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

pour 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

pour 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