FAQ 학습 상태를 가져옵니다.

이 API를 사용하려면 앱은 테스트 및 학습 아래의 학습 FAQ의 관리자 API 범위가 필요합니다.

GET https://{{host}}/api/public/bot/{{BotID}}/faqs/train/status?language={{Lang}}

경로 매개 변수

매개 변수	필수/선택 사항	설명
host	필수	환경 URL(예: https://bots.kore.ai)
BotID	필수	봇 ID 또는 스트림 ID. 봇의 일반 설정 페이지에서 이를 액세스할 수 있습니다.
Lang	필수	봇 언어(예: 영어는 "en", 독일어는 "de").

권한 부여

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

콘텐츠 유형 응답

application/json

샘플 요청

curl -X GET \
  'https://{{host}}/api/public/bot/{{bot_id}}/faqs/train/status?language=en' \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -H 'content-type: application/json' \

샘플 응답

{
    "_id": "5d13600c1e22bc5eaec93e76",
    "callName": "streams/st-6ecb5ba2-5e31-5a40-b918-8cbee40f3fdb/knowledgetask/5d1359fb64dd501a8ad729f9/trainBot",
    "message": "Successfully trained 5d1359fb64dd501a8ad729f9\nSuccessfully trained 5d1359fb64dd501a8ad729f9",
    "status": "success",
    "__v": 0,
    "modifiedOn": "2019-06-27T12:07:30.898Z",
    "lastModifiedBy": "u-5dad2ccd-b271-5c00-a338-2e6e25e1ec91"
}

FAQトレーニングのステータスを取得します。

このAPIを使用するために、アプリは [テストとトレーニング] の [FAQをトレーニング] の管理APIスコープを必要とします。

GET https://{{host}}/api/public/bot/{{BotID}}/faqs/train/status?language={{Lang}}

パスパラメータ

パラメータ	必須/任意	説明
ホスト	必須	環境URL（例： https://bots.kore.ai）
ボットID	必須	ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。
Lang	必須	ボットの言語（例：英語なら「en」、ドイツ語なら「de」）です。

認証

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

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X GET \ 'https://{{host}}/api/public/bot/{{bot_id}}/faqs/train/status?language=en' \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -H 'content-type: application/json' \

サンプル応答

{ "_id": "5d13600c1e22bc5eaec93e76", "callName": "streams/st-6ecb5ba2-5e31-5a40-b918-8cbee40f3fdb/knowledgetask/5d1359fb64dd501a8ad729f9/trainBot", "message": "Successfully trained 5d1359fb64dd501a8ad729f9\nSuccessfully trained 5d1359fb64dd501a8ad729f9", "status": "success", "__v": 0, "modifiedOn": "2019-06-27T12:07:30.898Z", "lastModifiedBy": "u-5dad2ccd-b271-5c00-a338-2e6e25e1ec91" }

To get the status of the FAQ training.

To use this API, app needs the Admin API Scope of Train FAQ under Test and Train.

GET https://{{host}}/api/public/bot/{{BotID}}/faqs/train/status?language={{Lang}}

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 of the bot.
Lang	Required	The bot language, for example, “en” for English and “de” for German.

Authorization

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

auth: {{JWT}}

Response Content Type

application/json

Sample Request

curl -X GET \
  'https://{{host}}/api/public/bot/{{bot_id}}/faqs/train/status?language=en' \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -H 'content-type: application/json' \

Sample Response

{
    "_id": "5d13600c1e22bc5eaec93e76",
    "callName": "streams/st-6ecb5ba2-5e31-5a40-b918-8cbee40f3fdb/knowledgetask/5d1359fb64dd501a8ad729f9/trainBot",
    "message": "Successfully trained 5d1359fb64dd501a8ad729f9\nSuccessfully trained 5d1359fb64dd501a8ad729f9",
    "status": "success",
    "__v": 0,
    "modifiedOn": "2019-06-27T12:07:30.898Z",
    "lastModifiedBy": "u-5dad2ccd-b271-5c00-a338-2e6e25e1ec91"
}