지식 작업에서 질문 및 노드 목록을 가져옵니다.

이 API를 사용하려면 앱에 KnowlegedGraph의 관리자 API 범위가 필요합니다.

GET https://{{host}}/api/public/bot/{{botId}}/faqs?ktId=&limit=&offset=&parentId=&withallchild=&type=&language=en

경로 매개 변수

매개 변수 필수/선택 사항 설명
host 필수 환경 URL(예: https://bots.kore.ai)
botId 필수 봇 ID입니다. 봇의 일반 설정 페이지에서 이를 액세스할 수 있습니다.

Query Parameters

Parameter Required/Optional Description
ktId Required Knowledge task id from where the FAQs are required to be listed.

Note: You can retrieve the ktId from the request of the FAQs API call. To know more, go to Using GetFAQs API. The ktId values are different for both in-development and published bots.
limit Optional Number of records to be fetched, if not provided set to 50.

Note: The maximum limit that can be set is 50.
offset Optional Number of records to be skipped, if not provided set to 0
parentId Required The Id of the nodes in the Knowledge tasks section.

Note: You can retrieve the parentId from the response of the FAQs API call. To know more, go to Using GetFAQs API.
withallchild Optional Whether child nodes need to be included
type Optional Type of FAQs to be fetched.
language Required The bot language, for example, “en” for English and “de” for German.
search Optional Can be reference id or display name.

권한 부여

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

콘텐츠 유형 응답

application/json

Sample Request

curl -X GET \
  https://{{host}}/api/public/bot/{{bot_id}}/faqs?ktId=5afxxxxxf&limit=30&offset=0&parentId=xxxxx-xxx-xxx-xxx-xxxxx&withallchild=true&type=all&language=en \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -H 'content-type: application/json'

Sample Response

{
    "faqs": [
        {
            "_id": "5e0ef00f41c79c0a7c3a729a",
            "subAnswers": [],
            "editLocked": false,
            "isPublished": true,
            "questionPayload": {
                "question": "What is Bank Internet Banking?",
                "tagsPayload": []
            },
            "answerPayload": [
                {
                    "_id": "mt-95deca18-9b2a-5c5e-970e-566ef678e270",
                    "channel": "default",
                    "streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx",
                    "lModBy": "u-xxxxx-xxx-xxx-xxx-xxxxx",
                    "lMod": "Fri Jan 03 2020 13:11:03 GMT+0530 (India Standard Time)",
                    "createdBy": "u-xxxxx-xxx-xxx-xxx-xxxxx",
                    "createdOn": "Fri Jan 03 2020 13:11:03 GMT+0530 (India Standard Time)",
                    "text": "Bank Internet banking is a convenient way to bank anytime, anywhere even from the comfort of your home using your PC or Tab.",
                    "type": "basic"
                }
            ],
            "knowledgeTaskId": "5afa79639466e4369e3c809f",
            "subQuestions": [],
            "responseType": "message",
            "referenceId" :"12xxx32",
            "label" :"displayname",
            "streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx",
            "parent": "pa-xxxxx-xxx-xxx-xxx-xxxxx",
            "leafterm": "yes",
            "language": "en",
            "createdBy": "u-xxxxx-xxx-xxx-xxx-xxxxx",
            "lastModifiedBy": "u-xxxxx-xxx-xxx-xxx-xxxxx",
            "createdOn": "2020-01-03T07:41:03.017Z",
            "modifiedOn": "2020-01-03T07:41:03.017Z",
            "sortId": 1578037263017,
            "botName": "BankingBot",
            "refId": "re-xxxxx-xxx-xxx-xxx-xxxxx",
            "__v": 0
        }]
}

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

[ナレッジタスク] で質問とノードのリストを取得します。

このAPIを使用するために、アプリは [ナレッジグラフ] の [管理者APIスコープ] を必要とします。

GET https://{{host}}/api/public/bot/{{botId}}/faqs?ktId=&limit=&offset=&parentId=&withallchild=&type=&language=en

パスパラメータ

パラメータ 必須/任意 説明
ホスト 必須 環境URL（例： https://bots.kore.ai）
botId 必須 ボットID。ボットの [一般設定] ページからアクセスすることができます。

クエリパラメータ

パラメータ 必須/任意 説明
ktId 必須 FAQのリスト化が要求されるナレッジタスクID。
limit 任意 指定されていない場合、取得されるレコード数は50に設定されます。
offset 任意 指定されていない場合、スキップされるレコード数は0に設定されます
parentId 必須 親IDです。
withallchild 任意 子ノードを含める必要があるかどうか
type 任意 取得されるFAQのタイプです。
language 必須 ボットの言語（例：英語の「en」、ドイツ語の「de」）です。
search 任意 参照IDまたは表示名になります。

認証

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

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X POST \ https://{{host}}/api/public/bot/{{bot_id}}/faqs?ktId=5afxxxxxf&limit=30&offset=0&parentId=xxxxx-xxx-xxx-xxx-xxxxx&withallchild=true&type=all&language=en \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -H 'content-type: application/json'

サンプル応答

{ "faqs": [ { "_id": "5e0ef00f41c79c0a7c3a729a", "subAnswers": [], "editLocked": false, "isPublished": true, "questionPayload": { "question": "銀行のインターネットバンキングとは何ですか？", "tagsPayload": [] }, "answerPayload": [ { "_id": "mt-95deca18-9b2a-5c5e-970e-566ef678e270", "channel": "default", "streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx", "lModBy": "u-xxxxx-xxx-xxx-xxx-xxxxx", "lMod": "Fri Jan 03 2020 13:11:03 GMT+0530 (India Standard Time)", "createdBy": "u-xxxxx-xxx-xxx-xxx-xxxxx", "createdOn": "Fri Jan 03 2020 13:11:03 GMT+0530 (India Standard Time)", "text": "銀行のインターネットバンキングとは、PCまたはタブレットを使用して、いつでもどこでも、ご自宅からでも銀行取引を行うことができる便利な方法です。", "type": "basic" } ], "knowledgeTaskId": "5afa79639466e4369e3c809f", "subQuestions": [], "responseType": "message", "referenceId" :"12xxx32", "label" :"displayname", "streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx", "parent": "xxxxx-xxx-xxx-xxx-xxxxx", "leafterm": "yes", "language": "en", "createdBy": "u-xxxxx-xxx-xxx-xxx-xxxxx", "lastModifiedBy": "u-xxxxx-xxx-xxx-xxx-xxxxx", "createdOn": "2020-01-03T07:41:03.017Z", "modifiedOn": "2020-01-03T07:41:03.017Z", "sortId": 1578037263017, "botName": "BankingBot", "refId": "xxxxx-xxx-xxx-xxx-xxxxx", "__v": 0 }] }

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

To get a list of questions and nodes under the Knowledge task.

To use this API, the app needs the Admin API Scope of KnowlegdeGraph.

GET https://{{host}}/api/public/bot/{{botId}}/faqs?ktId=&limit=&offset=&parentId=&withallchild=&type=&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 bot.

Query Parameters

Parameter Required/Optional Description
ktId Required Knowledge task id from where the FAQs are required to be listed.

Note: You can retrieve the ktId from the request of the FAQs API call. To know more, go to Using GetFAQs API. The ktId values are different for both in-development and published bots.
limit Optional Number of records to be fetched, if not provided set to 50.

Note: The maximum limit that can be set is 50.
offset Optional Number of records to be skipped, if not provided set to 0
parentId Required The Id of the nodes in the Knowledge tasks section.

Note: You can retrieve the parentId from the response of the FAQs API call. To know more, go to Using GetFAQs API.
withallchild Optional Whether child nodes need to be included
type Optional Type of FAQs to be fetched.
language Required The bot language, for example, “en” for English and “de” for German.
search Optional Can be reference id or display name.

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?ktId=5afxxxxxf&limit=30&offset=0&parentId=xxxxx-xxx-xxx-xxx-xxxxx&withallchild=true&type=all&language=en \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -H 'content-type: application/json'

Sample Response

{
    "faqs": [
        {
            "_id": "5e0ef00f41c79c0a7c3a729a",
            "subAnswers": [],
            "editLocked": false,
            "isPublished": true,
            "questionPayload": {
                "question": "What is Bank Internet Banking?",
                "tagsPayload": []
            },
            "answerPayload": [
                {
                    "_id": "mt-95deca18-9b2a-5c5e-970e-566ef678e270",
                    "channel": "default",
                    "streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx",
                    "lModBy": "u-xxxxx-xxx-xxx-xxx-xxxxx",
                    "lMod": "Fri Jan 03 2020 13:11:03 GMT+0530 (India Standard Time)",
                    "createdBy": "u-xxxxx-xxx-xxx-xxx-xxxxx",
                    "createdOn": "Fri Jan 03 2020 13:11:03 GMT+0530 (India Standard Time)",
                    "text": "Bank Internet banking is a convenient way to bank anytime, anywhere even from the comfort of your home using your PC or Tab.",
                    "type": "basic"
                }
            ],
            "knowledgeTaskId": "5afa79639466e4369e3c809f",
            "subQuestions": [],
            "responseType": "message",
            "referenceId" :"12xxx32",
            "label" :"displayname",
            "streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx",
            "parent": "pa-xxxxx-xxx-xxx-xxx-xxxxx",
            "leafterm": "yes",
            "language": "en",
            "createdBy": "u-xxxxx-xxx-xxx-xxx-xxxxx",
            "lastModifiedBy": "u-xxxxx-xxx-xxx-xxx-xxxxx",
            "createdOn": "2020-01-03T07:41:03.017Z",
            "modifiedOn": "2020-01-03T07:41:03.017Z",
            "sortId": 1578037263017,
            "botName": "BankingBot",
            "refId": "re-xxxxx-xxx-xxx-xxx-xxxxx",
            "__v": 0
        }]
}

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