Review Analysis API
Review Analysis API identifies recurring themes and topics in comments and reviews, allows retailers to understand how their customers feel without having to read every review individually.
nlu-api.allganize.ai is Allganize's NLU API endpoint. If you are using on-prem, please use your API endpoint.
The NLU API uses API keys to authenticate requests that you can find in the Allganize NLU API dashboard. Go to Settings > General to find your API key. If you don't have an account yet, you can create one here.
post
https://nlu-api.allganize.ai
/api/inference
Review Analysis API
curl https://nlu-api.allganize.ai/api/inference \
-d '{"text": "Cannot recommend highly enough! Absolutely fantastic apartment in a fantastic area! Great thoughtful touches and close amenities! Good vibes all round!"}' \
-H "Content-Type: application/json" \
-H "API-KEY: YOUR_API_KEY"
{
"inputText": "Cannot recommend highly enough! Absolutely fantastic apartment in a fantastic area! Great thoughtful touches and close amenities! Good vibes all round!"
"reviewSentiments": [
{"category": "location", "sentiment": "2", "keywords": [{"text": "in a fantastic area","index": 63}]},
{"category": "rooms", "sentiment": “3”, “keywords": [{"text": “Absolutely fantastic apart”ment, ”index": 32}]},
{"category": "service", "sentiment": “1”, "keywords": [{"text": “Great thoughtful touches”, ”index": 84}]}
]
}
Please read the error message you get if you don't get the response that you expected.
Status Code | Error Code | Name | Message | Description |
500 | 7000 | API Error | Something went wrong | Default API error message for any uncategorized errors. |
403 | 7001 | Invalid API Key | API-KEY is not valid. | When the API Key requested to the header is invalid. |
403 | 7002 | Invalid JSON | Cannot decode the requested JSON body. | When the requested JSON is not decodable. |
400 | 7003 | Invalid Parameter | Requested parameters are not valid. 'text' is empty. | When the requested parameter is invalid (for example, when requesting inference with empty text). |
403 | 7004 | Payment error | billing error. | Overall payment related errors, e.g., payment is overdue |
405 | - | Wrong HTTP Method | - | When the HTTP method used is not valid. |
{
"type": "APIError",
"code": 7000,
"message": "Something went wrong."
}
Last modified 1yr ago