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 "Suporte em Testes de API", uma solução projetada para auxiliar na criação e execução de testes automatizados para APIs, garantindo que todas as funcionalidades sejam verificadas e funcionando corretamente. 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 é automatizar o processo de teste de APIs, desde a criação de scripts de teste até a execução contínua e o fornecimento de relatórios detalhados de falhas e sugestões de correção.
2. Contexto e Problema
As equipes de desenvolvimento enfrentam desafios significativos ao garantir que todas as funcionalidades das APIs estejam funcionando corretamente. Problemas comuns incluem:
- Criação de testes automatizados para verificar funcionalidades de APIs.
- Garantia de que todas as funcionalidades das APIs estejam funcionando corretamente.
- Dificuldades em identificar falhas durante o processo de teste.
A ausência de um sistema automatizado leva a um processo manual, demorado e propenso a erros, afetando a eficiência e a confiabilidade das APIs.
3. Impactos Esperados
A implementação deste fluxo de automação visa alcançar os seguintes resultados:
- Automatizar a criação de testes para cobrir todas as funcionalidades das APIs.
- Executar testes de forma contínua para garantir o funcionamento correto das APIs.
- Fornecer relatórios detalhados de falhas e sugestões de correções, priorizando falhas críticas.
4. Visão Geral da Solução
O agente de IA para suporte em testes de API automatiza a criação e execução de testes para APIs, garantindo funcionalidade e confiabilidade. 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 verificação e manutenção das funcionalidades das APIs.
A solução consiste em um fluxo de automação composto por 3 agentes de IA. O processo inicia com a criação de testes automatizados e termina com a geração de relatórios de falhas e sugestões de correções.
A execução dos agentes é sequencial e linear, seguindo a ordem definida na tabela abaixo.
| Agentes | Função Principal |
|---|---|
Agente de Criação de Testes Automatizados de API (RF 1)
| Auxiliar na criação de testes automatizados para cobrir todas as funcionalidades das APIs. |
Agente de Execução Contínua de Testes de API (RF 2)
| Executar testes de forma contínua para garantir o funcionamento correto das APIs. |
Agente de Relatórios de Falhas e Sugestões de Correção (RF 3)
| Fornecer relatórios detalhados de falhas e sugestões de correções. |
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. Explore os links abaixo para entender melhor a solução em ação.
6. Requisitos Funcionais
RF 1. Agente de Criação de Testes Automatizados de API
1.1 Tarefa do Agente
Auxiliar na criação de testes automatizados para cobrir todas as funcionalidades das APIs, garantindo a cobertura completa.
1.2 Prompt ou Instruções do Agente
# 1. Contexto e explicações sobre inputs iniciais Você está recebendo especificações detalhadas das funcionalidades das APIs a serem testadas. Este documento descreve os endpoints e os comportamentos esperados. # 2. Objetivo Criar scripts de teste automatizados para cada funcionalidade especificada, cobrindo condições normais e de erro. # 3. Regras que você deve seguir para gerar sua resposta - Defina testes automatizados que cubram todos os endpoints das APIs, garantindo a cobertura de todas as funcionalidades especificadas. - Inclua casos de teste para condições normais e de erro, abrangendo cenários de uso comuns e exceções esperadas. - Garanta que os testes sejam atualizados conforme alterações nas especificações das APIs, revisando e ajustando os scripts sempre que necessário. # 4. Exemplo de Output que você deve produzir Scripts de teste automatizados para cada funcionalidade especificada.
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 especificações detalhadas das 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: O input inicial para o fluxo é um documento contendo especificações das APIs.
-
Formatos Suportados: Esse agente deve ser capaz de receber especificações nos formatos:
.pdf,.docx. - Número de caracteres esperado: Este agente deve ter capacidade para processar um input de texto com até 50.000 caracteres.
1.3.2 Especificação do Output
- Formato de output: O output deve ser um conjunto de scripts de teste automatizados, prontos para execução em ambiente de teste.
- Exemplo de Estrutura de Output: Scripts de teste automatizados para cada funcionalidade especificada.
- Número de caracteres esperado: O conjunto de scripts gerado deve ter um tamanho estimado em torno de 10.000 caracteres, podendo variar conforme a complexidade das especificações.
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 deve ser visível para o Agente de Execução Contínua de Testes 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 Execução Contínua de Testes de API (RF 2).
RF 2. Agente de Execução Contínua de Testes de API
2.1 Tarefa do Agente
Executar testes de forma contínua para garantir o funcionamento correto das APIs, monitorando a integridade.
2.2 Prompt ou Instruções do Agente
# 1. Contexto e explicações sobre inputs iniciais Você está recebendo scripts de teste automatizados e ambientes de teste configurados. # 2. Objetivo Executar os testes de forma contínua para monitorar o funcionamento das APIs e identificar falhas. # 3. Regras que você deve seguir para gerar sua resposta - Execute testes automatizados em intervalos regulares, de acordo com uma programação predefinida, para monitorar continuamente a integridade das APIs. - Monitore e registre continuamente os resultados dos testes, mantendo um histórico acessível para análise futura. - Alerta imediatamente sobre falhas críticas nos testes, enviando notificações para as partes interessadas responsáveis pela manutenção das APIs. # 4. Exemplo de Output que você deve produzir Resultados dos testes com status de sucesso ou falha para cada funcionalidade.
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: Este agente deve ser apto a receber scripts de teste automatizados e ambientes de teste configurados.
-
Formatos Suportados: Esse agente deve ser capaz de receber inputs nos formatos:
.json(para scripts de teste). - Número de caracteres esperado: Este agente deve ter capacidade para processar um input de até 10.000 caracteres.
2.3.2 Especificação do Output
- Formato de output: O output deve ser um relatório de execução dos testes, com status de sucesso ou falha para cada funcionalidade.
- Exemplo de Estrutura de Output: Relatórios de execução dos testes com status detalhado.
- Número de caracteres esperado: O relatório gerado deve ter um tamanho estimado em torno de 5.000 caracteres.
2.3.3 Parâmetros de Geração
- Modelo: GPT-5
- Temperatura: 0.6
2.3.4 Ferramentas do Agente
- Documentos: Não consulta.
- Calculadora: Não utiliza.
- Busca Online: Não utiliza.
- Sistemas Externos: Não utiliza.
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 deve ser visível para o Agente de Relatórios de Falhas e Sugestões de Correção (RF 3).
2.3.6 Regras de Orquestração e Transição
Ao concluir sua execução, esse agente aciona o Agente de Relatórios de Falhas e Sugestões de Correção (RF 3).
RF 3. Agente de Relatórios de Falhas e Sugestões de Correção
3.1 Tarefa do Agente
Fornecer relatórios detalhados de falhas e sugestões de correções, priorizando falhas críticas.
3.2 Prompt ou Instruções do Agente
# 1. Contexto e explicações sobre inputs iniciais Você está recebendo resultados dos testes com status de falha. # 2. Objetivo Compilar relatórios detalhados de falhas e sugerir correções práticas, priorizando aquelas de maior impacto. # 3. Regras que você deve seguir para gerar sua resposta - Compile relatórios que detalhem cada falha identificada, incluindo logs de erro e contexto da execução onde a falha ocorreu. - Sugira correções práticas para cada falha com base nos dados dos testes, priorizando aquelas que têm maior impacto no funcionamento das APIs. - Priorize falhas críticas e forneça soluções rápidas, garantindo que as correções propostas sejam claras e acionáveis para as equipes de desenvolvimento. # 4. Exemplo de Output que você deve produzir Relatórios detalhados de falhas com sugestões de correção.
3.3 Configurações do Agente
3.3.1 Especificação do Input
- Mecanismo de Acionamento: Este agente deve ser acionado automaticamente após a conclusão do agente anterior (RF 2).
- Tipo do input: Este agente deve ser apto a receber resultados dos testes com status de falha.
-
Formatos Suportados: Esse agente deve ser capaz de receber inputs nos formatos:
.json(para relatórios de execução). - Número de caracteres esperado: Este agente deve ter capacidade para processar um input de até 5.000 caracteres.
3.3.2 Especificação do Output
- Formato de output: O output deve ser um relatório detalhado de falhas com sugestões de correção.
- Exemplo de Estrutura de Output: Relatórios de falhas com sugestões de correção detalhadas.
- Número de caracteres esperado: O relatório gerado deve ter um tamanho estimado em torno de 5.000 caracteres.
3.3.3 Parâmetros de Geração
- Modelo: GPT-5
- Temperatura: 0.6
3.3.4 Ferramentas do Agente
- Documentos: Não consulta.
- Calculadora: Não utiliza.
- Busca Online: Não utiliza.
- Sistemas Externos: Não utiliza.
3.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.
3.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.