Documentação

Usando API do Nama App

Depois de treinar e testar seu modelo, você pode integrá-lo em suas aplicações usando a API da plataforma Nama App. Acesse a aba Consumir e obtenha sua chave de API e forneça a documentação técnica para sua equipe de desenvolvimento.

Você encontrará as ferramentas necessárias para utilizar nossa API de forma eficaz.

  • Searcher API: Permite buscar e recuperar informações no seu conjunto de dados. Para utilizá-la é necessário informar Sua Chave API, ela funciona como um identificador.
  • API Request: você encontrará as informações necessárias para fazer uma solicitação à nossa API. Através do cURL obterá os detalhes sobre os parâmetros necessários, formatos de solicitação aceitos e qualquer outra informação relevante para garantir uma comunicação bem-sucedida com nossa API.
  • Code Examples: O exemplo é uma maneira útil de entender como integrar nossa API em seus próprios projetos.
  • API Response: Após fazer a requisição à nossa API, é importante entender como interpretar e utilizar a resposta. Na seção de API Response, você encontrará as informações para os tipos de resposta que nossa API pode fornecer.

/

Para realizar a mudança de Prompt do seu Modelo através da Nama API siga estes passos:

1 - Capture o seu token dentro do Nama app

No seu Modelo, acesse a aba Consumir e na cURL obtenha os dados do token no campo "generation_presset":

2- Obtenha o ID e o Name do preset

Colete o ID e o name do Preset que deverá ser usado na requisição. Para isso use cURL abaixo inserindo seu Token no Header:

curl --request GET  
--url <https://api.nama.ai/searcher/v1/generational-pressets>  
--header 'Authorization: Bearer [INSIRA AQUI SEU TOKEN]'

Após a requisição bem sucedida, copie o "ID" e o "name" , como no exemplo abaixo:

"id": 1234
"active": true,
 "name":"presset_09114bc4-27eb-403c-8edc-d3582501bb91"

3- Altere o prompt

Utilize o modelo de cURL abaixo para realizar a alteração de prompt necessária:

<https://api.nama.ai/searcher/v1/generational-pressets/>

curl --request PUT  
--url <https://api.nama.ai/searcher/v1/generational-pressets/[INSIRA AQUI SEU ID]>  
--header 'Authorization: Bearer [INSIRA AQUI SEU TOKEN]'  
--header 'Content-Type: application/json'  
--data '{  
"name": "[INSIRA AQUI SEU GENERATIONAL_PRESSET]",  
"template_prompt": "[INSIRA AQUI SEU PROMPT]"  
}'

📘

Importante

Note que o próprio cURL deverá vir com as definições de prompt com campo "template_prompt" e que o mesmo deve considerar a formatação de "sequências de escape", necessárias para serem devidamente
processados pela API.

Texto Prompt

1.Adote um tom de voz de atendente ao interagir com o cliente da [NOME EMPRESA],
oferecendo suporte e respostas sobre os produtos e serviços da empresa.

2.Utilize os seguintes parâmetros como sua principal fonte de informação para
responder às dúvidas, embora a resposta exata possa não estar sempre
explicitamente listada:

Opção "{CONTENT_NAME1}": "{SUBJECT1}",
Contexto – "{CONTEXT1}";\r\n - Opção "{CONTENT_NAME2}": "{SUBJECT2}",
Contexto – "{CONTEXT2}";\r\n - Opção "{CONTENT_NAME3}": "{SUBJECT3}",
Contexto – "{CONTEXT3}";\r\n - Opção "{CONTENT_NAME4}": "{SUBJECT4}",

3.Forneça respostas apenas quando estiver seguro de que a
informação solicitada está contida nos parâmetros acima. Caso não encontre uma
resposta adequada ou verificável com a fonte da verdade, opte por não
responder.

4.Evite responder a perguntas nocivas ou que não estejam
relacionadas ao tema "atendimento e suporte" da [NOME EMPRESA], optando por
respostas evasivas nesses casos.

5.Mantenha a precisão das informações,
evitando confundir ou misturar dados distintos presentes nas opções
fornecidas.

6.Lembre-se de que você está auxiliando diretamente um
colaborador da [NOME EMPRESA]; portanto, não instrua o funcionário a entrar em contato
com a [NOME EMPRESA] para obter suporte.

7.Assegure-se de que todas as
informações fornecidas sejam válidas e possam ser verificadas com base nos
parâmetros estabelecidos, evitando oferecer respostas caso não tenha
informações suficientes para fundamentá-las.

Resuma o resultado com
comprimento máximo de até 380 caracteres;

4- Crie uma sequências de escape

Essas sequências de escape podem ser desafiadoras para quem não é Desenvolvedor. Então, uma forma de facilitar é pedir direto para o Chat GPT 4 te ajudar a formatar, para isso um prompt útil pode ser:

" Transforme o texto abaixo em uma _string _com as sequencias de escape. [Inserir o texto]"

Exemplo:

Nós do Nama App estamos aqui para garantir que sua experiência seja o mais suave possível.

Integrações com Outras Plataformas

A plataforma Nama App oferece integração com outras ferramentas e plataformas para facilitar a implementação do seu modelo. Por exemplo, você pode integrar a Nama com chatbots ou criar páginas de busca personalizadas com a marca e as cores da sua empresa. Para obter ajuda com integrações específicas, entre em contato com a equipe de suporte da Nama.


Dúvidas, problemas ou sugestões?
Envie email para [email protected]


What’s Next