API Guide

機械学習の発話のエクスポートのステータスAPI

機械学習の発話のエクスポートコピーのダウンロードリンクを取得します。このAPIを使用するために、アプリは [発話のインポート] のボットビルダーのAPIスコープを必要とします。あるいは、[テストとトレーニング] にある [発話のエクスポート] の管理者のAPIスコープを必要とします。 GET https://{{host}}/api/public/bot/{{BotID}}/mlexport/status パスパラメータパラメータ必須/任意説明ホスト必須環境URL（例： https://bots.kore.ai）ボットID 必須ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。認証以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}} 応答のコンテンツタイプ application/json サンプルリクエスト curl -X GET \ https://{{host}}/api/public/bot/{{bot ID}}/mlexport/status \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -H 'content-type: application/json' \ サンプル応答 { "_id": "ds-aadcadee-befe-559c-b15f-31b87b0d8e63", "status": "SUCCESS",…

デバッグログAPI

特定の会話のデバッグログを取得するには（現在はIVRチャネルのみサポート）。このAPIを使用するために、アプリは [デバッグログ] の [ボットビルダーのAPIスコープ] を必要とします。 GET https://{{host}}/api/{{version}/{{BotID}}/debuglogs?identity={{identity}}&channelType={{channelType}}&minimumInfo=true&limit=5&offset=300&timezone={{timezone}} クエリパラメータパラメータ説明ホスト環境URL（例） https://bots.kore.ai BotID ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。 ID 呼び出しに関連付けられた一意のID。 channelType "ivrVoice" 現在サポートされているチャネル minimumInfo 任意のフィールドです。サマリのみを取得する場合は"true"を設定 offset ログの取得を開始するページ番号を指定します。指定されていない場合は、ログのリストの最初のページである0から開始されます limit 取得する記録の数です。最大値は50です timezone 例：America/New_York fromDate ログがリクエストされた日付。有効なフォーマット（yyyy-mm-dd）または有効なタイムスタンプ toDate ログがリクエストされるまでの日付。有効なフォーマット（yyyy-mm-dd）または有効なタイムスタンプ認証以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}} 応答のコンテンツタイプ application/json サンプルリクエスト curl -X GET \ https://{{host}}/api/{{version}}/{{BotID}}/debuglogs?identity={{id}}&channelType=ivrVoice&minimumInfo=true&limit=5&offset=300&timezone=America/New_York' \ -H 'auth:…

既存のボットAPIにボットをインポート

Billing Sessions API

This API retrieves the list of individual billing sessions created for a bot so that you can review them for correctness and reconciliation. . This API is available in BT and BAC app scopes. To use this API, an app needs the Bot Builder API scope of Billing Sessions. OR…

Install Sample Bot API

To install a sample bot. To use this API, needs the Admin app scope of Bot Create under Bot Definition. POST https://{{host}}/api/public/samplebots/{{botId}}/add Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai BotID Required Bot ID or Stream ID. You can access it from the General Settings page…

Get Extraction Questions – KG

To get a Get KG Extraction Questions. To use this API, app needs the Admin API Scope of KnowlegdeGraph. GET https://{{host}}/api/public/stream/{{streamId}}/qna/{{ExtractionId}}/questions?limit=&offset= Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai streamId Required Bot ID or Stream ID. You can access it from the General Settings page of…

Get Extractions History – KG

To get a list of KG Extractions history. To use this API, app needs the Admin API Scope of KnowlegdeGraph. GET https://{{host}}/api/public/stream/{{streamId}}/qna/history?language=en Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai streamId Required Bot ID or Stream ID. You can access it from the General Settings page…

Add Questions from Extract – KG

To add specific questions to the Knowledge graph. To use this API, the app needs the Admin API Scope of KnowlegdeGraph. POST https://{{host}}/api/public/bot/{{botId}}/faqs/bulk?language=en Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai botId Required Bot ID. You can access it from the General Settings page of the…

Get KnowledgeTasks – KG

To get a listing knowledge Tasks with the nodes. To use this API, the app needs the Admin API Scope of KnowlegdeGraph. GET https://{{host}}/api/public/bot/{{botId}}/knowledgeTasks?language=en Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai botId Required Bot ID. You can access it from the General Settings page of…

Extraction from file or URL – KG

To import the extract using file or URL. To use this API, the app needs the Admin API Scope of KnowlegdeGraph. POST https://{{host}}/api/public/bot/{{botId}}/qna/import?language=en Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai botId Required Bot ID. You can access it from the General Settings page of the…