고유 '요청 ID'에 대한 일괄 테스트 실행 요청 상태를 가져오고 테스트 실행이 완료된 후 결과 파일에 대한 다운로드 링크를 제공합니다. 일괄 테스트 실행 API를 시작하려면 여기를 참조하세요.

이 API를 사용하려면 앱은 일괄 테스트 실행의 봇 빌더 범위가 필요합니다.

GET https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName}/{testRunId}/status

쿼리 매개 변수

매개 변수 설명
host 환경 URL, 예:https://bots.kore.ai
BotID 봇 ID 또는 스트림 ID. 봇의 일반 설정 페이지에서 이를 액세스할 수 있습니다.
testSuiteName 실행되는 봇의 플랫폼에서 생성된 테스트 제품군의 이름
testRunId 진행 상황을 추적하기 위해 일괄 테스트 API에서 반환하는 고유한 '요청 ID'

권한 부여

다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다. auth: {{JWT}}

콘텐츠 유형 응답

application/json

샘플 요청

curl --location --request GET \
  'https://{host}/api/public/stream/{streamId}/testsuite/{testSuiteName}/{testRunId}/status' \
    --header 'auth: {jwt-token}' \
    --header 'bot-language: {language-code}'

샘플 응답

  • 테스트 실행이 진행 중인 경우 
    {
    "_id": "tr-beaadxxb-xxxx-xxxe-axfb-xxxxcxbexdxa",
    "streamId": "st-xxxxxxxx-cxxd-xcaf-xxax-dxxxxxxffxdxb",
    "testSuiteId": "ts-deaxxxxc-xxxx-xxxe-axbx-bxxcxxxxfxxx",
    "status": "running",
    "utterance_count": 10,
    "result": {
        "_id": "tr-beaadxxb-xxxx-xxxe-axfb-xxxxcxbexdxa",
        "isPartialFailure": false,
        "status": "running",
        "testSuiteId": "ts-deaxxxxc-xxxx-xxxe-axbx-bxxcxxxxfxxx",
        "triggeredBy": "u-xxbdxecd-xxdx-xxex-xxxd-xxdxxxxdxxea",
        "streamId": "st-xxxxxxxx-cxxd-xcaf-xxax-dxxxxxxffxdxb",
        "botLanguage": "en",
        "runType": "inDevelopment",
        "utterance_count": 10,
        "startTime": "2021-01-07T17:05:34.509Z",
        "__v": 0
    },
    "totalUtterances": 10,
    "utterance_ran": 5,
    "percentage": 50
}
  • 테스트 실행이 진행 중인 경우 
    {
    "_id": "tr-beaadxxb-xxxx-xxxe-axfb-xxxxcxbexdxa",
    "streamId": "st-xxxxxxxx-cxxd-xcaf-xxax-dxxxxxxffxdxb",
    "testSuiteId": "ts-deaxxxxc-xxxx-xxxe-axbx-bxxcxxxxfxxx",
    "status": "running",
    "utterance_count": 10,
    "result": {
        "_id": "tr-beaadxxb-xxxx-xxxe-axfb-xxxxcxbexdxa",
        "isPartialFailure": false,
        "status": "completed",
        "testSuiteId": "ts-deaxxxxc-xxxx-xxxe-axbx-bxxcxxxxfxxx",
        "triggeredBy": "u-xxbdxecd-xxdx-xxex-xxxd-xxdxxxxdxxea",
        "streamId": "st-xxxxxxxx-cxxd-xcaf-xxax-dxxxxxxffxdxb",
        "botLanguage": "en",
        "runType": "inDevelopment",
        "utterance_count": 10,
        "startTime": "2021-01-07T17:05:34.509Z",
        "__v": 0
        "endTime": "2021-01-07T17:07:37.544Z",
        "f1_score": "0.00",
        "fileId": "5ff73fd98a3d9a5cbbd7c32b",
        "precision": "0.00",
        "recall": "0.00",
        "results": {
            "TP": 0,
            "TN": 0,
            "FP": 0,
            "FN": 0,
            "success": 0,
            "failure": 10,
            "totalEntitiesCount": 0,
            "matchedEntitiesCount": 0,
            "failedUtteranceCount": 10,
            "failedEntitiesCount": 0
        },
        "fileUrl": "{{url}}"
    }
}

Leave a Reply

Your email address will not be published. Required fields are marked *

Fill out this field
Fill out this field
Please enter a valid email address.
You need to agree with the terms to proceed

一意の「リクエストID」に対するバッチテストの実行リクエストのステータスを取得し、テストの実行が完了した後に結果ファイルのダウンロードリンクを提供します。バッチテストの実行APIの開始についてはこちらを参照してください。

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

GET https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName}/{testRunId}/status

クエリパラメータ

パラメータ 説明
ホスト 環境URL（例）https://bots.kore.ai
BotID ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。
testSuiteName 実行中のボットのプラットフォームで作成されたテストスイートの名前
testRunId 進捗状況を追跡するためにバッチテストの実行APIが返す一意の「リクエストID」

認証

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

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl --location --request GET \ 'https://{host}/api/public/stream/{streamId}/testsuite/{testSuiteName}/{testRunId}/status' \ --header 'auth: {jwt-token}' \ --header 'bot-language: {language-code}'

サンプル応答

  • テストの実行が進行中の場合 
    { "_id": "tr-beaadxxb-xxxx-xxxe-axfb-xxxxcxbexdxa", "streamId": "st-xxxxxxxx-cxxd-xcaf-xxax-dxxxxxxffxdxb", "testSuiteId": "ts-deaxxxxc-xxxx-xxxe-axbx-bxxcxxxxfxxx", "status": "running", "utterance_count": 10, "result": { "_id": "tr-beaadxxb-xxxx-xxxe-axfb-xxxxcxbexdxa", "isPartialFailure": false, "status": "running", "testSuiteId": "ts-deaxxxxc-xxxx-xxxe-axbx-bxxcxxxxfxxx", "triggeredBy": "u-xxbdxecd-xxdx-xxex-xxxd-xxdxxxxdxxea", "streamId": "st-xxxxxxxx-cxxd-xcaf-xxax-dxxxxxxffxdxb", "botLanguage": "en", "runType": "inDevelopment", "utterance_count": 10, "startTime": "2021-01-07T17:05:34.509Z", "__v": 0 }, "totalUtterances": 10, "utterance_ran": 5, "percentage": 50 }
  • テストの実行が進行中の場合 
    { "_id": "tr-beaadxxb-xxxx-xxxe-axfb-xxxxcxbexdxa", "streamId": "st-xxxxxxxx-cxxd-xcaf-xxax-dxxxxxxffxdxb", "testSuiteId": "ts-deaxxxxc-xxxx-xxxe-axbx-bxxcxxxxfxxx", "status": "running", "utterance_count": 10, "result": { "_id": "tr-beaadxxb-xxxx-xxxe-axfb-xxxxcxbexdxa", "isPartialFailure": false, "status": "completed", "testSuiteId": "ts-deaxxxxc-xxxx-xxxe-axbx-bxxcxxxxfxxx", "triggeredBy": "u-xxbdxecd-xxdx-xxex-xxxd-xxdxxxxdxxea", "streamId": "st-xxxxxxxx-cxxd-xcaf-xxax-dxxxxxxffxdxb", "botLanguage": "en", "runType": "inDevelopment", "utterance_count": 10, "startTime": "2021-01-07T17:05:34.509Z", "__v": 0 "endTime": "2021-01-07T17:07:37.544Z", "f1_score": "0.00", "fileId": "5ff73fd98a3d9a5cbbd7c32b", "precision": "0.00", "recall": "0.00", "results": { "TP": 0, "TN": 0, "FP": 0, "FN": 0, "success": 0, "failure": 10, "totalEntitiesCount": 0, "matchedEntitiesCount": 0, "failedUtteranceCount": 10, "failedEntitiesCount": 0 }, "fileUrl": "{{url}}" } }

Leave a Reply

Your email address will not be published. Required fields are marked *

Fill out this field
Fill out this field
Please enter a valid email address.
You need to agree with the terms to proceed

Gets the status of Batch Test Execution request against a unique ‘Request Id’ and provides the download link for the results file after the test execution is complete. Refer here for initiating Batch Test Execution API.

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

GET https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName}/{testRunId}/status

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 that is being executed
testRunId The unique ‘Request ID’ returned by the Batch Test Execution API to track the progress

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 GET \
  'https://{host}/api/public/stream/{streamId}/testsuite/{testSuiteName}/{testRunId}/status' \
    --header 'auth: {jwt-token}' \
    --header 'bot-language: {language-code}'

Sample Response

  • When the test execution is in progress 
    {
    "_id": "tr-beaadxxb-xxxx-xxxe-axfb-xxxxcxbexdxa",
    "streamId": "st-xxxxxxxx-cxxd-xcaf-xxax-dxxxxxxffxdxb",
    "testSuiteId": "ts-deaxxxxc-xxxx-xxxe-axbx-bxxcxxxxfxxx",
    "status": "running",
    "utterance_count": 10,
    "result": {
        "_id": "tr-beaadxxb-xxxx-xxxe-axfb-xxxxcxbexdxa",
        "isPartialFailure": false,
        "status": "running",
        "testSuiteId": "ts-deaxxxxc-xxxx-xxxe-axbx-bxxcxxxxfxxx",
        "triggeredBy": "u-xxbdxecd-xxdx-xxex-xxxd-xxdxxxxdxxea",
        "streamId": "st-xxxxxxxx-cxxd-xcaf-xxax-dxxxxxxffxdxb",
        "botLanguage": "en",
        "runType": "inDevelopment",
        "utterance_count": 10,
        "startTime": "2021-01-07T17:05:34.509Z",
        "__v": 0
    },
    "totalUtterances": 10,
    "utterance_ran": 5,
    "percentage": 50
}
  • When the test execution is in progress 
    {
    "_id": "tr-beaadxxb-xxxx-xxxe-axfb-xxxxcxbexdxa",
    "streamId": "st-xxxxxxxx-cxxd-xcaf-xxax-dxxxxxxffxdxb",
    "testSuiteId": "ts-deaxxxxc-xxxx-xxxe-axbx-bxxcxxxxfxxx",
    "status": "running",
    "utterance_count": 10,
    "result": {
        "_id": "tr-beaadxxb-xxxx-xxxe-axfb-xxxxcxbexdxa",
        "isPartialFailure": false,
        "status": "completed",
        "testSuiteId": "ts-deaxxxxc-xxxx-xxxe-axbx-bxxcxxxxfxxx",
        "triggeredBy": "u-xxbdxecd-xxdx-xxex-xxxd-xxdxxxxdxxea",
        "streamId": "st-xxxxxxxx-cxxd-xcaf-xxax-dxxxxxxffxdxb",
        "botLanguage": "en",
        "runType": "inDevelopment",
        "utterance_count": 10,
        "startTime": "2021-01-07T17:05:34.509Z",
        "__v": 0
        "endTime": "2021-01-07T17:07:37.544Z",
        "f1_score": "0.00",
        "fileId": "5ff73fd98a3d9a5cbbd7c32b",
        "precision": "0.00",
        "recall": "0.00",
        "results": {
            "TP": 0,
            "TN": 0,
            "FP": 0,
            "FN": 0,
            "success": 0,
            "failure": 10,
            "totalEntitiesCount": 0,
            "matchedEntitiesCount": 0,
            "failedUtteranceCount": 10,
            "failedEntitiesCount": 0
        },
        "fileUrl": "{{url}}"
    }
}

Leave a Reply

Your email address will not be published. Required fields are marked *

Fill out this field
Fill out this field
Please enter a valid email address.
You need to agree with the terms to proceed