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 Fluxo de Agentes "Relatórios de Desempenho de Integrações de API", uma solução de automação projetada para monitorar e gerar relatórios detalhados sobre o desempenho das integrações 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 é fornecer visibilidade em tempo real sobre o desempenho das integrações de API, identificando áreas de melhoria e destacando métricas-chave de sucesso para facilitar a tomada de decisões informadas pelas equipes responsáveis.
2. Contexto e Problema
Cenário Atual
Atualmente, as equipes enfrentam desafios significativos devido à falta de visibilidade em tempo real sobre o desempenho das integrações de API. Isso resulta na dificuldade de identificar áreas de melhoria e na ausência de métricas-chave para avaliar o sucesso das integrações.
Problemas Identificados
- Falta de visibilidade: As equipes carecem de informações em tempo real sobre o desempenho das integrações de API, dificultando a identificação de problemas e a otimização contínua.
- Dificuldade em identificar melhorias: Sem dados estruturados e relatórios detalhados, as áreas de melhoria nas integrações existentes passam despercebidas.
- Ausência de métricas-chave: A falta de métricas claras que avaliem o sucesso das integrações impede a medição precisa da eficiência e eficácia das soluções implementadas.
3. Impactos Esperados
A implementação deste fluxo de automação visa alcançar os seguintes resultados:
- Proporcionar visibilidade em tempo real sobre o desempenho das integrações de API.
- Identificar e documentar áreas de melhoria com base em dados estruturados e relatórios detalhados.
- Destacar métricas-chave de sucesso que permitam uma avaliação precisa da eficiência das integrações.
- Fornecer insights acionáveis para suportar decisões informadas pelas equipes responsáveis.
4. Visão Geral da Solução
O agente de IA para relatórios de desempenho de integrações de API monitora continuamente as integrações, gera relatórios detalhados com métricas de desempenho e destaca áreas de melhoria. 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 útil e autônomo na otimização das integrações de API.
A solução consiste em um fluxo de automação composto por 2 agentes de IA. O processo inicia com o monitoramento contínuo das integrações de API e culmina na geração de relatórios detalhados sobre o desempenho.
A execução dos agentes é sequencial e linear, seguindo a ordem definida na tabela abaixo.
| Agentes | Função Principal |
|---|---|
Agente de Monitoramento de Desempenho de Integrações de API (RF 1)
| Monitorar continuamente o desempenho das integrações de API. |
Agente de Geração de Relatórios de Desempenho de API (RF 2)
| Gerar relatórios detalhados sobre o desempenho das integrações de API. |
5. Protótipos
Para proporcionar uma visão clara e tangível da solução proposta, criamos protótipos interativos que demonstram tanto o fluxo de trabalho dos agentes quanto o resultado final que o cliente receberá. Explore os links abaixo para entender melhor a solução em ação.
6. Requisitos Funcionais
RF 1. Agente de Monitoramento de Desempenho de Integrações de API
1.1 Tarefa do Agente
Monitorar continuamente o desempenho das integrações de API, capturando métricas em tempo real como latência, taxa de erro e tempo de resposta.
1.2 Prompt ou Instruções do Agente
# 1. Contexto e explicações sobre inputs iniciais Você está configurando o monitoramento contínuo para integrações de API. Este processo envolve capturar e analisar métricas de desempenho em tempo real. # 2. Objetivo Monitorar continuamente o desempenho das integrações de API, capturando métricas em tempo real como latência, taxa de erro e tempo de resposta. # 3. Regras que você deve seguir para gerar sua resposta - Configure o monitoramento em tempo real para capturar latência, taxa de erro e tempo de resposta de cada chamada de API. - Analise continuamente os dados coletados para identificar padrões de desempenho e anomalias. - Gere alertas automáticos para quedas de desempenho significativas, definindo limiares para cada métrica monitorada. - Mantenha um histórico completo e acessível de logs para auditoria e análise detalhada posterior. # 4. Exemplo de Output que você deve produzir **Métricas Capturadas:** - Latência: 120ms - Taxa de Erro: 0.5% - Tempo de Resposta: 250ms **Alertas Gerados:** - Queda de desempenho detectada na API X.
1.3 Configurações do Agente
1.3.1 Especificação do Input
- Mecanismo de Acionamento: Este agente é o ponto de partida do fluxo e deve ser acionado pelo envio de parâmetros de configuração para monitoramento contínuo de APIs via API. Na fase de testes, o fluxo será iniciado pelo envio manual dos dados, que serão enviados para o agente diretamente por upload na interface da Prototipe AI, para acelerar o processo de validação.
- Tipo do input: Parâmetros de configuração para monitoramento contínuo de APIs.
-
Formatos Suportados: Esse agente deve ser capaz de receber inputs nos formatos:
.json. - Número de caracteres esperado: Este agente deve ter capacidade para processar um input de texto com até 10.000 caracteres.
1.3.2 Especificação do Output
- Formato de output: O output deve ser um texto formatado em **Markdown** listando as métricas capturadas e os alertas gerados.
-
Exemplo de Estrutura de Output:
**Métricas Capturadas:** - Latência: 120ms - Taxa de Erro: 0.5% - Tempo de Resposta: 250ms **Alertas Gerados:** - Queda de desempenho detectada na API X.
- Número de caracteres esperado: O texto final deve ser conciso e informativo, com um tamanho estimado em torno de 2.000 caracteres.
1.3.3 Parâmetros de Geração
- Modelo: GPT-5
- Temperatura: 0.3
1.3.4 Ferramentas do Agente
- Documentos: Não consulta documentos externos.
- Calculadora: Utiliza lógica interna para determinar alertas com base em limiares definidos.
- 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 deve ser visível para o Agente de Geração de Relatórios de Desempenho de API (RF 2).
1.3.6 Regras de Orquestração e Transição
Ao concluir sua execução, esse agente aciona o Agente de Geração de Relatórios de Desempenho de API (RF 2).
RF 2. Agente de Geração de Relatórios de Desempenho de API
2.1 Tarefa do Agente
Gerar relatórios detalhados sobre o desempenho das integrações de API, destacando métricas de sucesso e áreas de melhoria.
2.2 Prompt ou Instruções do Agente
# 1. Contexto e explicações sobre inputs iniciais Você está recebendo dados de desempenho coletados pelo Agente de Monitoramento de Desempenho de Integrações de API. # 2. Objetivo Gerar relatórios detalhados sobre o desempenho das integrações de API, destacando métricas de sucesso e áreas de melhoria. # 3. Regras que você deve seguir para gerar sua resposta - Compile dados de desempenho em relatórios estruturados, destacando métricas como tempo médio de resposta, taxa de erro e disponibilidade. - Identifique e documente áreas de melhoria potencial, sugerindo otimizações baseadas em tendências observadas. - Destaque métricas-chave de sucesso que indicam a eficiência das integrações. - Forneça insights acionáveis para equipes através de recomendações específicas e contextualizadas com base nos dados analisados. # 4. Exemplo de Output que você deve produzir **Relatório de Desempenho de Integrações de API** **Métricas de Desempenho:** - Tempo Médio de Resposta: 200ms - Taxa de Erro: 0.2% - Disponibilidade: 99.9% **Áreas de Melhoria:** - Aumentar a resiliência da API X para reduzir a taxa de erro. **Métricas de Sucesso:** - API Y atingiu 100% de disponibilidade no último mês.
2.3 Configurações do Agente
2.3.1 Especificação do Input
- Mecanismo de Acionamento: Este agente deve ser acionado automaticamente após a conclusão do agente anterior (RF 1).
- Tipo do input: Dados de desempenho coletados pelo Agente de Monitoramento de Desempenho de Integrações de API.
-
Formatos Suportados: Esse agente deve ser capaz de receber inputs no formato:
.json. - Número de caracteres esperado: Este agente deve ter capacidade para processar um input de texto com até 15.000 caracteres.
2.3.2 Especificação do Output
- Formato de output: O output deve ser um relatório detalhado em formato **Markdown**.
-
Exemplo de Estrutura de Output:
**Relatório de Desempenho de Integrações de API** **Métricas de Desempenho:** - Tempo Médio de Resposta: 200ms - Taxa de Erro: 0.2% - Disponibilidade: 99.9% **Áreas de Melhoria:** - Aumentar a resiliência da API X para reduzir a taxa de erro. **Métricas de Sucesso:** - API Y atingiu 100% de disponibilidade no último mês.
- Número de caracteres esperado: O relatório deve ser detalhado, com um tamanho estimado em torno de 3.000 caracteres.
2.3.3 Parâmetros de Geração
- Modelo: GPT-5
- Temperatura: 0.4
2.3.4 Ferramentas do Agente
- Documentos: Não consulta documentos externos.
- Calculadora: Utiliza lógica interna para calcular métricas de desempenho.
- Busca Online: Não utiliza.
- Sistemas Externos: Não se conecta a sistemas externos.
2.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 é passada para outros agentes internos.
2.3.6 Regras de Orquestração e Transição
A execução deste agente finaliza o fluxo. O relatório gerado é o resultado que deve ser disponibilizado ao usuário.