APIを使用して、インテント検出やタスクの実行に関するメトリクスデータを抽出します。検出されたインテント、未検出のインテントし、失敗したタスク、成功したタスク、実行ログに関連するメトリクス情報を取得するために使用することができます。
このAPIを使用するために、アプリは [メトリクス] の [ボットスコープ] を必要とします。
POST https://{{host}}/api/public/bot/{{BotID}}/getAnalytics
パスパラメータ
| パラメータ | 必須/任意 | 説明 |
|---|---|---|
| ホスト | 必須 | 環境URL（例： https://bots.kore.ai） |
| BotID | 必須 | ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。 |
本文パラメータ
| パラメータ | 必須/任意 | 説明 |
|---|---|---|
| type | 必須 |
リクエストされるメトリクスのタイプは以下の通りです。
|
| filters | 必須 | 結果セットをフィルタリングするために、以下の詳細を含むオブジェクト |
| from | 必須 | 記録を考慮する必要のある開始タイムスタンプです。 |
| to | 必須 | 記録を考慮する必要のある終了タイムスタンプです。 |
| limit | 必須 | 取得される記録の数です。 |
| チャネル | 任意 | メトリクスの対象となるチャネルです。 |
| channelUIds | 任意 | メトリクスに含まれるユーザーID（チャネル指定）です。 |
| isAmbiguous | 任意 | あいまいなインテントを含めるかどうか、TrueまたはFalseを設定します。 |
| isDeveloper | 任意 | 開発者メトリクスを含めるかどうか、TrueまたはFalseを設定します。 |
| trained | 任意 | トレーニング済みインテントを含めるかどうか、TrueまたはFalseを設定します。 |
| taskId | 任意 | タスクIDに基づいてフィルタリングします。 |
| userId | 任意 | ユーザーIDに基づいてフィルタリングします。 |
| tags | 任意 | カスタムタグに基づいてフィルタリングします。 Usage: "tags": { "and": [ { "name": "user", "values": ["uservalue"], "type": "user" }, { "name": "message", "values": ["mvalue"], "type": "message" } ] }
|
| sort | 任意 | 結果をソートします。 Usage: "sort": { "order": "<desc/asc>", "by": "<column name>" }
|
| skip | 任意 | 結果セットからスキップされるレコードの数です。 |
認証
以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。
auth: {{JWT}}
応答のコンテンツタイプ
application/json
サンプルリクエスト
curl -X POST \ https://{{host}}/api/public/bot/{{bot_id}}/getAnalytics \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -H 'content-type: application/json' \ -d '{ "type": "successintent", "filters": { "from": "2020-08-11T17:25:09.698Z", "to": "2020-08-21T17:25:09.698Z", "tags": { "and": [ { "name": "us2", "values": [ "ss" ], "type": "user" } ] }, "channel": [ "rtm" ], "channelUIds": [ "test@kore.xyz" ], "isAmbiguous": false, "isDeveloper": true, "trained": false, "taskId": [ "dg-xxxx" ], "userId": [ "u-5e4xxx85-f12e-53e2-929e-01xx7156xxx8" ] }, "limit": 50 }'
サンプル応答
{ "moreAvailable": true, "totalCount": 49, "result": [ { "messageId": "ms-439aa365-5240-52bf-ad10-bb0ef7b0d3c2", "utterance": "newTask", "intent": "newTask", "userId": "u-5e4xxx85-f12e-53e2-929e-01xx7156xxx8", "channelUId": "test@kore.xyz", "language": "en", "timestamp": "2020-08-20T18:49:19.877Z", "pinned": false, "channel": "rtm", "taskName": "newTask", "customTags": { "userTags": { "name": "us2", "value": "ss" }, "sessionTags": [], "messageTags": [] }, "NLAnalysis": {} }, { "messageId": "ms-2cc0b4aa-2f95-5524-8b7b-2442929b3cf5", "utterance": "newTask", "intent": "newTask", "userId": "u-5e4xxx85-f12e-53e2-929e-01xx7156xxx8", "channelUId": "test@kore.xyz", "language": "en", "timestamp": "2020-08-20T18:49:14.237Z", "pinned": false, "channel": "rtm", "taskName": "newTask", "customTags": { "userTags": { "name": "us2", "value": "ss" }, "sessionTags": [], "messageTags": [] }, "NLAnalysis": {} } ] }