Retrieving the List of Sentimental Parameters

This API is used to retrieve the list of sentimental parameters.

For information on how to use sentiment analysis, please see Sentiment Analysis.

Endpoint

GET https://acp-dsrpp.amivoice.com/v1/sentiment-analysis/{language}/result-parameters.json

Request

Request Parameters

Parameter Name	Required	Description
language	●	Specifies the language for display. Currently, only ja is supported.

Authentication

Please specify the APPKEY in the Authorization header.

Authorization: Bearer {APPKEY}

Response

On Success

The HTTP status code 200 is returned. The body contains the sentiment analysis result parameters formatted in JSON.

Result Format:

{
  "sentiment_analysis": {
    "result_parameters": {
      "display_language": "ja",
      "definitions": [/*...Explanation for each parameter...*/]
      }
    }
}

The explanation for each parameter is provided in an array format for each sentimental parameter, containing the following items:

Parameter	Description
name	Name included in the sentiment analysis result response
display_name	Sentimental parameter name as listed in the manual
minimum	Minimum value
maximum	Maximum value

On Failure

When a failure occurs, an HTTP status code other than 200 is returned. The body contains an error message formatted in JSON.

Response Example:

{
    "message":"No authorization header"
}

Table of HTTP status codes and error messages:

HTTP Status Code	Error Message	Description
400	No authorization header	Authorization header is not set
400	Invalid authentication credentials	Token is not set
400	Invalid authorization header format	The format of the Authorization header is invalid
401	Failed to authorize for the app_key	Authentication failed with the specified APPKEY