qstensils

• Предоставлены инструменты
• Об Amazon Q.
• Использование
• Безопасность

Предоставлены инструменты

Отказ от ответственности : сценарии, представленные в этом хранилище, отражают состояние обслуживания Amazon Q для бизнеса, как он был запущен в декабре 2023 года AWS в режиме предварительного просмотра. Из -за этого режима предварительного просмотра функции Amazon Q и их реализации могут измениться в любое время во время предварительного просмотра и для общей доступности. Такие изменения могут потребовать обновления этого репозитория.

Этот проект собирает разнообразные инструменты и коммунальные сценарии для изучения и эксплуатации Amazon Q для бизнеса. Мы добавим новые сценарии на основе вашего спроса: не стесняйтесь вырезать билет здесь, если у вас есть потребность или идея!

В настоящее время мы предоставляем следующие утилиты:

1. q_list_applications для инвентаризации приложений, существующих в данной области учетной записи AWS. Возвращенная структура JSON подробно описывает различные компоненты (индексы, источник данных, ретриверы и т. Д.) Эти приложения Amazon Q.
2. Q_LIST_DATA_SOURCE_SYNC_JOBS Перечислить историю заданий синхронизации индекса, выполненных на данном источнике данных. Этот скрипт добавляет дополнительную метрику, например, общую продолжительность работы, скорость сканирования документов и средняя продолжительность сканирования на документ.
3. Q_List_documents, чтобы перечислить все документы индекса Amazon Q и получить все их связанные метаданные, в частности, их статус. Возвращенный список может быть отфильтрован (через включение или исключение), чтобы вернуть только часть этих документов, например, на основе их статуса индексации.
4. Q_List_conversations для получения всех списков всех прошлых разговоров между данным приложением и пользователем, как это помнило Amazon Q.
5. Q_CHAT, чтобы иметь возможность сценария разговоров (на основе отдельных или нескольких сообщений) с помощником Amazon Q.

Все эти сценарии возвращают структуры JSON, которые могут быть дополнительно обработаны в трубопроводах Shell с различными коммунальными услугами, такими как JQ, SED, AWK и т. Д.

Эти сценарии полагаются на Python AWS SDK. Все API, связанные с Q для бизнеса, подробно описаны в публичной документации SDK Boto3.

Об Amazon Q.

Amazon Q-это полностью управляемый, Generative-Ai Assistant, который можно настроить, чтобы ответить на вопросы, предоставление резюме, создания контента и выполнения задач на основе данных на вашем предприятии. Amazon Q предоставляет немедленную и соответствующую информацию своим пользователям и помогает упростить задачи и ускорить решение проблем.

Приложение Amazon Q опирается на корпус документов для создания своего конкретного индекса Q. Этот корпус документов хранится в одном или нескольких репозиториях документа (S3, JIRA, QUIP и т. Д.), Относится к источникам данных Q. Ответы на вопросы пользователя помощника будут подготовлены с помощью рычага технологии RAG.

Поизводимый поколение (RAG)-это метод обработки естественного языка (NLP). Он состоит из системы на основе языковой модели, обычно большой языковой модели (LLM), которая обращается к источникам внешних знаний для выполнения задач. Это обеспечивает большую контекстуальность, фактическую согласованность, повышает надежность генерируемых ответов и помогает смягчить проблему «галлюцинаций».

Безопасность

Сценарии этого проекта предполагают, что пользователь AWS, отраженные переменными среды с именем AWS_ACCESS_KEY_ID , и AWS_SECRET_ACCESS_KEY имеет правильные учетные данные с точки зрения разрешений для доступа к API Amazon Q в учетной записи AWS. См. Примеры политики 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_DOCUNTIONS.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