{"id":24611,"date":"2020-09-28T07:23:08","date_gmt":"2020-09-28T06:23:08","guid":{"rendered":"https:\/\/developer.kore.ai\/v9-3\/?p=24611"},"modified":"2022-12-05T07:55:52","modified_gmt":"2022-12-05T07:55:52","slug":"extract-from-file-or-url-kg","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v9-3\/docs\/bots\/api-guide\/extract-from-file-or-url-kg\/","title":{"rendered":"Extraction from file or URL – KG"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

To extract the Knowledge Graph from the imported file or URL.<\/p>\n

 <\/p>\n\n\n\n\n\n\n\n
Method<\/b><\/td>\nPOST<\/td>\n<\/tr>\n
Endpoint<\/b><\/td>\nhttps:\/\/{{host}}\/api\/public\/bot\/{{botId}}\/qna\/import?language=en<\/code><\/span><\/td>\n<\/tr>\n
Content Type<\/b><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/b><\/td>\n\n

auth: {{JWT}}<\/code><\/p>\n

See How to generate the JWT Token<\/a>.<\/td>\n<\/tr>\n

API Scope<\/b><\/td>\n\n
    \n
  • Bot Builder: Manage Knowledge Graph<\/li>\n
  • Admin Console: Manage Knowledge Graph<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t

     <\/p>\n

    Path Parameters<\/span><\/h2>\n\n\n\n\n\n
    Parameter<\/b><\/th>\nDescription<\/b><\/th>\nMandate<\/b><\/th>\n<\/tr>\n
    host<\/b><\/td>\nThe environment URL. For example, https:\/\/bots.kore.ai<\/code><\/td>\nRequired<\/td>\n<\/tr>\n
    BotId<\/b><\/td>\nBot ID<\/i> or Stream ID<\/i> can be accessed under General Settings<\/b> on the Bot Builder.<\/td>\nRequired<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t

     <\/p>\n

    Query Parameters<\/span><\/h2>\n\n\n\n\n
    Parameter<\/b><\/th>\nDescription<\/b><\/th>\nMandate<\/b><\/th>\n<\/tr>\n
    language<\/b><\/td>\nThe Bot language which is identified by the language acronym. For example, en<\/em> for English and de<\/em> for German. The user can set the default language of the bot.<\/td>\nRequired<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t

     <\/p>\n

    Sample Request<\/span><\/h2>\n
    curl -X POST \\\r\n  https:\/\/{{host}}\/api\/public\/bot\/{{botId}}\/qna\/import?language=en \\\r\n  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n  -H 'content-type: application\/json' \\\r\n  -d '{\r\n\t\"fileUrl\":\"https:\/\/\/faqs-with-answers.htm\", (or) \r\n        \"fileId\":\"5exxxxxxxxc3a7291\",\r\n\t\"name\": \"KGFile\"\r\n\r\n   }'<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t
     <\/p>\n
    Body Parameters<\/span><\/h2>\n\n\n\n\n\n\n
    Parameter<\/b><\/th>\nDescription<\/b><\/th>\nMandate<\/th>\n<\/tr>\n
    fileUrl<\/b><\/td>\nThe URL pointing to the location of the FAQs to be extracted.<\/td>\nOptional<\/td>\n<\/tr>\n
    fileId<\/b><\/td>\nThe File id<\/i> pointing to the FAQ file’s location.<\/td>\nOptional<\/td>\n<\/tr>\n
    name<\/b><\/td>\nThe name provided to the FAQ.<\/td>\nOptional<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t
     <\/p>\n
    Sample Response<\/span><\/h2>\n
    { \r\n      \u201c_id\u201d: <extractionId>, \r\n      \u201cstatus\u201d: \u201csuccess\u201d\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":"To extract the Knowledge Graph from the imported file or URL.   Method POST Endpoint https:\/\/{{host}}\/api\/public\/bot\/{{botId}}\/qna\/import?language=en Content Type application\/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Manage Knowledge Graph Admin Console: Manage Knowledge Graph   Path Parameters Parameter Description Mandate host The environment URL. For example, https:\/\/bots.kore.ai Required...","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-24611","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/24611","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/comments?post=24611"}],"version-history":[{"count":8,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/24611\/revisions"}],"predecessor-version":[{"id":49609,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/24611\/revisions\/49609"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/media?parent=24611"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/categories?post=24611"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/tags?post=24611"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}