# Text Classification API

## API Server

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

## APIキーの取得

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

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

## Text Classification API

<mark style="color:green;">`POST`</mark> `https://nlu-api.allganize.ai/api/inference`

#### Headers

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

#### Request Body

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

{% tabs %}
{% tab title="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
  }
}
```

{% endtab %}
{% endtabs %}

### Request Example

YOUR API KEYをプロジェクトのAPIキーに変更しなければなりません。[APIキーの取得](https://docs.allganize.ai/v/ja/text-classification-api#apikno)の項目をご参照ください。

```
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
  }
}

```