Documentação

Identificando o Usuário

Identifique o usuário que realizou a pergunta

O campo extra permite a identificação do usuário que realizou a pergunta.

Ele possibilita o envio de informações adicionais, como nome e e-mail do usuário, garantindo um melhor rastreamento e personalização das interações.

Exemplo de Requisição POST Endpoint padrão

curl --location --request POST '<https://api.nama.ai/searcher/v1/search'>  
  --header 'Authorization: Bearer SEU_TOKEN_AQUI'  
  --header 'Content-Type: application/json'  
  --data-raw '{  
    "dataset": "PDF - Livro_de_receitas_saude",  
    "question": "your question",  
    "extra": {  
        "name": "Jamerson Oliveira",  
        "email": "[[email protected]](mailto:[email protected])"  
    },  
    "generative_preset": "preset_cbd0734912ed"  
  }'

Exemplo de Requisição POST Endpoint Stream

curl --location --request POST '<https://ai-search-api.nama.ai/api/v1/stream/search'>  
  --header 'Authorization: Bearer SEU_TOKEN_AQUI'  
  --header 'Content-Type: application/json'  
  --data-raw '{  
    "dataset": "PDF - Livro_de_receitas_saude",  
    "question": "your question",  
    "extra": {  
        "name": "Jamerson Oliveira",  
        "email": "[[email protected]](mailto:[email protected])"  
    },  
    "generative_preset": "preset_cbd0734912ed"  
  }'

Estrutura do Campo extra

O campo extra deve ser incluído no corpo da requisição em formato JSON. Ele contém os seguintes atributos:

CampoTipoDescrição
nameStringNome do usuário que fez a pergunta.
emailStringE-mail do usuário para identificação.

📘

É recomendado o uso para melhor rastreamento.

Caso o campo extra não seja enviado, a requisição ainda será processada, mas sem informações sobre o remetente.

A implementação e o envio dessas informações ficam a cargo de quem utiliza a API.

Dúvidas, problemas ou sugestões?

Envie email para [email protected]