armazenar avaliação

Este endpoint é usado para armazenar avaliações de respostas geradas pelo endpoint(https://api.nama.ai/searcher/v1/search). O usuário salva a pergunta realizada, o objeto de respostas recebidas, a resposta gerada pelo modelo (generativeAnswer), além dos IDs do modelo e dataset, e a avaliação do usuário.

URL

POST https://api.nama.ai/api/v1/assessments

Autenticação

Este endpoint requer autenticação via Bearer Token. O token deve ser enviado no cabeçalho da requisição.

Exemplo de Cabeçalhos:

Authorization: Bearer <seu_token_de_acesso>
Content-Type: application/json

Corpo da Requisição

A requisição deve ser feita em formato JSON com os seguintes campos:

Parâmetros

Campo	Tipo	Obrigatório	Descrição
`question`	string	Sim	A pergunta realizada pelo usuário.
`answers`	object	Sim	Deve conter o objeto de respostas recebido do endpoint https://api.nama.ai/searcher/v1/search.
`generativeAnswer`	string	Sim	A resposta gerada pelo modelo de linguagem.
`modelId`	integer	Sim	ID do datamodel usado para gerar a resposta.
`datasetId`	integer	Sim	ID do dataset utilizado para a consulta.
`evaluation`	string	Sim	Avaliação do usuário sobre a resposta (ex.: "positive", "negative").
`feedback`	string	Não	Feedback adicional do usuário sobre a resposta. Campo utilizado para armazenar o feedback escrito do usuário final referente a resposta gerada pela IA Nama.
`extra`	object	Não	Informações extras como opiniões negativas (caso a avaliação seja "negative").

Exemplo de Corpo da Requisição

{
    "question": "Quero um exemplo de uso com tabela",
    "answers": {
        "search": [
            {
                "content": {
                    "name": "Exemplo 2: Tabelas e Links",
                    "subject": "Markdown",
                    "created_at": "2024-09-20T10:11:37.097637-03:00",
                    "updated_at": "2024-09-20T10:11:37.275424-03:00"
                },
                "score": 1,
                "context": "# Planos de Assinatura...",
                "date": "2000-01-01 00:00:00"
            }
        ],
        "generational": {
            "content": "Resposta do generativo"
        }
    },
    "generativeAnswer": "Resposta do generativo",
    "modelId": 2215,
    "datasetId": 3059,
    "evaluation": "negative",
    "feedback": "teste",
    "extra": {
        "negative_opinions": ["other"]
    }
}

Respostas

Sucesso - 200 OK

Em caso de sucesso, a API retornará um código 200 OK com o ID do registro salvo:

{
    "id": 123
}