qstensils

• Ferramentas fornecidas
• Sobre a Amazon q
• Uso
• Segurança

Ferramentas fornecidas

Isenção de responsabilidade : os scripts fornecidos neste repositório refletem o estado do serviço Amazon Q para negócios, conforme foi lançado em dezembro de 2023 pela AWS no modo de visualização. Devido a esse modo de visualização, os recursos da Amazon Q e sua implementação podem mudar a qualquer momento durante a visualização e para a disponibilidade geral. Tais alterações podem exigir atualizações para este repositório.

Este projeto reúne diversas ferramentas e scripts de serviços públicos para explorar e operar a Amazon Q para os negócios. Adicionaremos novos scripts com base na sua demanda: fique à vontade para cortar um ingresso aqui se tiver uma necessidade ou ideia!

Atualmente, fornecemos os seguintes utilitários:

1. q_list_applications para inventariar os aplicativos existentes em uma determinada região de uma conta da AWS. A estrutura JSON retornada detalha os vários componentes (índices, fonte de dados, retrievers etc.) desses aplicativos da Amazon Q.
2. Q_LIST_DATA_SOURCE_SYNC_JOBS para listar o histórico dos trabalhos de sincronização de índice executados em uma determinada fonte de dados Q. Este script adiciona métrica adicional, como a duração total do trabalho, a taxa de varredura de documentos e a duração média da varredura por documento.
3. q_list_documents para listar todos os documentos de um índice da Amazon Q e obter todos os seus metadados associados, em particular seu status. A lista retornada pode ser filtrada (via inclusão ou exclusão) para retornar apenas uma fração desses documentos, por exemplo, com base no status de indexação.
4. Q_LIST_CONVERSAÇÕES Para obter toda a lista de todas as conversas anteriores entre um determinado aplicativo e um usuário, conforme lembrado pela Amazon Q.
5. Q_CHAT para poder script conversas (com base em mensagens únicas ou múltiplas) com o assistente da Amazon Q.

Todos esses scripts retornam estruturas JSON que podem ser processadas em pipelines de conchas com vários serviços públicos como JQ, Sed, Awk, etc.

Esses scripts confiam no Python AWS SDK. Todas as APIs relacionadas a Q para negócios são descritas em detalhes na documentação pública do SDK BOTO3.

Sobre a Amazon q

A Amazon Q é um assistente generativo e com energia generativa que pode ser configurado para responder a perguntas, fornecer resumos, gerar conteúdo e concluir tarefas com base em dados em sua empresa. A Amazon Q fornece informações imediatas e relevantes para seus usuários e ajuda a otimizar tarefas e acelerar a solução de problemas.

Um aplicativo da Amazon Q se baseia em um corpus de documentos para criar seu índice Q específico. Este corpus de documentos é armazenado em um ou mais repositórios de documentos (S3, JIRA, Quip etc.) chamados Q Fontes de dados. As respostas às perguntas do usuário do assistente serão preparadas através da alavancagem da tecnologia de trapos.

A geração de recuperação de recuperação (RAG) é uma técnica de processamento de linguagem natural (PNL). É composto por um sistema baseado em modelos de idiomas, geralmente um grande modelo de idioma (LLM), que acessa fontes de conhecimento externas para concluir tarefas. Isso permite mais contextualidade, consistência factual, melhora a confiabilidade das respostas geradas e ajuda a mitigar o problema das "alucinações".

Segurança

Os scripts deste projeto assumem que o usuário da AWS refletiu por variáveis ​​de ambiente chamadas AWS_ACCESS_KEY_ID e AWS_SECRET_ACCESS_KEY possuem credenciais IAM adequadas em termos de autorizações para acessar as APIs da Amazon Q na conta AWS. Consulte Exemplos de Política do IAM na seção de segurança da documentação Q para todos os detalhes.

Uso

No diretório /src deste projeto, os seguintes comandos podem ser usados ​​para obter todas as opções de comando

para 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

para 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

para 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

para 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