Como funciona cada parâmetro da Tess AI em suas chamadas de API? Entenda o significado dos dados retornados pela Tess AI ao acionar um agente via API e aproveite ao máximo as funcionalidades e integrações da nossa plataforma!
Aprenda cada elemento presente na resposta da API, desde os IDs e status até as configurações do agente e os parâmetros de entrada!
Explorando um Exemplo Prático
Para ilustrar a estrutura da resposta da API, vamos executar um exemplo prático no n8n, uma ferramenta de automação visual. Para isso, configuramos um nó HTTP Request com o ID do agente, o token de acesso à API e uma pergunta genérica: "Como fazer uma torta?".
Ao executar essa requisição, a Tess AI retorna uma série de informações que podem parecer confusas à primeira vista. Vamos desmistificar cada um desses elementos:
Entendendo os Elementos da Resposta da API
-
ID:
- Este campo representa o identificador único da resposta gerada pela Tess AI.
- Ao armazenar esse ID, é possível resgatar posteriormente a resposta específica de "como fazer uma torta".
- O ID da resposta serve como um ponteiro para o conteúdo gerado em resposta a uma requisição específica.
-
Status:
- O campo "status" indica o estado da requisição.
- Um status como "iniciado" sinaliza que a Tess AI recebeu a requisição e iniciou o processo de geração da resposta.
- Este campo permite acompanhar o ciclo de vida da requisição, desde o início até a conclusão.
-
Input:
- O campo "input" espelha a pergunta ou instrução enviada ao agente.
- No nosso exemplo, o input seria "como fazer uma torta".
- Este campo garante que a requisição foi processada com a entrada correta.
-
Output:
- Inicialmente, o campo "output" pode estar em branco, especialmente se a configuração "Wait Execution" não estiver ativada.
- O output conterá a resposta gerada pelo agente da Tess AI.
- A resposta pode incluir um passo a passo de como fazer uma torta, uma receita detalhada ou qualquer outro conteúdo relevante.
-
Créditos Consumidos:
- Este campo indica a quantidade de créditos consumidos para gerar a resposta.
- Embora a plataforma possa indicar um modelo "ilimitado", a utilização da API envolve custos computacionais para processar a requisição e gerar a resposta.
- O consumo de créditos é geralmente baixo, mas pode variar dependendo da complexidade da pergunta e da quantidade de texto envolvida. Requisições com textos longos tendem a consumir mais créditos.
-
Root ID (Chat ID):
- Este campo é de extrema importância para manter o contexto de conversas contínuas.
- O Root ID representa o identificador único da conversa em andamento, enquanto o ID da resposta se refere apenas a uma resposta específica dentro dessa conversa.
- Exemplo Prático: Imagine que você pergunta "Como fazer uma torta?" e, em seguida, pergunta "Qual a temperatura ideal do forno?". Para que o agente entenda que a segunda pergunta se refere à torta, é crucial enviar o Root ID da conversa original.
- Sem o Root ID, cada nova pergunta é tratada como uma conversa isolada, sem memória do contexto anterior.
-
Datas de Criação e Atualização:
- Esses campos indicam quando a resposta foi criada e quando foi atualizada pela última vez.
- Essas informações são úteis para fins de auditoria, análise de dados e para rastrear o histórico das interações com o agente.
- É possível usar essas datas para consultar o banco de dados e identificar respostas criadas em um determinado período.
-
Configurações do Agente:
- Esta seção reflete as configurações definidas ao criar o agente na Tess AI, como tom de voz, temperatura e modelo de linguagem.
- Tom de Voz: Define o estilo de comunicação do agente (formal, informal, amigável, etc.).
- Temperatura: Controla a aleatoriedade e a criatividade das respostas.
- Temperaturas mais baixas (próximas de zero) tornam as respostas mais sistemáticas, precisas e menos criativas. O agente se atém mais aos fatos e evita divagações.
- Temperaturas mais altas tornam as respostas mais criativas, imaginativas e com maior capacidade de fazer associações inesperadas. No entanto, respostas com temperaturas muito altas podem se afastar do tópico original.
- Modelo de Linguagem: Especifica o modelo de linguagem a ser utilizado pelo agente (ex: GPT-3, GPT-4).
- As configurações do agente podem ser pré-definidas ou podem ser alteradas dinamicamente via API.
-
Input (Via API):
- Esta seção mostra os parâmetros enviados via API, como a temperatura, o modelo de linguagem e a mensagem em si.
- É possível definir esses parâmetros tanto ao criar o agente quanto ao enviar a requisição via API.
- A flexibilidade de definir parâmetros via API permite personalizar o comportamento do agente em tempo real, de acordo com as necessidades específicas de cada interação.
-
Wait Execution:
- Este parâmetro determina se a API deve esperar até que a resposta seja gerada antes de retornar.
- Se ativado (true), a API retorna a resposta completa assim que ela estiver pronta.
- Se desativado (false), a API pode retornar um status inicial e a resposta será gerada em segundo plano.
- A escolha entre esperar ou não pela resposta depende dos requisitos de tempo real da aplicação.
Definindo Parâmetros: Pré-Definido vs. Dinâmico
É possível definir os parâmetros do agente tanto no momento da criação do agente na Tess AI quanto no momento da requisição via API. A escolha entre essas abordagens depende do caso de uso:
- Pré-Definido: Se a maioria das interações com o agente exigem as mesmas configurações, é mais eficiente defini-las no momento da criação do agente. Isso simplifica as requisições via API, tornando-as mais concisas.
- Dinâmico: Se for necessário ajustar os parâmetros do agente em tempo real, de acordo com as necessidades de cada interação, é melhor enviá-los via API. Isso oferece maior flexibilidade e controle sobre o comportamento do agente.
A Importância do Wait Execution
O parâmetro Wait Execution controla se a API deve aguardar a geração completa da resposta antes de retornar os dados.
Wait Execution = true: A API aguarda a geração da resposta e retorna todos os dados, incluindo ooutput, assim que estiver pronto. Isso garante que você receba a resposta completa de imediato.Wait Execution = false: A API retorna imediatamente um status inicial, sem aguardar a geração da resposta. Isso pode ser útil em cenários onde a resposta não é necessária em tempo real, permitindo que a geração ocorra em segundo plano.
Integrando os Dados no n8n
Compreender a estrutura da resposta da API da Tess AI permite integrar esses dados de forma eficiente no n8n. É possível utilizar o esquema da resposta para mapear os campos e utilizá-los em outros nós do fluxo de trabalho. Por exemplo, você pode extrair o texto da resposta (output) e enviá-lo para um canal do Slack, salvar em um banco de dados ou utilizá-lo como entrada para outro agente.
Conclusão
Dominar os detalhes da resposta da API da Tess AI é essencial para construir integrações robustas, personalizadas e eficientes. Ao compreender o significado de cada campo, desde os IDs e status até as configurações do agente e o parâmetro Wait Execution, você estará preparado para extrair o máximo valor da plataforma e criar aplicações inovadoras com inteligência artificial.