qstensils

• Bereitete Werkzeuge
• Über Amazon q
• Verwendung
• Sicherheit

Bereitete Werkzeuge

Haftungsausschluss : Die in diesem Repository bereitgestellten Skripte spiegeln den Service des Dienstes Amazon Q für Unternehmen wider, wie es im Dezember 2023 von AWS im Vorschaudermodus gestartet wurde. Aufgrund dieses Vorschau -Modus können sich die Funktionen von Amazon Q und deren Implementierung jederzeit während der Vorschau und zur allgemeinen Verfügbarkeit ändern. Solche Änderungen erfordern möglicherweise Aktualisierungen dieses Repositorys.

Dieses Projekt sammelt verschiedene Tools und Versorgungsskripte, um Amazon Q für Unternehmen zu erkunden und zu betreiben. Wir werden neue Skripte hinzufügen, die auf Ihrer Forderung basieren: Sie können hier ein Ticket abschneiden, wenn Sie einen Bedarf oder eine Idee haben!

Wir bieten derzeit die folgenden Dienstprogramme:

1. q_list_applications, um die in einer bestimmten Region eines AWS -Konto vorhandenen Anwendungen zu inventarisieren. Die zurückgegebene JSON -Struktur beschreibt die verschiedenen Komponenten (Indizes, Datenquelle, Retriever usw.) dieser Amazon Q -Anwendungen.
2. Q_LIST_DATA_SOURCE_SYNC_JOBS, um den Verlauf der Indexsynchronisierungsjobs aufzulisten, die auf einer bestimmten Q -Datenquelle ausgeführt wurden. Dieses Skript fügt zusätzliche Metrik wie Gesamtauftragsdauer, Dokumentenscrate und durchschnittliche Scandauer pro Dokument hinzu.
3. q_list_documents, um alle Dokumente eines Amazon Q -Index aufzulisten und alle zugehörigen Metadaten zu erhalten, insbesondere ihres Status. Die zurückgegebene Liste kann (über Inklusion oder Ausschluss) gefiltert werden, um beispielsweise nur einen Bruchteil dieser Dokumente zurückzugeben, basierend auf ihrem Indexierungsstatus.
4. q_list_conversations, um alle Liste aller früheren Konversationen zwischen einer bestimmten Anwendung und einem Benutzer zu erhalten, wie von Amazon Q.
5. q_chat in der Lage sein, Gespräche (basierend auf einzelnen oder mehreren Nachrichten) mit dem Assistenten von Amazon Q.

Alle diese Skripte geben JSON -Strukturen zurück, die in Shell -Pipelines mit verschiedenen Dienstprogrammen wie JQ, SED, AWK usw. weiter verarbeitet werden können.

Diese Skripte stützen sich auf das Python AWS SDK. Alle APIs, die sich mit Q für das Geschäft beziehen, werden in der öffentlichen Dokumentation von SDK Boto3 ausführlich beschrieben.

Über Amazon q

Amazon Q ist ein vollständig verwalteter Assistent für generativ-ai-betriebene Assistent, der konfiguriert werden kann, um Fragen zu beantworten, Zusammenfassungen bereitzustellen, Inhalte zu generieren und Aufgaben basierend auf Daten in Ihrem Unternehmen zu erledigen. Amazon Q bietet seinen Benutzern unmittelbare und relevante Informationen und hilft bei der Straffung von Aufgaben und Beschleunigung der Problemlösung.

Eine Amazon Q -Anwendung basiert auf einem Korpus von Dokumenten, um seinen spezifischen Q -Index zu erstellen. Dieser Dokorkorpus wird in einem oder mehreren Dokument -Repositories (S3, JIRA, Quip usw.) gespeichert, die als Q -Datenquellen bezeichnet werden. Die Antworten auf Benutzerfragen des Assistenten werden durch die Hebelwirkung der Lagentechnologie vorbereitet.

RELUVALA-AUGmented Generation (RAG) ist eine NLP-Technik (Natural Language Processing). Es besteht aus einem sprachmodellbasierten System, in der Regel ein großes Sprachmodell (LLM), das auf externe Wissensquellen zugreift, um Aufgaben zu erledigen. Dies ermöglicht mehr Kontextualität, sachliche Konsistenz, verbessert die Zuverlässigkeit der generierten Antworten und hilft, das Problem der "Halluzinationen" zu mildern.

Sicherheit

In den Skripten dieses Projekts geht davon aus, dass der AWS -Benutzer, der in den Umgebungsvariablen mit dem Namen AWS_ACCESS_KEY_ID reflektiert wird, und AWS_SECRET_ACCESS_KEY enthält ordnungsgemäße IAM -Anmeldeinformationen in Bezug auf Autorisierungen, um auf die API von Amazon Q im AWS -Konto zuzugreifen. In den Beispielen der IAM -Richtlinien im Abschnitt Sicherheitsabschnitt der Q -Dokumentation finden Sie alle Details.

Verwendung

Aus dem Verzeichnis /src dieses Projekts können die folgenden Befehle verwendet werden, um alle Befehlsoptionen zu erhalten

für 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

für 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

für 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

für 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