{"id":41229,"date":"2022-04-21T07:04:51","date_gmt":"2022-04-21T06:04:51","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=41229"},"modified":"2022-04-21T07:05:12","modified_gmt":"2022-04-21T06:05:12","slug":"get-faqs-kg","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/get-faqs-kg\/?lang=ko","title":{"rendered":"FAQ \ubc1b\uae30- KG"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

\uc9c0\uc2dd \uc791\uc5c5\uc5d0\uc11c \uc9c8\ubb38 \ubc0f \ub178\ub4dc \ubaa9\ub85d\uc744 \uac00\uc838\uc635\ub2c8\ub2e4.<\/p>\n

\uc774 API\ub97c \uc0ac\uc6a9\ud558\ub824\uba74 \uc571\uc5d0 KnowlegedGraph<\/em>\uc758 \uad00\ub9ac\uc790 API \ubc94\uc704\uac00 \ud544\uc694\ud569\ub2c8\ub2e4.<\/p>\n

GET<\/b> https:\/\/{{host}}\/api\/public\/bot\/{{botId}}\/faqs?ktId=&limit=&offset=&parentId=&withallchild=&type=&language=en<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

\uacbd\ub85c \ub9e4\uac1c \ubcc0\uc218<\/span><\/h3>\n\n\n\n\n\n
\ub9e4\uac1c \ubcc0\uc218<\/b><\/th>\n\ud544\uc218\/\uc120\ud0dd \uc0ac\ud56d<\/b><\/th>\n\uc124\uba85<\/b><\/th>\n<\/tr>\n
host<\/td>\n\ud544\uc218<\/td>\n\ud658\uacbd URL(\uc608: https:\/\/bots.kore.ai)<\/td>\n<\/tr>\n
botId<\/td>\n\ud544\uc218<\/td>\n\ubd07 ID\uc785\ub2c8\ub2e4. \ubd07\uc758 \uc77c\ubc18 \uc124\uc815 \ud398\uc774\uc9c0\uc5d0\uc11c \uc774\ub97c \uc561\uc138\uc2a4\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Query Parameters<\/span><\/h3>\n\n\n\n\n\n\n\n\n\n\n\n
Parameter<\/b><\/th>\nRequired\/Optional<\/b><\/th>\nDescription<\/b><\/th>\n<\/tr>\n
ktId<\/td>\nRequired<\/td>\nKnowledge task id from where the FAQs are required to be listed.<\/p>\n

Note: <\/b>You can retrieve the ktId from the request of the\u00a0FAQs\u00a0<\/strong>API call. To know more, go to\u00a0Using GetFAQs API<\/a>. The ktId values are different for both in-development and published bots.<\/td>\n<\/tr>\n

limit<\/td>\nOptional<\/td>\nNumber of records to be fetched, if not provided set to 50.<\/p>\n

Note:<\/b>\u00a0The maximum limit that can be set is 50.<\/td>\n<\/tr>\n

offset<\/td>\nOptional<\/td>\nNumber of records to be skipped, if not provided set to 0<\/td>\n<\/tr>\n
parentId<\/td>\nRequired<\/td>\nThe Id of the nodes in the Knowledge tasks section.<\/p>\n

Note:<\/b> You can retrieve the parentId from the response of the FAQs<\/b>\u00a0API call. To know more, go to\u00a0Using GetFAQs API<\/a>.<\/td>\n<\/tr>\n

withallchild<\/td>\nOptional<\/td>\nWhether child nodes need to be included<\/td>\n<\/tr>\n
type<\/td>\nOptional<\/td>\nType of FAQs to be fetched.<\/td>\n<\/tr>\n
language<\/td>\nRequired<\/td>\nThe bot language, for example, \u201cen\u201d for English and \u201cde\u201d for German.<\/td>\n<\/tr>\n
search<\/td>\nOptional<\/td>\nCan be reference id or display name.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

\uad8c\ud55c \ubd80\uc5ec<\/span><\/h3>\n

\ub2e4\uc74c \uad6c\ubb38\uc744 \ud3ec\ud568\ud55c \ud5e4\ub354\uc5d0 JWT\ub97c \ud3ec\ud568\ud55c API\ub97c \ud638\ucd9c\ud569\ub2c8\ub2e4. auth: {{JWT}}<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

\ucf58\ud150\uce20 \uc720\ud615 \uc751\ub2f5<\/span><\/h3>\n

application\/json<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Sample Request<\/span><\/h3>\n
curl -X GET \\\r\n  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 \\\r\n  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n  -H 'content-type: application\/json' \r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Sample Response<\/span><\/h3>\n
{\r\n    \"faqs\": [\r\n        {\r\n            \"_id\": \"5e0ef00f41c79c0a7c3a729a\",\r\n            \"subAnswers\": [],\r\n            \"editLocked\": false,\r\n            \"isPublished\": true,\r\n            \"questionPayload\": {\r\n                \"question\": \"What is Bank Internet Banking?\",\r\n                \"tagsPayload\": []\r\n            },\r\n            \"answerPayload\": [\r\n                {\r\n                    \"_id\": \"mt-95deca18-9b2a-5c5e-970e-566ef678e270\",\r\n                    \"channel\": \"default\",\r\n                    \"streamId\": \"st-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n                    \"lModBy\": \"u-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n                    \"lMod\": \"Fri Jan 03 2020 13:11:03 GMT+0530 (India Standard Time)\",\r\n                    \"createdBy\": \"u-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n                    \"createdOn\": \"Fri Jan 03 2020 13:11:03 GMT+0530 (India Standard Time)\",\r\n                    \"text\": \"Bank Internet banking is a convenient way to bank anytime, anywhere even from the comfort of your home using your PC or Tab.\",\r\n                    \"type\": \"basic\"\r\n                }\r\n            ],\r\n            \"knowledgeTaskId\": \"5afa79639466e4369e3c809f\",\r\n            \"subQuestions\": [],\r\n            \"responseType\": \"message\",\r\n            \"referenceId\" :\"12xxx32\",\r\n            \"label\" :\"displayname\",\r\n            \"streamId\": \"st-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n            \"parent\": \"pa-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n            \"leafterm\": \"yes\",\r\n            \"language\": \"en\",\r\n            \"createdBy\": \"u-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n            \"lastModifiedBy\": \"u-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n            \"createdOn\": \"2020-01-03T07:41:03.017Z\",\r\n            \"modifiedOn\": \"2020-01-03T07:41:03.017Z\",\r\n            \"sortId\": 1578037263017,\r\n            \"botName\": \"BankingBot\",\r\n            \"refId\": \"re-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n            \"__v\": 0\r\n        }]\r\n}\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"\uc9c0\uc2dd \uc791\uc5c5\uc5d0\uc11c \uc9c8\ubb38 \ubc0f \ub178\ub4dc \ubaa9\ub85d\uc744 \uac00\uc838\uc635\ub2c8\ub2e4. \uc774 API\ub97c \uc0ac\uc6a9\ud558\ub824\uba74 \uc571\uc5d0 KnowlegedGraph\uc758 \uad00\ub9ac\uc790 API \ubc94\uc704\uac00 \ud544\uc694\ud569\ub2c8\ub2e4. GET https:\/\/{{host}}\/api\/public\/bot\/{{botId}}\/faqs?ktId=&limit=&offset=&parentId=&withallchild=&type=&language=en \uacbd\ub85c \ub9e4\uac1c \ubcc0\uc218 \ub9e4\uac1c \ubcc0\uc218 \ud544\uc218\/\uc120\ud0dd \uc0ac\ud56d \uc124\uba85 host \ud544\uc218 \ud658\uacbd URL(\uc608: https:\/\/bots.kore.ai) botId \ud544\uc218 \ubd07 ID\uc785\ub2c8\ub2e4. \ubd07\uc758 \uc77c\ubc18 \uc124\uc815 \ud398\uc774\uc9c0\uc5d0\uc11c \uc774\ub97c \uc561\uc138\uc2a4\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4. Query Parameters Parameter Required\/Optional Description ktId Required Knowledge task id from where...","protected":false},"author":22,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-41229","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/41229","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/22"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=41229"}],"version-history":[{"count":1,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/41229\/revisions"}],"predecessor-version":[{"id":41230,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/41229\/revisions\/41230"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=41229"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=41229"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=41229"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}