Uncategorised

サンプルボットをインストールします。 このAPIを使用するために、[ボット定義] の [ボットの作成] の管理アプリスコープを必要とします。 ポスト https://{{host}}/api/public/samplebots/{{botId}}/add パスパラメータ パラメータ 必須/任意 説明 ホスト 必須 環境URL（例： https://bots.kore.ai） BotID） 必須 ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。 認証 以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}} AccountId: {{accountId}} userId: {{userId}} bot-language : en 応答のコンテンツタイプ application/json サンプルリクエスト curl -X POST \ 'https://{{host}}/api/public/samplebots/{{bot_id}}/add' \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -H 'content-type: application/json' \ -H 'AccountId:…

ナレッジグラフの抽出に関する質問のリストを取得します。 このAPIを使用するために、アプリは [KnowlegdeGraph] の管理APIスコープを必要とします。 GET https://{{host}}/api/public/stream/{{streamId}}/qna/{{ExtractionId}}/questions?limit=&offset= パスパラメータ パラメータ 必須/任意 説明 ホスト 必須 環境URL（例： https://bots.kore.ai） streamId 必須 ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。 ExtractionId 必須 質問を取得する必要がある場所からのExtractionIdです。 クエリパラメータ パラメータ 必須/任意 説明 limit 任意 指定されていない場合、取得されるレコード数は50に設定されます。 offset 任意 指定されていない場合、スキップされるレコード数は0に設定されます。 認証 以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}} 応答のコンテンツタイプ application/json サンプルリクエスト curl -X POST \ https://{{host}}/api/public/stream/{{streamId}}/qna/{{ExtractionId}}/questions?limit=20&offset=0 \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -H…

ナレッジグラフの抽出履歴のリストを取得します。 このAPIを使用するために、アプリは [KnowlegdeGraph] の管理APIスコープを必要とします。 GET https://{{host}}/api/public/stream/{{streamId}}/qna/history?language=en パスパラメータ パラメータ 必須/任意 説明 ホスト 必須 環境URL（例： https://bots.kore.ai） streamId 必須 ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。 クエリパラメータ パラメータ 必須/任意 説明 language 必須 ボットの言語（例：英語なら「en」、ドイツ語なら「de」）です。 認証 以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}} 応答のコンテンツタイプ application/json サンプルリクエスト curl -X POST \ https://{{host}}/api/public/stream/{{streamId}}/qna/history?language=en \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -H 'content-type: application/json' サンプル応答 { "metaqnas": […

ボットのチャネルの有効化を開始するために使用されます。 このAPIを使用するために、アプリは [ChannelManagement] の [チャネル管理] の管理APIスコープを必要とします。 ポスト https://{{host}}/api/public/bot/channels クエリパラメータ パラメータ 必須/任意 説明 ホスト 必須 環境URL（例： https://bots.kore.ai） 本文パラメータ パラメータ 必須/任意 説明 BotId 必須 ボットID – ボットの [一般設定] ページからアクセスすることができます。 AppName 必須 このに関連するアプリは、ボットの [アプリを管理] ページから取得することができます。 ClientId 必須 このボットに関連するアプリのクライアントIDは、ボットの [アプリを管理] ページから取得することができます。 type 必須 このボットで有効にしたいチャネルです。チャネルタイプの詳細は以下の通りです。 rtm – ウェブ/モバイルSDK用 slack – Slack用 webhook – Webhook用 msteams…

アカウントからユーザーを削除します。 このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [セキュリティおよび管理] の [ユーザー管理] の管理APIスコープを必要とします。 削除 https://{{host}}/api/public/users 注意：この機能は、プラットフォームのバージョン7.1で導入されました。 クエリパラメータ パラメータ 説明 ホスト 環境URL（例： https://bots.kore.ai） 本文パラメータ パラメータ 説明 deleteEmailIdsまたはorgUserIds 情報が削除される各ユーザーのメールアドレスまたは組織のユーザーIDの配列 認証 以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}} 応答のコンテンツタイプ application/json サンプルリクエスト curl -X DELETE \ https://{{host}}/api/public/users \ -H 'Content-Type: application/json' \ -H 'auth: YOUR_JWT_ACCESS_TOKEN' \ -d '{ "deleteEmailIds"/"orgUserIds":["deskkore1@gmail.com"] }' サンプル応答 成功例： {"msg": "Users are…

[新しいボットとしてボットをインポート] は、ファイルをローカルサーバーにアップロードすることで生成されたファイルIDを使用し、アカウントオーナーのビルダーツールで新しいボットを作成するために使用されます。ファイルIDのアップロードおよび取得方法については、「ファイルAPIをアップロード」を参照してください。 このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [ボット定義] の [ボットをインポート] の管理APIスコープを必要とします。 ポスト https://{{host}}/api/public/bot/import クエリパラメータ パラメータ 説明 ホスト 環境URL（例： https://bots.kore.ai） 本文パラメータ パラメータ 説明 botDefinition 「ボットの定義ファイルID」 ファイルIDのアップロードおよび取得方法については、「ファイルAPIをアップロード」を参照してください。 configInfo 「ボットの設定ファイルID」 ファイルIDのアップロードおよび取得方法については、「ファイルAPIをアップロード」を参照してください。 botFunctions（任意） 「ボットの機能ファイルID」 ファイルIDのアップロードおよび取得方法については、「ファイルAPIをアップロード」を参照してください。 icon 「ボットのアイコンファイルID」 ファイルIDのアップロードおよび取得方法については、「ファイルAPIをアップロード」を参照してください。 name（任意） 「ボット名」 指定されていない場合は、既存のボットのコピーから取得されます。 purpose（任意） 「カスタマー」/「従業員」 指定されていない場合は、既存のボットのコピーから取得されます。 認証 以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}} 応答のコンテンツタイプ application/json サンプルリクエスト curl -X POST \ https://{{host}}/api/public/bot/import \ -H…

ボットのエクスポートリクエストのステータスを取得し、エクスポートが完了した後に、ボットのエクスポートコピーのダウンロードリンクを提供します。ボットのエクスポートAPIの開始についてはこちらを参照してください。 このAPIを使用するために、アプリは [ボット定義] の [ボットのエクスポート] の管理APIスコープを必要とします。 GEThttps://{{host}}/api/public/bot/{{BotID}}/export/status クエリパラメータ パラメータ 説明 ホスト 環境URL（例：https://bots.kore.ai BotID） ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。 認証 以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}} 応答のコンテンツタイプ application/json サンプルリクエスト curl -X GET \ https://{{host}}/api/public/bot/{{BotID}}/export/status \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ サンプル応答 { "_id": "ber-xxxxx-xxx-xxx-xxx-xxxxx", "botId": "st-xxxxx-xxx-xxx-xxx-xxxxx", "createdBy": "u-xxxxx-xxx-xxx-xxx-xxxxx", "exportType": "published", "requestType": "Botexport", "status": "success", "createdOn": "2018-12-05T07:18:40.028Z", "__v":…

使用済みボット定義および関連するすべてのコンポーネントをエクスポートするために使用されます。このAPIは、エクスポート処理を開始するだけです。エクスポートのステータスAPIを使用して、エクスポートの進捗状況を確認したり、エクスポートが完了した後にファイルをダウンロードするためのリンクを取得することができます。 このAPIを使用するために、アプリは [ボット定義] の [ボットのエクスポート] の管理APIスコープを必要とします。 ポスト https://{{host}}/api/public/bot/{{BotID}}/export クエリパラメータ パラメータ 説明 ホスト 環境URL（例： https://bots.kore.ai BotID） ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。 本文パラメータ パラメータ 説明 exportType ボットタイプ – 'latest' または 'published' exportOptions（任意） すべてのボットコンポーネントがデフォルトでエクスポートされます。必要に応じて、エクスポートに含まれるコンポーネントを指定することができます。 "exportOptions": { "tasks": [ "botTask", "knowledgeGraph" ], "nlpData": [ "nlpSettings", "utterances", "standardResponses" ], "settings": [ "botSettings", "botVariables", "ivrSettings" ] }, subTasks（任意）…

ボットの機械学習の発話をエクスポートするために使用します。リクエストIDが作成され、そこから機械学習の発話のエクスポートのステータスAPIを使用してボットのダウンロードリンクを生成することができます。 このAPIを使用するために、アプリは [発話のインポート] のボットビルダーのAPIスコープを必要とします。あるいは、[テストとトレーニング] にある [発話のエクスポート] の管理者のAPIスコープを必要とします。 ポスト https://{{host}}/api/public/bot/{{BotID}}/mlexport クエリパラメータ パラメータ 必須/任意 説明 ホスト 必須 環境URL（例： https://bots.kore.ai） ボットID 必須 ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。 認証 以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}} 応答のコンテンツタイプ application/json サンプルリクエスト curl -X POST \ 'https://{{host}}/api/public/bot/{{bot_id}}/mlexport?state=configured&=&type=csv' \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -H 'content-type: application/json' サンプル応答 { "status": "IN_PROGRESS", "percentageComplete": 0, "streamId": "st-bcd6c75d-9ef1-5861-aa13-fb3290e7fbb1",…

ボットビルダーへのアクセス機能を追加または削除し、新しいボットを作成します。 このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [ロール管理] の [ロール管理] の管理APIスコープを必要とします。 GET https://{{host}}/api/public/useraccess クエリパラメータ パラメータ 説明 ホスト 環境URL（例： https://bots.kore.ai） 本文パラメータ パラメータ 説明 emailIds アクセス権を変更しなければならないユーザーメールIDの配列（例：["joe@kore.com", "amy@xyz.com"]） canCreateBot 指定されたユーザーが、ボットビルダーのアカウントでボットを作成できるかどうかを判断します。TrueまたはFalseを設定します。 isDeveloper 指定されたユーザーがボットビルダーにアクセスできるかどうかを判断します。TrueまたはFalseを設定します。 hasDataTableAndViewAccess 指定されたユーザーがテーブルやビューを作成できるかどうかを判断します。TrueまたはFalseを設定します。 認証 以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}} 応答のコンテンツタイプ application/json サンプルリクエスト curl -X POST \ https://{{host}}/api/public/useraccess \ -H 'Content-Type: application/json' \ -H 'auth: YOUR_JWT_ACCESS_TOKEN' \ -d '{ "emailIds":["sample1@sampleemail.com"],…