Analisar um registro
Devolve sugestões de melhoria para um produto, pedido ou cliente.
É a pergunta "o que dá para melhorar neste registro?" sem abrir uma conversa. A VI inspeciona o produto, o pedido ou o cliente e devolve sugestões: produto sem foto, sem descrição, com margem negativa ou estoque zerado; pedido parado; cliente que não compra há tempo. As sugestões vêm de regras fixas (source: rule) e, quando há previsões para o registro, de previsões (source: prediction).
Por URL (GET)
Aceita os dois parâmetros na URL. A versão POST abaixo faz o mesmo com os parâmetros no corpo JSON.
/api/v1/admin/intelligence/analyze-entityAdminAnalisar um registro (GET)
Cabeçalhos
AuthorizationstringobrigatórioBearer $TOKEN. Token de acesso de um administrador (veja Tokens).Parâmetros de consulta
entity_typestringobrigatórioproductorderuserTipo do registro. Aceita também os apelidos
products, produto, produtos, orders, pedido, pedidos, users, customer, customers, cliente, clientes.entity_iduuidobrigatórioId do registro.
Exemplo de requisição
Resposta
200Sugestões
Campos da resposta
entity_typestringTipo normalizado:
product, order ou user. Vazio quando o tipo enviado não é reconhecido.entity_idstringId recebido.
suggestionsarraySugestões. Podem vir vazias.
suggestions[].titlestringTítulo curto.
suggestions[].bodystringExplicação e o que fazer.
suggestions[].severitystringGravidade (por exemplo
info ou warning).suggestions[].sourcestringrulepredictionOrigem da sugestão.
totalintegerQuantidade de sugestões.
Erros
| Status | Quando | Corpo |
|---|---|---|
| 401 | Sem token ou token inválido/expirado. | {"error":"missing authorization header"} ou {"error":"invalid or expired token"} |
| 403 | O administrador não tem nenhum dos privilégios exigidos. | {"error":"insufficient privileges","privilege_required_any":["intelligence_use_chat","view_reports"]} |
| 400 | entity_type ou entity_id ausente. | {"error":"entity_type and entity_id are required"} |
Por corpo (POST)
Mesma análise, com os parâmetros no corpo JSON (ou, se faltarem no corpo, na URL).
/api/v1/admin/intelligence/analyze-entityAdminAnalisar um registro (POST)
Cabeçalhos
AuthorizationstringobrigatórioBearer $TOKEN. Token de acesso de um administrador (veja Tokens).Content-Typestringobrigatórioapplication/json.Corpo da requisição
entity_typestringobrigatórioproductorderuserTipo do registro, como no GET.
entity_iduuidobrigatórioId do registro.
Exemplo de requisição
Resposta
200Sugestões
Erros
| Status | Quando | Corpo |
|---|---|---|
| 401 | Sem token ou token inválido/expirado. | {"error":"missing authorization header"} ou {"error":"invalid or expired token"} |
| 403 | O administrador não tem nenhum dos privilégios exigidos. | {"error":"insufficient privileges","privilege_required_any":["intelligence_use_chat","view_reports"]} |
| 400 | Corpo ilegível, ou entity_type/entity_id ausente. | {"error":"invalid request body"} ou {"error":"entity_type and entity_id are required"} |