バッチテストの実行API

バッチテストスイートを実行して結果を得るために使用されます。このAPIは、テストプロセスを開始するのみです。バッチテストの実行のステータスAPIを使用して、バッチテストの結果を参照します。

このAPIを使用するために、アプリは [バッチテストの実行] の [ボットビルダーのスコープ] を必要とします。

POST https://{{host}}/api/public/bot/{{BotID}}/testsuite/{testSuiteName}/run

クエリパラメータ

パラメータ	説明
ホスト	環境URL（例） `https://bots.kore.ai`
BotID	ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。
testSuiteName	ボットのプラットフォームで作成されたテストスイートの名前

本文パラメータ

パラメータ	説明
バージョン	実行が要求されるボットのバージョン公開済みバージョンに対するpublished 設定済みバージョンに対するinDevelopment

パラメータ

説明

バージョン

実行が要求されるボットのバージョン

公開済みバージョンに対するpublished
設定済みバージョンに対するinDevelopment

認証

以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl --location --request POST \ 'https://{host}/api/public/stream/{streamId}/testsuite/{testSuiteName}/run' \ --header 'auth: {jwt-token}' \ --header 'bot-language: {language-code}' \ --header 'Content-Type: application/json' \ --data-raw '{ "version":"inDevelopment" }'

サンプル応答

{ "status": "accepted", "requestId": "tr-acfxxbff-xxxf-xaxx-bbbx-exxxabaxxcxx" }

On this Page

Batch Test Execution API

Used to execute Batch Test Suites and get results. This API only initiates the test process. Use Batch Test Execution Status API to view the results of the batch test.

To use this API, the app needs the Bot Builder Scope of Batch Tests Execution.

POST https://{{host}}/api/public/bot/{{BotID}}/testsuite/{testSuiteName}/run

Query Parameters

Parameter	Description
host	Environment URL, for example, `https://bots.kore.ai`
BotID	Bot ID or Stream ID. You can access it from the General Settings page of the bot.
testSuiteName	Name of the test suite as created in the Bot’s platform

Body Parameters

Parameter	Description
version	The version of the bot against which the execution is required published for Published version inDevelopment for the Configured version

Parameter

Description

version

The version of the bot against which the execution is required

published for Published version
inDevelopment for the Configured version

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response content type

application/json

Sample Request

curl --location --request POST \
      'https://{host}/api/public/stream/{streamId}/testsuite/{testSuiteName}/run' \
      --header 'auth: {jwt-token}' \
      --header 'bot-language: {language-code}' \
      --header 'Content-Type: application/json' \
      --data-raw '{
         "version":"inDevelopment" 
         }'

Sample Response

{
    "status": "accepted",
    "requestId": "tr-acfxxbff-xxxf-xaxx-bbbx-exxxabaxxcxx"
}

On this Page