[ナレッジタスク] で質問とノードのリストを取得します。
この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 }] }