Referência

API

Dois caminhos: decidir e listar modelos.

POST /v1/decidir

Julga um estado contra uma ou mais perguntas.

Campo	Tipo	Obrigatório	Descrição
`modelo`	string	não	`katuok-1` (padrão)
`estado`	string ou objeto	sim	Texto, ou `{ "texto": "...", "imagem": "<base64>" }`
`perguntas`	objeto	sim	De 1 a 64 perguntas, cada uma com um nome seu

Campo	Tipos	Descrição
`tipo`	todos	`escolha`, `sim_nao` ou `nota`
`instrucao`	todos	A pergunta, em linguagem natural
`opcoes`	escolha	Objeto `nome: descrição` ou lista de nomes; de 2 a 26
`criterio`	sim_nao	O que conta como "sim" (opcional)
`niveis`	nota	Objeto ou lista, em ordem do menor para o maior

Campo	Descrição
`respostas.<nome>.escolha`	Opção escolhida (escolha)
`respostas.<nome>.sim`	Probabilidade de sim (sim_nao)
`respostas.<nome>.resposta`	"sim" ou "não" (sim_nao)
`respostas.<nome>.nota`	Nível mais provável (nota)
`respostas.<nome>.media`	Nota esperada, de 1 ao número de níveis (nota)
`respostas.<nome>.probabilidades`	Probabilidade de cada opção ou nível
`respostas.<nome>.certeza`	Confiança na resposta, de 0 a 1
`uso.perguntas`	Quantas perguntas foram julgadas
`ms`	Tempo de decisão, em milissegundos

{ "modelos": [ { "id": "katuok-1", "entradas": ["texto", "imagem"], "tipos": ["escolha", "sim_nao", "nota"], "carregado": true } ] }

carregado diz se o modelo já está na placa de vídeo. Se estiver false, a próxima chamada demora cerca de 1 minuto.

Código	Quando
404	Modelo que não existe
422	Pedido mal formado: falta `instrucao`, tipo desconhecido, menos de 2 ou mais de 26 opções, imagem ilegível, mais de 64 perguntas
500	Falha interna; tente de novo