感情パラメータ一覧の取得

感情パラメータの一覧を取得するためのAPIです。

感情分析を利用する方法は、感情分析を参照してください。

エンドポイント

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

リクエスト

リクエストパラメータ

パラメータ名	必須	説明
language	●	表示用の言語を指定します。現在対応しているのは、jaのみです。

認証

APPKEY をAuthorizationヘッダーに指定してください。

Authorization: Bearer {APPKEY}

レスポンス

成功時

HTTPステータスコードは200を返します。ボディにはJSONでフォーマットした感情分析結果のパラメータを返します。

結果フォーマット:

{
  "sentiment_analysis": {
    "result_parameters": {
      "display_language": "ja",
      "definitions": [/*...パラメータ毎の説明...*/]
      }
    }
}

パラメータ毎の説明は、以下の項目のデータが感情パラメータごとに配列形式で得られます。

パラメータ	説明
name	感情分析結果のレスポンスに含まれる名前
display_name	マニュアルに記載されている感情パラメータ名
minimum	最小値
maximum	最大値

失敗時

失敗したときは200以外のHTTPのステータスコードを返します。ボディにはJSONでフォーマットされたエラーメッセージを返します。

レスポンスの例:

{
    "message":"No authorization header"
}

HTTPステータスコードとエラーメッセージの一覧表です。

HTTP ステータスコード	エラーメッセージ	説明
400	No authorization header	Authorization ヘッダが設定されていない
400	Invalid authentication credentials	トークンが設定されていない
400	Invalid authorization header format	Authorization ヘッダのフォーマットが不正
401	Failed to authorize for the app_key	指定された APPKEY による認証が失敗