Sentiment Analysis API

Sentiment analysis API uses machine learning to reveal the structure and meaning of text. You can extract information about people, places, and events, and better understand customer sentiment.

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
Sentiment 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 has a classified result for the requested text. displayText: The result of the sentiment analysis. POSITIVE, NEUTRAL or NEGATIVE. id: The result of the sentiment analysis in an ID form. confidence: It shows the confidence value from AI model. Shown as a number value between 0 and 1.
{
"inputText": STRING,
"intent": {
"id": NUMBER,
"displayText": STRING,
"confidence": NUMBER
}
}

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": "Loved the location and the breakfast. Would definitely stay here again!"}' \
-H "Content-Type: application/json" \
-H "API-KEY: YOUR_API_KEY"

Response Example

{
"inputText": "Loved the location and the breakfast. Would definitely stay here again!",
"intent": {
"id": 656,
"displayText": "POSITIVE",
"confidence": 0.9603047832230137
}
}