1. Propósito e Escopo
Este documento define todos os prompts, configurações de memória, transição entre estados e demais requisitos funcionais para o agente de IA "Diagnóstico de Erros em Chamadas de API". Essa documentação é um modelo de PRD ou Documento de Requisitos de Produto específicos para construção de Agentes de IA.
O objetivo principal é analisar logs de chamadas de API para identificar erros comuns e sugerir correções, facilitando a resolução de problemas técnicos e melhorando a eficiência do processo de desenvolvimento.
2. Contexto e Problema
Problemas Específicos
O agente deve resolver os seguintes problemas específicos e já conhecidos:
- Erros de comunicação entre sistemas ao realizar chamadas de API.
- Falhas na autenticação e autorização de chamadas de API.
- Dificuldades em identificar a origem de erros devido a logs extensos e complexos.
Regras para Resolução
- Analisar logs de chamadas de API para identificar padrões de erro comuns.
- Sugerir correções e ajustes com base nos erros identificados.
- Fornecer feedback em tempo real para desenvolvedores durante o processo de diagnóstico.
3. Impactos Esperados
A implementação deste agente de IA visa alcançar os seguintes resultados:
- Reduzir o tempo de diagnóstico de erros em chamadas de API.
- Aumentar a precisão na identificação de erros e suas origens.
- Melhorar a eficiência do processo de desenvolvimento ao fornecer sugestões de correção em tempo real.
- Facilitar a auditoria e rastreamento de erros para futuras análises e melhorias.
4. Visão Geral da Solução
O agente de IA para diagnóstico de erros em chamadas de API processa logs de chamadas de API, identifica padrões de erro e sugere correções em tempo real para desenvolvedores. A seguir são detalhadas todas as regras de negócio e especificações funcionais necessárias para que esse agente atue como um assistente eficiente e autônomo na resolução de problemas técnicos relacionados às chamadas de API.
A solução consiste em um único agente autônomo que analisa logs de chamadas de API e fornece feedback em tempo real.
5. Protótipos
Para proporcionar uma visão clara e tangível da solução proposta, criamos protótipos interativos que demonstram como o agente analisa logs e sugere correções. Explore os links abaixo para entender melhor a solução em ação.
6. Requisitos Funcionais
RF 1. Agente de Análise de Logs de Chamadas de API
1.1 Tarefa do Agente
Analisar logs de chamadas de API para identificar erros comuns e sugerir correções.
1.2 Prompt ou Instruções do Agente
# 1. Contexto e explicações sobre inputs iniciais Você está recebendo logs de chamadas de API em formato de texto ou arquivo .log. Esses logs contêm informações detalhadas sobre as interações entre sistemas e os erros ocorridos. # 2. Objetivo Analisar os logs para identificar padrões de erro comuns e sugerir correções específicas para cada erro. # 3. Regras que você deve seguir para gerar sua resposta - Identifique padrões de erro comuns nos logs de chamadas de API, como códigos de erro HTTP, falhas de autenticação e problemas de comunicação. - Para cada erro identificado, analise o contexto e forneça sugestões de correções específicas, incluindo ajustes de configuração e verificação de credenciais. - Forneça feedback em tempo real aos desenvolvedores, destacando os erros críticos que requerem atenção imediata. - Classifique os erros por frequência e impacto, priorizando aqueles que afetam a operação crítica do sistema. - Registre detalhes de cada erro, incluindo timestamp, endpoint afetado e usuário envolvido, para facilitar a auditoria e rastreamento futuro.
1.3 Configurações do Agente
1.3.1 Especificação do Input
- Mecanismo de Acionamento: Este agente deve ser acionado pelo envio de logs de chamadas de API em formato de texto ou arquivo .log via API. Na fase de testes, os logs podem ser enviados diretamente por upload na interface da Prototipe AI, para acelerar o processo de validação.
- Tipo do input: Logs de chamadas de API em formato de texto ou arquivo .log.
-
Formatos Suportados: Esse agente deve ser capaz de receber logs nos formatos:
.txt,.log. - Número de caracteres esperado: Este agente deve ter capacidade para processar um input de texto com até 100.000 caracteres.
1.3.2 Especificação do Output
- Formato de output: O output deve ser um texto formatado em **Markdown** com a lista de erros identificados e sugestões de correção para cada erro.
-
Exemplo de Estrutura de Output:
**Erros Identificados:** 1. Erro de autenticação (401 Unauthorized) no endpoint `/api/login`. * **Sugestão:** Verificar as credenciais de login e garantir que o token de acesso seja válido. 2. Erro de comunicação (503 Service Unavailable) no endpoint `/api/data`. * **Sugestão:** Verificar a disponibilidade do servidor e a integridade da conexão de rede.
- Número de caracteres esperado: O texto final deve ser conciso e informativo, com um tamanho estimado em torno de 5.000 caracteres, podendo variar conforme a complexidade dos logs analisados.
1.3.3 Parâmetros de Geração
- Modelo: GPT-5
- Temperatura: 0.6
1.3.4 Ferramentas do Agente
- Documentos: Não consulta documentos externos.
- Calculadora: Não utiliza.
- Busca Online: Não utiliza.
- Sistemas Externos: Não se conecta a sistemas externos.
1.3.5 Memória
- Visibilidade das Instruções (Prompt): As instruções deste agente não devem ser visíveis para nenhum agente subsequente.
- Visibilidade da Resposta: A resposta gerada por este agente é o entregável final e não precisa ser passada para outros agentes.
1.3.6 Regras de Orquestração e Transição
A execução deste agente finaliza o fluxo. O output gerado deve ser disponibilizado diretamente aos desenvolvedores para ação imediata.