Text Classification API

Text Classification APIは、文章のインテントを分類し、これを活用してユーザーのニーズに合わせた最適のユーザーエクスペリエンスを提供します。

API Server

AllganizeのAPIエンドポイントはnlu-api.allganize.aiです。On-premプランのご利用の場合は、ご希望のAPIエンドポイントを使用してください。

APIキーの取得

すべてのNLU APIは、リクエストを検証するためにAPIキーを使用しています。APIキーはNLU APIのプロジェクト設定メニューから確認できます。NLU APIダッシュボードのアカウントがない場合は、こちらから生成してください。

RequestヘッダーのAPI-KEY に割り当てられたAPI KEY を入力してください。

Text Classification API

POST https://nlu-api.allganize.ai/api/inference

Headers

Name	Type	Description
API-KEY	string	割り当てられたAPIキーです。プロジェクト設定メニュー>一般タブから確認できます。

Request Body

Name	Type	Description
text	string	分析対象のテキストです。最大2000文字まで入力できます。2000文字以降の内容は自動で入力・分析されません。

200

Responseにはリクエストのあったテキストに対する分類結果が表示されます。

displayText: Text classificationの結果がテキストの形式で表示されます。分類類型はNLU APIのダッシュボードから定義することができます。

id: Text classificationの結果がIDの形式で表示されます。

confidence: AIモデルが算出したconfidence値を提示します。0と1の間の数字です。

{
  "inputText": STRING,
  "intent": {
    "id": NUMBER,
    "displayText": STRING,
    "confidence": NUMBER
  }
}

Request Example

YOUR API KEYをプロジェクトのAPIキーに変更しなければなりません。APIキーの取得の項目をご参照ください。

curl https://nlu-api.allganize.ai/api/inference \
-d '{"text": "火災保険の重要事項説明書の確認をしたい。"}' \
-H "Content-Type: application/json" \
-H "API-KEY: YOUR_API_KEY"

Response Example

{
  "inputText": "火災保険の重要事項説明書の確認をしたい。",
  "intent": {
    "id": 656,
    "displayText": "問い合わせ",
    "confidence": 0.7613087892532349
  }
}