Documentação

Primeiros Passos

Bem-vindo à documentação da GPTuga! Esta página fornece todas as informações necessárias para começar a utilizar as nossas APIs e serviços de IA.

O que é a GPTuga?

A GPTuga oferece soluções de inteligência artificial especialmente desenvolvidas para o mercado português. As nossas APIs e serviços são treinados com dados específicos da língua portuguesa, garantindo uma compreensão precisa de expressões idiomáticas, gírias e variações regionais.

Serviços Disponíveis

Atualmente, oferecemos os seguintes serviços:

• API de Linguagem - Processamento de linguagem natural para análise de sentimentos, classificação de texto, extração de entidades e muito mais.
• Chatbots Personalizados - Assistentes virtuais que podem ser integrados em websites, aplicações móveis e plataformas de mensagens.
• Soluções à Medida - Desenvolvimento de soluções de IA personalizadas para necessidades específicas de negócio.

Como Começar

Para começar a utilizar os serviços da GPTuga, siga estes passos:

1. Crie uma conta na plataforma de desenvolvedores da GPTuga.
2. Gere uma chave de API no painel de controlo.
3. Escolha o serviço que deseja utilizar e siga a documentação específica.
4. Integre a API ou serviço na sua aplicação utilizando um dos nossos SDKs ou fazendo chamadas diretas à API REST.

curl -X POST https://api.gptuga.pt/v1/sentimentos \
-H "Authorization: Bearer SUA_CHAVE_API" \
-H "Content-Type: application/json" \
-d '{
  "texto": "Adorei o serviço, superou todas as minhas expectativas!"
}'

const GPTuga = require('gptuga');

const client = new GPTuga('SUA_CHAVE_API');

client.sentimentos.analisar({
  texto: "Adorei o serviço, superou todas as minhas expectativas!"
})
.then(response => {
  console.log(response);
})
.catch(error => {
  console.error(error);
});

import gptuga

client = gptuga.Client("SUA_CHAVE_API")

response = client.sentimentos.analisar(
    texto="Adorei o serviço, superou todas as minhas expectativas!"
)

print(response)

require_once 'vendor/autoload.php';

$client = new GPTuga\Client('SUA_CHAVE_API');

$response = $client->sentimentos->analisar([
    'texto' => 'Adorei o serviço, superou todas as minhas expectativas!'
]);

print_r($response);

Autenticação

Todas as solicitações à API da GPTuga devem ser autenticadas utilizando uma chave de API. Esta chave deve ser incluída no cabeçalho de autorização de todas as solicitações.

Obter uma Chave de API

Para obter uma chave de API, siga estes passos:

1. Faça login na plataforma de desenvolvedores da GPTuga.
2. Navegue até à secção "Chaves de API" no painel de controlo.
3. Clique em "Gerar Nova Chave" e dê um nome à sua chave.
4. Copie a chave gerada e guarde-a num local seguro.

Authorization: Bearer SUA_CHAVE_API

Segurança da Chave de API

É importante manter a sua chave de API segura:

• Nunca partilhe a sua chave de API publicamente ou inclua-a em código-fonte que será partilhado.
• Utilize variáveis de ambiente ou sistemas de gestão de segredos para armazenar a sua chave.
• Implemente restrições de domínio para limitar onde a sua chave pode ser utilizada.
• Revogue e gere novas chaves periodicamente ou se suspeitar de um comprometimento.

Limites de Requisições

Para garantir a disponibilidade e estabilidade dos nossos serviços, implementamos limites de requisições para todas as APIs. Estes limites variam de acordo com o plano escolhido.

Limites por Plano

Cabeçalhos de Limite de Taxa

Cada resposta da API inclui cabeçalhos que fornecem informações sobre a sua utilização atual e limites:

• X-RateLimit-Limit: O número máximo de requisições permitidas no período atual.
• X-RateLimit-Remaining: O número de requisições restantes no período atual.
• X-RateLimit-Reset: O tempo (em segundos Unix) quando o limite será redefinido.

Tratamento de Limites Excedidos

Se exceder o limite de requisições, a API retornará um erro 429 (Too Many Requests). Neste caso, deve aguardar até que o limite seja redefinido antes de fazer novas requisições.

{
  "error": {
    "code": 429,
    "message": "Limite de requisições excedido. Por favor, tente novamente após X segundos.",
    "retry_after": 60
  }
}

Tratamento de Erros

A API da GPTuga utiliza códigos de estado HTTP padrão para indicar o sucesso ou falha de uma requisição. Em caso de erro, a resposta incluirá um objeto JSON com detalhes sobre o erro.

Códigos de Status

Formato de Erro

Quando ocorre um erro, a API retorna um objeto JSON com os seguintes campos:

{
  "error": {
    "code": 400,
    "message": "Parâmetro 'texto' é obrigatório.",
    "details": {
      "param": "texto",
      "reason": "required"
    }
  }
}

Tratamento de Erros no Cliente

Recomendamos implementar um tratamento de erros robusto na sua aplicação para lidar com possíveis falhas na API. Aqui está um exemplo de como tratar erros em JavaScript:

client.sentimentos.analisar({
  texto: "Adorei o serviço, superou todas as minhas expectativas!"
})
.then(response => {
  // Processar resposta bem-sucedida
  console.log(response);
})
.catch(error => {
  if (error.status === 429) {
    // Implementar lógica de retry após o tempo especificado
    const retryAfter = error.data.error.retry_after || 60;
    console.log(`Limite de requisições excedido. Tentando novamente em ${retryAfter} segundos.`);
    setTimeout(() => {
      // Tentar novamente
    }, retryAfter * 1000);
  } else {
    // Lidar com outros tipos de erro
    console.error(`Erro ${error.status}: ${error.data.error.message}`);
  }
});

Análise de Sentimentos

A API de Análise de Sentimentos permite determinar se um texto expressa sentimentos positivos, negativos ou neutros, com deteção de nuances específicas da língua portuguesa.

Endpoint

Parâmetros

Exemplo de Requisição

curl -X POST https://api.gptuga.pt/v1/sentimentos \
-H "Authorization: Bearer SUA_CHAVE_API" \
-H "Content-Type: application/json" \
-d '{
  "texto": "Adorei o serviço, superou todas as minhas expectativas!",
  "detalhe": true
}'

const GPTuga = require('gptuga');

const client = new GPTuga('SUA_CHAVE_API');

client.sentimentos.analisar({
  texto: "Adorei o serviço, superou todas as minhas expectativas!",
  detalhe: true
})
.then(response => {
  console.log(response);
})
.catch(error => {
  console.error(error);
});

import gptuga

client = gptuga.Client("SUA_CHAVE_API")

response = client.sentimentos.analisar(
    texto="Adorei o serviço, superou todas as minhas expectativas!",
    detalhe=True
)

print(response)

require_once 'vendor/autoload.php';

$client = new GPTuga\Client('SUA_CHAVE_API');

$response = $client->sentimentos->analisar([
    'texto' => 'Adorei o serviço, superou todas as minhas expectativas!',
    'detalhe' => true
]);

print_r($response);

Exemplo de Resposta

{
  "sentimento": "positivo",
  "pontuacao": 0.92,
  "confianca": 0.95,
  "detalhes": {
    "alegria": 0.87,
    "satisfacao": 0.94,
    "surpresa": 0.65
  }
}

Campos da Resposta

Classificação de Texto

A API de Classificação de Texto permite categorizar textos em classes predefinidas ou personalizadas, ideal para organização de conteúdo, filtragem e análise automática.

Endpoint

Parâmetros

Modelos Disponíveis

Exemplo de Requisição

curl -X POST https://api.gptuga.pt/v1/classificacao \
-H "Authorization: Bearer SUA_CHAVE_API" \
-H "Content-Type: application/json" \
-d '{
  "texto": "O novo smartphone tem uma câmera impressionante e bateria que dura o dia todo.",
  "modelo": "produtos"
}'

const GPTuga = require('gptuga');

const client = new GPTuga('SUA_CHAVE_API');

client.classificacao.analisar({
  texto: "O novo smartphone tem uma câmera impressionante e bateria que dura o dia todo.",
  modelo: "produtos"
})
.then(response => {
  console.log(response);
})
.catch(error => {
  console.error(error);
});

import gptuga

client = gptuga.Client("SUA_CHAVE_API")

response = client.classificacao.analisar(
    texto="O novo smartphone tem uma câmera impressionante e bateria que dura o dia todo.",
    modelo="produtos"
)

print(response)

require_once 'vendor/autoload.php';

$client = new GPTuga\Client('SUA_CHAVE_API');

$response = $client->classificacao->analisar([
    'texto' => 'O novo smartphone tem uma câmera impressionante e bateria que dura o dia todo.',
    'modelo' => 'produtos'
]);

print_r($response);

Exemplo com Categorias Personalizadas

curl -X POST https://api.gptuga.pt/v1/classificacao \
-H "Authorization: Bearer SUA_CHAVE_API" \
-H "Content-Type: application/json" \
-d '{
  "texto": "O novo smartphone tem uma câmera impressionante e bateria que dura o dia todo.",
  "modelo": "personalizado",
  "categorias": ["Fotografia", "Bateria", "Design", "Performance", "Software"]
}'

Exemplo de Resposta

{
  "categoria_principal": "Qualidade",
  "confianca_principal": 0.85,
  "categorias": [
    {
      "nome": "Qualidade",
      "confianca": 0.85
    },
    {
      "nome": "Usabilidade",
      "confianca": 0.45
    },
    {
      "nome": "Preço",
      "confianca": 0.12
    }
  ]
}

Exemplo de Resposta com Categorias Personalizadas

{
  "categoria_principal": "Bateria",
  "confianca_principal": 0.78,
  "categorias": [
    {
      "nome": "Bateria",
      "confianca": 0.78
    },
    {
      "nome": "Fotografia",
      "confianca": 0.72
    },
    {
      "nome": "Design",
      "confianca": 0.23
    },
    {
      "nome": "Performance",
      "confianca": 0.18
    },
    {
      "nome": "Software",
      "confianca": 0.05
    }
  ]
}

Extração de Entidades

A API de Extração de Entidades identifica e extrai informações estruturadas de textos não estruturados, como nomes de pessoas, organizações, locais, datas, valores monetários e outros tipos de entidades.

Endpoint

Parâmetros

Tipos de Entidades Disponíveis

Exemplo de Requisição

curl -X POST https://api.gptuga.pt/v1/entidades \
-H "Authorization: Bearer SUA_CHAVE_API" \
-H "Content-Type: application/json" \
-d '{
  "texto": "A Maria Silva, CEO da TechLisboa, anunciou ontem que a empresa abrirá um novo escritório no Porto em 15 de Outubro de 2025, com um investimento de 2 milhões de euros.",
  "tipos": ["PESSOA", "ORGANIZACAO", "LOCAL", "DATA", "DINHEIRO"],
  "contexto": true
}'

const GPTuga = require('gptuga');

const client = new GPTuga('SUA_CHAVE_API');

client.entidades.extrair({
  texto: "A Maria Silva, CEO da TechLisboa, anunciou ontem que a empresa abrirá um novo escritório no Porto em 15 de Outubro de 2025, com um investimento de 2 milhões de euros.",
  tipos: ["PESSOA", "ORGANIZACAO", "LOCAL", "DATA", "DINHEIRO"],
  contexto: true
})
.then(response => {
  console.log(response);
})
.catch(error => {
  console.error(error);
});

import gptuga

client = gptuga.Client("SUA_CHAVE_API")

response = client.entidades.extrair(
    texto="A Maria Silva, CEO da TechLisboa, anunciou ontem que a empresa abrirá um novo escritório no Porto em 15 de Outubro de 2025, com um investimento de 2 milhões de euros.",
    tipos=["PESSOA", "ORGANIZACAO", "LOCAL", "DATA", "DINHEIRO"],
    contexto=True
)

print(response)

require_once 'vendor/autoload.php';

$client = new GPTuga\Client('SUA_CHAVE_API');

$response = $client->entidades->extrair([
    'texto' => 'A Maria Silva, CEO da TechLisboa, anunciou ontem que a empresa abrirá um novo escritório no Porto em 15 de Outubro de 2025, com um investimento de 2 milhões de euros.',
    'tipos' => ['PESSOA', 'ORGANIZACAO', 'LOCAL', 'DATA', 'DINHEIRO'],
    'contexto' => true
]);

print_r($response);

Exemplo de Resposta

{
  "entidades": [
    {
      "texto": "Maria Silva",
      "tipo": "PESSOA",
      "confianca": 0.98,
      "inicio": 2,
      "fim": 13,
      "contexto": "A Maria Silva, CEO da TechLisboa"
    },
    {
      "texto": "TechLisboa",
      "tipo": "ORGANIZACAO",
      "confianca": 0.95,
      "inicio": 23,
      "fim": 33,
      "contexto": "CEO da TechLisboa, anunciou ontem"
    },
    {
      "texto": "Porto",
      "tipo": "LOCAL",
      "confianca": 0.97,
      "inicio": 79,
      "fim": 84,
      "contexto": "um novo escritório no Porto em 15 de Outubro"
    },
    {
      "texto": "15 de Outubro de 2025",
      "tipo": "DATA",
      "confianca": 0.99,
      "inicio": 88,
      "fim": 109,
      "contexto": "no Porto em 15 de Outubro de 2025, com um investimento"
    },
    {
      "texto": "2 milhões de euros",
      "tipo": "DINHEIRO",
      "confianca": 0.96,
      "inicio": 130,
      "fim": 148,
      "contexto": "um investimento de 2 milhões de euros."
    }
  ],
  "contagem": {
    "PESSOA": 1,
    "ORGANIZACAO": 1,
    "LOCAL": 1,
    "DATA": 1,
    "DINHEIRO": 1
  }
}

Resumo de Texto

A API de Resumo de Texto permite criar resumos concisos e coerentes de textos longos, mantendo as informações mais relevantes e o contexto principal.

Endpoint

Parâmetros

Exemplo de Requisição

curl -X POST https://api.gptuga.pt/v1/resumo \
-H "Authorization: Bearer SUA_CHAVE_API" \
-H "Content-Type: application/json" \
-d '{
  "texto": "A inteligência artificial (IA) tem revolucionado diversos setores da economia portuguesa. No setor bancário, instituições como o Banco de Portugal e a Caixa Geral de Depósitos implementaram sistemas de IA para deteção de fraudes e atendimento ao cliente. Na saúde, hospitais como o Santa Maria em Lisboa utilizam algoritmos para auxiliar no diagnóstico de doenças. O setor do turismo também se beneficiou com sistemas de recomendação personalizados e chatbots para atendimento em múltiplos idiomas. Empresas como a TAP e a CP utilizam IA para otimização de rotas e manutenção preditiva. Universidades portuguesas como a de Lisboa, Porto e Coimbra têm desenvolvido pesquisas avançadas em IA, contribuindo para o crescimento do ecossistema tecnológico nacional. O governo português lançou em 2023 uma estratégia nacional para IA, visando posicionar o país como um hub de inovação tecnológica na Europa.",
  "tamanho": "curto",
  "formato": "pontos",
  "palavras_chave": true
}'

const GPTuga = require('gptuga');

const client = new GPTuga('SUA_CHAVE_API');

client.resumo.criar({
  texto: "A inteligência artificial (IA) tem revolucionado diversos setores da economia portuguesa. No setor bancário, instituições como o Banco de Portugal e a Caixa Geral de Depósitos implementaram sistemas de IA para deteção de fraudes e atendimento ao cliente. Na saúde, hospitais como o Santa Maria em Lisboa utilizam algoritmos para auxiliar no diagnóstico de doenças. O setor do turismo também se beneficiou com sistemas de recomendação personalizados e chatbots para atendimento em múltiplos idiomas. Empresas como a TAP e a CP utilizam IA para otimização de rotas e manutenção preditiva. Universidades portuguesas como a de Lisboa, Porto e Coimbra têm desenvolvido pesquisas avançadas em IA, contribuindo para o crescimento do ecossistema tecnológico nacional. O governo português lançou em 2023 uma estratégia nacional para IA, visando posicionar o país como um hub de inovação tecnológica na Europa.",
  tamanho: "curto",
  formato: "pontos",
  palavras_chave: true
})
.then(response => {
  console.log(response);
})
.catch(error => {
  console.error(error);
});

import gptuga

client = gptuga.Client("SUA_CHAVE_API")

response = client.resumo.criar(
    texto="A inteligência artificial (IA) tem revolucionado diversos setores da economia portuguesa. No setor bancário, instituições como o Banco de Portugal e a Caixa Geral de Depósitos implementaram sistemas de IA para deteção de fraudes e atendimento ao cliente. Na saúde, hospitais como o Santa Maria em Lisboa utilizam algoritmos para auxiliar no diagnóstico de doenças. O setor do turismo também se beneficiou com sistemas de recomendação personalizados e chatbots para atendimento em múltiplos idiomas. Empresas como a TAP e a CP utilizam IA para otimização de rotas e manutenção preditiva. Universidades portuguesas como a de Lisboa, Porto e Coimbra têm desenvolvido pesquisas avançadas em IA, contribuindo para o crescimento do ecossistema tecnológico nacional. O governo português lançou em 2023 uma estratégia nacional para IA, visando posicionar o país como um hub de inovação tecnológica na Europa.",
    tamanho="curto",
    formato="pontos",
    palavras_chave=True
)

print(response)

require_once 'vendor/autoload.php';

$client = new GPTuga\Client('SUA_CHAVE_API');

$response = $client->resumo->criar([
    'texto' => 'A inteligência artificial (IA) tem revolucionado diversos setores da economia portuguesa. No setor bancário, instituições como o Banco de Portugal e a Caixa Geral de Depósitos implementaram sistemas de IA para deteção de fraudes e atendimento ao cliente. Na saúde, hospitais como o Santa Maria em Lisboa utilizam algoritmos para auxiliar no diagnóstico de doenças. O setor do turismo também se beneficiou com sistemas de recomendação personalizados e chatbots para atendimento em múltiplos idiomas. Empresas como a TAP e a CP utilizam IA para otimização de rotas e manutenção preditiva. Universidades portuguesas como a de Lisboa, Porto e Coimbra têm desenvolvido pesquisas avançadas em IA, contribuindo para o crescimento do ecossistema tecnológico nacional. O governo português lançou em 2023 uma estratégia nacional para IA, visando posicionar o país como um hub de inovação tecnológica na Europa.',
    'tamanho' => 'curto',
    'formato' => 'pontos',
    'palavras_chave' => true
]);

print_r($response);

Exemplo de Resposta

{
  "resumo": [
    "IA revoluciona setores da economia portuguesa como bancário, saúde e turismo.",
    "Instituições financeiras e hospitais implementam IA para fraudes e diagnósticos.",
    "Empresas de transporte utilizam IA para otimização e manutenção preditiva.",
    "Universidades portuguesas desenvolvem pesquisas avançadas em IA.",
    "Governo lançou estratégia nacional para IA em 2023."
  ],
  "palavras_chave": [
    "inteligência artificial",
    "economia portuguesa",
    "inovação tecnológica",
    "setores",
    "estratégia nacional"
  ],
  "estatisticas": {
    "texto_original": {
      "caracteres": 893,
      "palavras": 143,
      "frases": 7
    },
    "resumo": {
      "caracteres": 372,
      "palavras": 56,
      "frases": 5,
      "taxa_compressao": 60.8
    }
  }
}

Formatos de Resumo

Correção Gramatical

A API de Correção Gramatical identifica e corrige erros ortográficos, gramaticais e de pontuação em textos em português, considerando as variantes europeia e brasileira.

Endpoint

Parâmetros

Exemplo de Requisição

curl -X POST https://api.gptuga.pt/v1/correcao \
-H "Authorization: Bearer SUA_CHAVE_API" \
-H "Content-Type: application/json" \
-d '{
  "texto": "Eu gostaria de comprár um bilhete para o concerto de amanhã, mas não sei se ainda tem lugares disponiveis.",
  "variante": "pt-PT",
  "detalhes": true
}'

const GPTuga = require('gptuga');

const client = new GPTuga('SUA_CHAVE_API');

client.correcao.corrigir({
  texto: "Eu gostaria de comprár um bilhete para o concerto de amanhã, mas não sei se ainda tem lugares disponiveis.",
  variante: "pt-PT",
  detalhes: true
})
.then(response => {
  console.log(response);
})
.catch(error => {
  console.error(error);
});

import gptuga

client = gptuga.Client("SUA_CHAVE_API")

response = client.correcao.corrigir(
    texto="Eu gostaria de comprár um bilhete para o concerto de amanhã, mas não sei se ainda tem lugares disponiveis.",
    variante="pt-PT",
    detalhes=True
)

print(response)

require_once 'vendor/autoload.php';

$client = new GPTuga\Client('SUA_CHAVE_API');

$response = $client->correcao->corrigir([
    'texto' => 'Eu gostaria de comprár um bilhete para o concerto de amanhã, mas não sei se ainda tem lugares disponiveis.',
    'variante' => 'pt-PT',
    'detalhes' => true
]);

print_r($response);

Exemplo de Resposta

{
  "texto_original": "Eu gostaria de comprár um bilhete para o concerto de amanhã, mas não sei se ainda tem lugares disponiveis.",
  "texto_corrigido": "Eu gostaria de comprar um bilhete para o concerto de amanhã, mas não sei se ainda tem lugares disponíveis.",
  "total_correcoes": 2,
  "detalhes": [
    {
      "original": "comprár",
      "corrigido": "comprar",
      "tipo": "ortográfico",
      "posicao": 16,
      "explicacao": "O verbo 'comprar' não leva acento."
    },
    {
      "original": "disponiveis",
      "corrigido": "disponíveis",
      "tipo": "ortográfico",
      "posicao": 85,
      "explicacao": "A palavra 'disponíveis' leva acento agudo no 'i'."
    }
  ]
}

Tipos de Correções

Geração de Texto

A API de Geração de Texto permite criar conteúdo textual em português de alta qualidade para diversos fins, como redação de e-mails, artigos, descrições de produtos, publicações para redes sociais e muito mais.

Endpoint

Parâmetros

Tipos de Conteúdo Disponíveis

Exemplo de Requisição

curl -X POST https://api.gptuga.pt/v1/geracao \
-H "Authorization: Bearer SUA_CHAVE_API" \
-H "Content-Type: application/json" \
-d '{
  "prompt": "Escreva um email para convidar clientes para um evento de lançamento de um novo produto de tecnologia.",
  "tipo": "email",
  "tom": "profissional",
  "max_tokens": 300,
  "variante": "pt-PT"
}'

const GPTuga = require('gptuga');

const client = new GPTuga('SUA_CHAVE_API');

client.geracao.criar({
  prompt: "Escreva um email para convidar clientes para um evento de lançamento de um novo produto de tecnologia.",
  tipo: "email",
  tom: "profissional",
  max_tokens: 300,
  variante: "pt-PT"
})
.then(response => {
  console.log(response);
})
.catch(error => {
  console.error(error);
});

import gptuga

client = gptuga.Client("SUA_CHAVE_API")

response = client.geracao.criar(
    prompt="Escreva um email para convidar clientes para um evento de lançamento de um novo produto de tecnologia.",
    tipo="email",
    tom="profissional",
    max_tokens=300,
    variante="pt-PT"
)

print(response)

require_once 'vendor/autoload.php';

$client = new GPTuga\Client('SUA_CHAVE_API');

$response = $client->geracao->criar([
    'prompt' => 'Escreva um email para convidar clientes para um evento de lançamento de um novo produto de tecnologia.',
    'tipo' => 'email',
    'tom' => 'profissional',
    'max_tokens' => 300,
    'variante' => 'pt-PT'
]);

print_r($response);

Exemplo de Resposta

{
  "texto": "Assunto: Convite Exclusivo: Evento de Lançamento do Nosso Mais Recente Produto Tecnológico\n\nExmo(a). Cliente,\n\nÉ com grande satisfação que convidamos V. Exa. para o evento de lançamento do nosso mais recente produto tecnológico, que terá lugar no dia 15 de novembro de 2025, às 19h00, no Hotel Ritz em Lisboa.\n\nNeste evento exclusivo, terá a oportunidade de conhecer em primeira mão a nossa mais recente inovação tecnológica, que promete revolucionar o mercado. Além da apresentação oficial do produto, contaremos com demonstrações práticas, sessões interativas e a presença de especialistas do setor que estarão disponíveis para responder a todas as suas questões.\n\nO programa do evento inclui:\n• 19h00 - Receção e welcome drink\n• 19h30 - Apresentação oficial do produto\n• 20h15 - Demonstrações práticas\n• 21h00 - Cocktail e networking\n\nA sua presença é muito importante para nós. Para confirmar a sua participação, solicitamos que responda a este email até ao dia 5 de novembro.\n\nFicamos à sua disposição para qualquer esclarecimento adicional.\n\nCom os melhores cumprimentos,",
  "tokens_utilizados": 217,
  "tokens_solicitados": 300
}

Dicas para Prompts Eficazes

Para obter os melhores resultados da API de Geração de Texto, considere estas dicas ao criar os seus prompts:

• Seja específico - Quanto mais detalhes fornecer, mais preciso será o resultado.
• Defina o contexto - Inclua informações sobre o público-alvo, objetivo e contexto do texto.
• Estruture o prompt - Organize as suas instruções de forma clara e lógica.
• Forneça exemplos - Se possível, inclua exemplos do tipo de resposta que espera.
• Use o parâmetro "tipo" - Aproveite os tipos de conteúdo predefinidos para obter formatos específicos.

Chatbots - Visão Geral

A plataforma de chatbots da GPTuga permite criar assistentes virtuais inteligentes e personalizados que compreendem e respondem em português com naturalidade. Os nossos chatbots podem ser integrados em websites, aplicações móveis, plataformas de mensagens e sistemas internos.

Recursos Principais

• Compreensão de Linguagem Natural - Entendimento avançado do português, incluindo gírias, expressões regionais e contexto conversacional.
• Personalização Completa - Adapte o chatbot à identidade da sua marca, incluindo tom de voz, personalidade e conhecimentos específicos.
• Integração Multicanal - Implante o mesmo chatbot em múltiplos canais, mantendo o contexto das conversas entre plataformas.
• Análise de Conversas - Obtenha insights valiosos sobre as interações dos utilizadores, tópicos comuns e satisfação.
• Formação Contínua - Melhore o desempenho do chatbot ao longo do tempo com base em interações reais.
• Handoff para Humanos - Transferência suave para atendentes humanos quando necessário.

Casos de Uso

Arquitetura do Sistema

A plataforma de chatbots da GPTuga é composta por vários componentes que trabalham juntos para fornecer uma experiência conversacional completa:

• Motor de Processamento de Linguagem Natural (NLP) - Analisa e compreende as mensagens dos utilizadores.
• Gestor de Contexto - Mantém o histórico e o contexto da conversa para respostas coerentes.
• Base de Conhecimento - Armazena informações específicas do domínio para informar as respostas do chatbot.
• Conectores de Integração - Permitem a ligação com várias plataformas e sistemas externos.
• Painel de Administração - Interface para configurar, formar e monitorizar o chatbot.
• Sistema de Análise - Recolhe e analisa dados de interação para melhorar o desempenho.

Começando com Chatbots

Para criar e implementar um chatbot da GPTuga, siga estas etapas:

1. Aceda ao Painel de Chatbots na plataforma da GPTuga.
2. Clique em "Criar Novo Chatbot" e siga o assistente de configuração.
3. Defina o nome, personalidade e conhecimentos base do seu chatbot.
4. Escolha os canais de integração desejados.
5. Personalize a aparência e o comportamento do chatbot.
6. Forme o chatbot com perguntas e respostas específicas do seu domínio.
7. Teste o chatbot no ambiente de sandbox.
8. Implante o chatbot nos canais selecionados.

Para mais detalhes sobre cada etapa do processo, consulte as secções específicas de Integração, Personalização e Formação.

Chatbots - Integração

A GPTuga oferece diversas opções de integração para os seus chatbots, permitindo que implemente assistentes virtuais em múltiplos canais de comunicação e plataformas.

Canais de Integração Disponíveis

Widget para Website

A forma mais comum de integração é através do nosso widget para websites. Basta adicionar um pequeno trecho de código ao seu site:

<script>
  window.GPTugaSettings = {
    chatbotId: "SEU_CHATBOT_ID",
    position: "bottom-right",
    primaryColor: "#005E00",
    welcomeMessage: "Olá! Como posso ajudar?",
    language: "pt-PT"
  };
</script>
<script src="https://cdn.gptuga.pt/chatbot.js" async></script>

Integração via API REST

Para integrações mais avançadas ou personalizadas, pode utilizar a nossa API REST:

Endpoint para Envio de Mensagens

Parâmetros

Exemplo de Requisição

curl -X POST https://api.gptuga.pt/v1/chatbot/abc123/mensagem \
-H "Authorization: Bearer SUA_CHAVE_API" \
-H "Content-Type: application/json" \
-d '{
  "usuarioId": "user_12345",
  "mensagem": "Quais são os horários de funcionamento?",
  "contexto": {
    "nome": "João Silva",
    "email": "joao@exemplo.com",
    "pagina_atual": "https://seusite.com/contato"
  }
}'

const GPTuga = require('gptuga');

const client = new GPTuga('SUA_CHAVE_API');

client.chatbot.enviarMensagem('abc123', {
  usuarioId: "user_12345",
  mensagem: "Quais são os horários de funcionamento?",
  contexto: {
    nome: "João Silva",
    email: "joao@exemplo.com",
    pagina_atual: "https://seusite.com/contato"
  }
})
.then(response => {
  console.log(response);
})
.catch(error => {
  console.error(error);
});

import gptuga

client = gptuga.Client("SUA_CHAVE_API")

response = client.chatbot.enviar_mensagem(
    "abc123",
    usuario_id="user_12345",
    mensagem="Quais são os horários de funcionamento?",
    contexto={
        "nome": "João Silva",
        "email": "joao@exemplo.com",
        "pagina_atual": "https://seusite.com/contato"
    }
)

print(response)

require_once 'vendor/autoload.php';

$client = new GPTuga\Client('SUA_CHAVE_API');

$response = $client->chatbot->enviarMensagem('abc123', [
    'usuarioId' => 'user_12345',
    'mensagem' => 'Quais são os horários de funcionamento?',
    'contexto' => [
        'nome' => 'João Silva',
        'email' => 'joao@exemplo.com',
        'pagina_atual' => 'https://seusite.com/contato'
    ]
]);

print_r($response);

Exemplo de Resposta

{
  "id": "msg_67890",
  "resposta": "Os nossos horários de funcionamento são de segunda a sexta, das 9h às 18h, e aos sábados das 10h às 14h. Estamos fechados aos domingos e feriados.",
  "tipo": "texto",
  "sugestoes": [
    "Localização da loja",
    "Agendar visita",
    "Falar com atendente"
  ],
  "acoes": [
    {
      "tipo": "link",
      "texto": "Ver no mapa",
      "url": "https://maps.example.com/loja"
    }
  ]
}

Webhooks

Também pode configurar webhooks para receber notificações em tempo real sobre eventos do chatbot:

1. Aceda ao painel de administração do chatbot.
2. Vá para "Configurações" > "Integrações" > "Webhooks".
3. Adicione o URL do seu endpoint que receberá as notificações.
4. Selecione os eventos que deseja monitorizar (ex: nova mensagem, transferência para humano).
5. Configure um token secreto para validar as requisições.

Formato das Notificações de Webhook

{
  "evento": "nova_mensagem",
  "timestamp": "2025-10-22T13:45:30Z",
  "chatbotId": "abc123",
  "conversaId": "conv_456789",
  "usuarioId": "user_12345",
  "dados": {
    "mensagem": "Preciso de ajuda com meu pedido",
    "resposta": "Claro, posso ajudar. Qual é o número do seu pedido?",
    "sentimento": "neutro",
    "intencao": "suporte_pedido"
  }
}

Integração com Sistemas de CRM e Helpdesk

A GPTuga oferece integrações nativas com os principais sistemas de CRM e helpdesk do mercado:

• Salesforce - Sincronize conversas com leads e casos, atualize campos de contato.
• Zendesk - Crie tickets automaticamente, transfira conversas para agentes.
• HubSpot - Integre com o chat do HubSpot, atualize registros de contatos.
• Freshdesk - Crie tickets e associe conversas a clientes existentes.
• Microsoft Dynamics - Sincronize dados de clientes e conversas.

Para configurar estas integrações, aceda a "Configurações" > "Integrações" > "CRM e Helpdesk" no painel de administração do chatbot.

Chatbots - Personalização

A plataforma da GPTuga permite personalizar diversos aspetos do seu chatbot para alinhá-lo à identidade da sua marca e às necessidades específicas do seu negócio.

Personalização Visual

Pode personalizar a aparência do widget de chat para websites através do painel de administração ou via código:

Opções de Personalização Visual

Exemplo de Configuração Visual

<script>
  window.GPTugaSettings = {
    chatbotId: "SEU_CHATBOT_ID",
    position: "bottom-right",
    primaryColor: "#005E00",
    secondaryColor: "#CE1021",
    backgroundColor: "#F8F8F8",
    textColor: "#333333",
    fontFamily: "Montserrat, sans-serif",
    logoUrl: "https://seusite.com/logo.png",
    avatarUrl: "https://seusite.com/avatar.png",
    borderRadius: "15px"
  };
</script>
<script src="https://cdn.gptuga.pt/chatbot.js" async></script>

Personalização de Comportamento

Além da aparência, pode personalizar como o chatbot se comporta:

Opções de Comportamento

Personalização de Conteúdo

Pode personalizar o conteúdo e o conhecimento do seu chatbot através do painel de administração:

Tipos de Conteúdo Personalizável

• Base de Conhecimento - Adicione documentos, FAQs e artigos para que o chatbot possa responder perguntas específicas.
• Fluxos de Conversa - Crie fluxos estruturados para guiar os usuários em processos específicos.
• Respostas Rápidas - Configure respostas para perguntas frequentes ou palavras-chave específicas.
• Personalidade - Defina o tom de voz, estilo de comunicação e "personalidade" do chatbot.
• Entidades Personalizadas - Ensine o chatbot a reconhecer termos específicos do seu negócio ou setor.

Exemplo de Configuração de Personalidade

{
  "nome": "Ana",
  "tom": "profissional_amigavel",
  "descricao": "Assistente virtual especializada em suporte técnico para produtos de software",
  "caracteristicas": [
    "prestativa",
    "paciente",
    "técnica mas sem jargão excessivo",
    "eficiente"
  ],
  "exemplos_de_resposta": [
    {
      "pergunta": "Não consigo fazer login",
      "resposta": "Entendo a sua frustração. Vamos resolver isso juntos! Primeiro, poderia verificar se o Caps Lock está desativado? Muitas vezes, senhas digitadas com maiúsculas/minúsculas incorretas causam esse problema."
    },
    {
      "pergunta": "Quanto custa o plano premium?",
      "resposta": "O nosso plano Premium está disponível por 29,90€ mensais. Ele inclui todas as funcionalidades do plano básico, mais acesso a relatórios avançados e suporte prioritário. Posso enviar-lhe mais detalhes sobre os benefícios deste plano, se desejar."
    }
  ]
}

Personalização Avançada

Para casos de uso mais complexos, a GPTuga oferece opções avançadas de personalização:

API de Personalização

Utilize a nossa API para personalizar dinamicamente o comportamento do chatbot com base em dados externos:

Webhooks de Personalização

Configure webhooks para que o seu sistema possa influenciar o comportamento do chatbot em tempo real:

• Pré-processamento de Mensagens - Modifique ou enriqueça mensagens antes que sejam processadas pelo chatbot.
• Pós-processamento de Respostas - Modifique ou enriqueça respostas antes que sejam enviadas ao usuário.
• Middleware de Contexto - Adicione informações contextuais à conversa com base em dados externos.

Exemplo de Webhook de Pré-processamento

// Exemplo de endpoint para pré-processamento de mensagens
app.post('/chatbot/preprocessamento', (req, res) => {
  const { mensagem, usuarioId, conversaId } = req.body;
  
  // Buscar informações do usuário no CRM
  const dadosUsuario = buscarUsuarioNoCRM(usuarioId);
  
  // Adicionar contexto à mensagem
  const mensagemEnriquecida = {
    texto: mensagem.texto,
    contexto: {
      ...mensagem.contexto,
      cliente: {
        tipo: dadosUsuario.tipo,
        plano: dadosUsuario.plano,
        valorGasto: dadosUsuario.valorGasto,
        ultimaCompra: dadosUsuario.ultimaCompra
      }
    }
  };
  
  res.json({ mensagem: mensagemEnriquecida });
});

Chatbots - Formação

A formação adequada é essencial para garantir que o seu chatbot forneça respostas precisas e relevantes. A plataforma da GPTuga oferece várias opções para formar e melhorar continuamente o desempenho do seu assistente virtual.

Métodos de Formação

Existem várias maneiras de formar o seu chatbot na plataforma GPTuga:

1. Base de Conhecimento

Alimente o chatbot com documentos e informações relevantes:

• Carregamento de Documentos - Faça o carregamento de PDFs, DOCs, ou ficheiros de texto com informações sobre produtos, serviços, políticas, etc.
• URLs - Forneça URLs de páginas web que contêm informações relevantes (ex: páginas de FAQ, artigos de apoio).
• Entrada Manual - Adicione informações diretamente através da interface de administração.

2. Pares de Pergunta-Resposta

Crie exemplos específicos de perguntas e as suas respostas ideais:

• Interface de Administração - Adicione pares de pergunta-resposta diretamente no painel.
• Carregamento em Massa - Importe pares de pergunta-resposta a partir de ficheiros CSV ou Excel.
• API de Formação - Adicione pares programaticamente através da API.

3. Aprendizado a partir de Conversas

Melhore o chatbot com base em interações reais:

• Revisão de Conversas - Reveja conversas passadas e marque respostas corretas/incorretas.
• Feedback de Utilizadores - Utilize o feedback dos utilizadores para identificar áreas de melhoria.
• Aprendizagem Automática - Configure o sistema para aprender automaticamente com base em padrões de interação.

API de Formação

Para automação do processo de formação, utilize a nossa API:

Adicionar Item à Base de Conhecimento

curl -X POST https://api.gptuga.pt/v1/chatbot/abc123/conhecimento \
-H "Authorization: Bearer SUA_CHAVE_API" \
-H "Content-Type: application/json" \
-d '{
  "titulo": "Política de Devolução",
  "conteudo": "Os clientes podem devolver produtos não utilizados em até 30 dias após a compra. Para iniciar uma devolução, entre em contato com nosso suporte pelo e-mail suporte@exemplo.com ou pelo telefone (11) 1234-5678. É necessário apresentar a nota fiscal e a embalagem original do produto.",
  "tags": ["devolução", "reembolso", "suporte"],
  "categoria": "políticas",
  "prioridade": 5
}'

Adicionar Par de Pergunta-Resposta

curl -X POST https://api.gptuga.pt/v1/chatbot/abc123/qa \
-H "Authorization: Bearer SUA_CHAVE_API" \
-H "Content-Type: application/json" \
-d '{
  "pergunta": "Como faço para trocar a senha da minha conta?",
  "resposta": "Para trocar a senha da sua conta, siga estes passos: 1) Faça login no site; 2) Acesse 'Minha Conta' no menu superior; 3) Clique em 'Segurança'; 4) Selecione 'Alterar Senha'; 5) Digite sua senha atual e a nova senha; 6) Clique em 'Salvar'.",
  "alternativas_pergunta": [
    "Esqueci minha senha",
    "Preciso mudar minha senha",
    "Como altero a senha da conta"
  ],
  "categoria": "conta",
  "tags": ["senha", "segurança", "login"]
}'

Melhores Práticas de Formação

Para obter os melhores resultados com o seu chatbot, considere estas práticas recomendadas:

Preparação

• Identifique as perguntas mais frequentes dos seus clientes.
• Organize o seu conteúdo em categorias lógicas.
• Prepare respostas claras e concisas para cada pergunta comum.
• Considere diferentes formas como os utilizadores podem fazer a mesma

  Durante o Treinamento

  • Forneça múltiplas variações de cada pergunta para melhorar o reconhecimento.
  • Inclua termos específicos do setor e jargões que seus clientes possam usar.
  • Mantenha um tom de voz consistente em todas as respostas.
  • Adicione contexto suficiente para que o chatbot entenda a intenção por trás das perguntas.

  Manutenção Contínua

  • Revise regularmente as conversas onde o chatbot não conseguiu responder adequadamente.
  • Atualize a base de conhecimento quando houver mudanças em produtos, serviços ou políticas.
  • Analise os relatórios de desempenho para identificar áreas de melhoria.
  • Colete e incorpore feedback dos usuários para refinar as respostas.

  Monitoramento e Análise

  A plataforma GPTuga oferece ferramentas abrangentes para monitorar o desempenho do seu chatbot:

  Métricas Disponíveis

  • Taxa de Resolução - Percentual de conversas resolvidas sem intervenção humana.
  • Tempo de Resposta - Tempo médio para o chatbot responder às mensagens.
  • Satisfação do Usuário - Avaliações e feedback dos usuários.
  • Tópicos Comuns - Assuntos mais frequentemente discutidos.
  • Perguntas Sem Resposta - Perguntas que o chatbot não conseguiu responder adequadamente.
  • Fluxo de Conversas - Visualização dos caminhos de conversa mais comuns.

  Relatórios e Dashboards

  Acesse relatórios detalhados no painel de administração:

  • Relatórios Diários/Semanais/Mensais - Resumos periódicos de desempenho.
  • Dashboards Personalizáveis - Crie visualizações específicas para suas necessidades.
  • Exportação de Dados - Exporte dados em formatos CSV, Excel ou JSON para análise externa.
  • Alertas - Configure alertas para métricas específicas (ex: queda na taxa de resolução).