AI Genius API

Introdução

O AI Genius é um serviço IA que pode ser aplicado em uma série de contextos que exijam a criação ou a interpretação de textos e áudios em linguagem natural.

Com uma ampla variedade de modelos, alguns proprietários e outros disponibilizados por líderes globais, o AI Genius oferece versatilidade, desempenho e resiliência, além de agilidade para conectar o universo da IA aos negócios.

AI Genius Skills

O AI Genius possui skills de geração, interpretação e compreensão de linguagem natural, em textos e áudios, utilizando modelos proprietários treinados a partir de LLMs open source e outros oferecidos como serviço por líderes globais de tecnologia.

Entre os seus diferenciais, está a resiliência operacional que permite priorizar e alternar os modelos utilizados, em caso de eventuais falhas, assegurando alta disponibilidade e performance. Outro diferencial é a skill FAQ AutoTraining que consiste num pipeline totalmente automatizado para o treinamento de chats com bases de conhecimento que serão adicionadas ao seu domínio de informações.

FAQ AutoTraining 
Treinamento automático de modelos de LLM, adicionando as informações específica da empresa à base de conhecimento prévio do AI Genius.

MULTI-MODEL RESILIENCY
Priorização e alternância entre modelos de LLM proprietários e integrados como serviço ao AI Genius, a fim de maximizar a disponibilidade do serviço e minimizar o custo de processamento.

TEXT COMPLETION
Geração automática de textos em linguagem natural, em diversos contexto, tais como chatbots para atendimento ao cliente, tutores para atividades de ensino, especialmente, a distância, entre outros.

SPEECH TO TEXT
Converte da fala humana em texto, consistindo numa abordagem eficaz para transcrição automática de áudio, em diversos contextos. Com avanços contínuos, essa ferramenta desempenha um papel crucial na simplificação de tarefas, promovendo maior acessibilidade e automação em diversas aplicações.

TEXT TO SPEECH
Reprodução de textos em áudios em linguagem natural, desempenhando papel especialmente importante em acessibilidade, na medida em que torna informações acessíveis a uma variedade de públicos outrora impedidos de acessá-las.

TEXT MODERATION
Verificação de violação de políticas em conteúdo de texto. Permite detectar se um texto possui conteúdo sexual, hostil, de assédio, violento e de ódio. Pode ser utilizado na moderação de conteúdo em aplicações de chat.

Autenticação

Todos os end-points do AIGenius requerem o envio do token de acesso de uma conta client devidamente cadastrada e autorizada pela GoToData. Para obter o token acesse o end-point de login do serviço, conforme abaixo.

URL: https://aistudio-hml.gotodata.com.br/Api/PermissionManagement/client/login

Method: POST

Content-Type: application/json

Payload:

client_name: (string) Nome da conta client

grant_type: (int) Tipo de concessão. Valor 1 para contas do tipo client.

secret: (string) Chave secreta da conta client.

O valor do token obtido deve ser inserido no header para autenticar as requisições, conforme abaixo.

header: “Authorization: Bearer token”

Chatbot no AI Genius

Para treinar um chatbot no estilo FAQ automaticamente, o AIGenius conta com a skill FAQ AutoTraining.

Com essa skill, basta preparar a sua base de conhecimento, num arquivo CSV e enviá-la ao end-point de treinamento. Em alguns segundos, você visualizará o ID do seu chatbot (chatbot_ID) e poderá utilizá-lo para integração, em qualquer ponto dos seus sistemas.

O treinamento é 100% automático e adicionará o seu conhecimento à vasta gama de informações dos modelos pré-treinados que o AI Genius oferece.

FAQ AutoTraining

https://aistudio-hml.gotodata.com.br/Api/AIGenius/chatbot/train/
Formato: multipart/form-data

PARÂMETROS OBRIGATÓRIOS

name (string): Nome para identificar o chatbot

dataset (file): Arquivo CSV contendo a base de conhecimento a ser adicionada aos modelos do AI Genius, a fim de que ele possa responder às perguntas mais frequentes dos seus públicos de relacionamento (FAQ).

ATENÇÃO

O arquivo CSV deve conter duas colunas separadas por vírgula, sem cabeçalho, sendo a primeira com exemplos de perguntas e a segunda com exemplos de respostas;

Utilize markdown para incluir tabelas, seja nas perguntas ou nas respostas;

Não utilize áudios ou imagens na sua base de conhecimento. Eles poderão ser incluídos por URLs linkadas aos arquivos no seu storage para acesso pelos usuários do chat.

PARÂMETROS OPCIONAIS

description: (string) Descrição do chatbot

performance_level: (string) Define o nível de desempenho do chatbot, categorizado em três níveis: “LOW”, “MIDDLE” e “HIGH”. O nível “LOW” pode responder mais rapidamente, mas pode gerar respostas de menor qualidade. O nível “MIDDLE” pode ser mais lento que “LOW”, mas gera respostas de qualidade superior. O nível “HIGH” pode ser o mais lento, mas tende a entregar respostas de melhor qualidade.

availability_level: (string) Nível de disponibilidade do chatbot. Sendo possível os valores “LOW”, “MIDDLE” e “HIGH”, onde “LOW” pode apresentar uma baixa disponibilidade, “MIDDLE” uma disponibilidade mediana e “HIGH” uma alta disponibilidade.

knowledge_base: (string) Define a base de conhecimento que o chabot irá utilizar como referência, podendo ser “STRICT” ou “OPEN”. “STRICT” significa que o chatbot irá utilizar somente o dataset fornecido no treinamento como base de conhecimento. “OPEN” significa que o chatbot irá utilizar o dataset como base de conhecimento, mas que quando o usuário perguntar algo fora do escopo do dataset, irá utilizar a sua própria base de conhecimento pré-treinada para gerar respostas.

degrees_of_freedom: (float) Representa o nível de flexibilidade e autonomia que o chabot terá para gerar suas respostas. Este parâmetro possui um intervalo entre 0.0 e 1.0. Quanto mais perto de 1.0, maior a autonomia para geração de respostas. Valores muito próximos de 1.0 podem gerar respostas sem sentido.

general_instruction: (string) Define uma instrução geral para guiar o chatbot. Deve-se incluir o papel do chatbot nas conversas, bem como o seu propósito.

out_of_scope_message: (string) Define a mensagem base a ser utilizada para inspirar as mensagens a serem utilizadas quando o usuário está perguntando algo fora do escopo da base de conhecimento e o modo do chatbot é STRICT.

greetings_message: (string) Mensagem base para cumprimentar os usuários.

Quickstart

A GoToData oferece uma interface simples e intuitiva para o treinamento, a integração e a utilização de chatbots treinados no AI Genius com a sua base de conhecimento, a qual poderá ser ampliada com novas questões, sempre que necessário.

Aqui você encontrará o passo a passo para treinar um chatbot de forma ágil e descomplicada.

PASSO 1: como treinar um chatbot

URL: https://aistudio-hml.gotodata.com.br/Api/AIGenius/chatbot/train/
Method: POST
Formato: multipart/form-data

PAYLOAD
name: (string) Nome do chatbot.
description: (string) Descrição do chatbot.
dataset: (file) Arquivo CSV com a base de conhecimento adicional do chatbot.

RETURN
id: Identificador único do chatbot
name: Nome dado ao chatbot
description: Descrição dado ao chatbot
performance_level: Nível de desempenho escolhido para o chatbot
availability_level: Nível de disponibilidade escolhido para o chatbot
knowledge_base: Nome do arquivo csv contendo a base de conhecimento adicionada ao chatbot
degrees_of_freedom: Graus de liberdade concedido ao chatbot para gerar respostas distintas a partir das apresentadas na base de conhecimento
general_instruction: Instrução geral dada ao chatbot e que baliza o seu comportamento geral
out_of_scope_message: exemplo de respostas a serem dadas pelo chatbot para questões fora que estejam fora do seu escopo greetings_message: exemplo de mensagem para que o chatbot inicie a conversa com os usuários
dataset_filename: Nome do arquivo csv contendo a base de conhecimento adicionada ao chatbot
is_active: true / false indicando se o chatbot está ativo para ser utilizado
created_at: Timestamp da criação do chatbot
train_error: Flag que indica se houve um erro no treinamento
train_finished_at: Timestamp da finalização do treinamento

PASSO 2: como recuperar os dados de treinamento de um chatbot

Você pode monitorar o treinamento de um chatbot e verificar a sua conclusão, a qualquer momento, utilizando o chatbot_id. Retornos sem train_finished_at indicam que o treinamento do chatbot ainda não foi concluído.

URL: https://aistudio-hml.gotodata.com.br/Api/AIGenius/chatbot/:chatbot_id/
Method: GET

RETURN
id: Identificador único do chatbot
name: Nome dado ao chatbot
description: Descrição dado ao chatbot
performance_level: Nível de desempenho escolhido para o chatbot
availability_level: Nível de disponibilidade escolhido para o chatbot
knowledge_base: Nome do arquivo csv contendo a base de conhecimento adicionada ao chatbot
degrees_of_freedom: Graus de liberdade concedido ao chatbot para gerar respostas distintas a partir das apresentadas na base de conhecimento
general_instruction: Instrução geral dada ao chatbot e que baliza o seu comportamento geral
out_of_scope_message: exemplo de respostas a serem dadas pelo chatbot para questões fora que estejam fora do seu escopo greetings_message: exemplo de mensagem para que o chatbot inicie a conversa com os usuários
dataset_filename: Nome do arquivo csv contendo a base de conhecimento adicionada ao chatbot
is_active: true / false indicando se o chatbot está ativo para ser utilizado
created_at: Timestamp da criação do chatbot
train_error: Flag que indica se houve um erro no treinamento
train_finished_at: Timestamp da finalização do treinamento
metrics: Métricas de performance para o treinamento do chatbot

PASSO 3: como iniciar um diálogo com um chatbot

Após o treinamento, o chatbot poderá iniciar múltiplas conversas simultaneamente, a partir de qualquer lugar em qualquer horário, via API Rest. É possível iniciar uma conversa por meio de mensagem de texto ou áudio, também é possível obter resposta na forma de texto ou em áudio. O AIGenius também permite verificar se as mensagens dos usuários estão de acordo com as políticas de uso (moderation), para impedir uso indevido.

URL: https://aistudio-hml.gotodata.com.br/Api/AIGenius/chatbot/message/
Method: POST
Content-Type: application/json

PAYLOAD
chatbot_id: (string) ID do chatbot treinado.
message: (string) Mensagem do usuário para o chatbot.
audio: (file) Arquivo de áudio nos formatos: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
speech_response: (boolean) Flag para ativar o modo de resposta por áudio. Por padrão é falso (desativado).
speech_voice: (string) Tipo de voz para produzir o áudio de resposta. Opções disponíveis são:  “female-1”, “male-1”, “female-2”, “male-2”. Por padrão é “female-1”.
speech_speed: (float) Velocidade do áudio produzido para a resposta. Valores devem ser entre 0.25 e 4.0. Por padrão é 1.0.
check_violation: (boolean) Flag para ativar o modo que verifica se a mensagem do usuário está de acordo com as políticas de uso. Por padrão é falso (desativado).

RETURN
dialogue_id (string): Identificador único do diálogo entre o usuário e o chatbot
messages (array)
  role (string): papel do chatbot, em geral, “assistant”
  content (string): mensagem criada pelo chatbot em resposta às questões do usuário
  speech (string): URL do áudio gerado para a resposta. O arquivo gerado fica disponível até 5 minutos após sua geração.

ATENÇÃO: Cada diálogo iniciado com o chatbot contará com um ID (dialogue_id) que deve ser enviado nas mensagens seguintes, a fim de manter o contexto completo das informações fornecidas aos usuários. Diferentemente de outros serviços, NÃO é necessário enviar o histórico dos diálogos em todas as requisições.

PASSO 4: como continuar um diálogo com um chatbot

O retorno da primeira requisição do diálogo ao AI Genius incluirá o atributo dialogue_id que deve ser enviado no payload das mensagens subsequentes, a fim de manter o contexto completo da conversa e, consequentemente, respostas mais efetivas para os usuários finais.

URL: https://aistudio-hml.gotodata.com.br/Api/AIGenius/chatbot/message/
Method: POST
Content-Type: application/json

PAYLOAD
chatbot_id: (string) ID do chatbot treinado
dialogue_id: (string) ID do diálogo entre o chatbot e o usuário final
message: (string) Mensagem do usuário para o chatbot

RETURN
dialogue_id (string): Identificador único do diálogo entre o usuário e o chatbot
messages (array)
  role (string): papel do chatbot, em geral, “assistant”
  content (string): mensagem criada pelo chatbot em resposta às questões do usuário
  speech (string): URL do áudio com a resposta do assistente. A URL fica disponível até 5 minutos após sua geração. Este atributo só será apresentado se ao enviar a mensagem o atributo speech_response foi ativado.

Exemplo

ARQUIVO CSV

Ainda não tenho convênio,”Caso ainda não tenha convênio e precise de atendimento médico, o {{boldValue@open}}Projeto cuidando de quem cuida{{boldValue@close}} oferece consulta gratuita ao colaborador com o médico da família. \n\nPara entender mais, consulte: 👉http://intranet.afip.com.br/Paginas/Projeto-Cuidando-de-Quem-Cuida0625-8316.aspx\n⚠️_Atenção_: caso seu convênio seja outro, consulte diretamente seu gestor.”

Informações sobre jovem aprendiz,”A AFIP tem um Programa de Jovem Aprendiz onde contratamos jovens de 16 a 21 anos, que estejam cursando ou terminando o ensino médio.”

Documentos para admissão na empresa, “RG, CPF, Certidão de casamento, comprovante de residência, entre outros!”

DOCUMENTAÇÃO DETALHADA DO AI GENIUS

Quer mais informações sobre o AI Genius e como ele pode ajudar o seu negócio, clique aqui e acesse a documentação completa para o treinamento, a integração e o consumo de chatbots? Clique aqui e acesse a documentação completa!