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.

API Server

nlu-api.allganize.ai is Allganize's NLU API endpoint. If you are using on-prem, please use your API endpoint.

Getting API KEY

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.

Provide your API KEY in the request header API-KEY.

Error Messages

Please read the error message you get if you don't get the response that you expected. For example, if you don't use the right HTTP method for the API, you'll get this type of error as response:

{“error”: “Method Not Allowed POST: /webapi/faq_feedbacks”}

post
Review Analysis API

https://nlu-api.allganize.ai/api/inference
Request
Response
Request
Headers
API-KEY
required
string
Your API Key can be found on your dashboard Settings menu, under the General tab.
Body Parameters
text
required
string
Input text you want to analyze.
Response
200: OK
The response contains a list of the sentiments of each category. category: The category of the sentiment. Categories are defined in your NLU API dashboard. sentiment: The sentiment analysis result. Please contact Allganize to define sentiments.
{
"inputText": STRING,
"reviewSentiments": [
{
"category": STRING,
"sentiment": STRING
}, ...
]
}

Request Example

Please replace YOUR_API_KEY to your one in the example below. Please see getting-api-key section.

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"

Response Example

{
"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"},
{"category": "cleanliness", "sentiment": "4"},
{"category": "rooms", "sentiment": "3"},
{"category": "sleep quality", "sentiment": "4"},
{"category": "service", "sentiment": "1"}
]
}