{"_id":"@ads-vdh/qnamaker-api","_rev":"6-cf0b18ebfe31b7f937a43090de018eba","name":"@ads-vdh/qnamaker-api","dist-tags":{"latest":"1.0.4"},"versions":{"1.0.0":{"name":"@ads-vdh/qnamaker-api","version":"1.0.0","publishConfig":{"access":"public"},"description":"An unofficial node wrapper for the Microsoft QnAMaker API","main":"index.js","scripts":{},"repository":{"type":"git","url":"git+https://github.com/VermontDepartmentOfHealth/covid-bot.git"},"bugs":{"url":"https://github.com/VermontDepartmentOfHealth/covid-bot/issues"},"homepage":"https://github.com/VermontDepartmentOfHealth/covid-bot#readme","keywords":["azure","QnAMaker","KnoweldgeBase","BotServices"],"author":"","license":"MIT","dependencies":{"node-fetch":"^2.6.0"},"_id":"@ads-vdh/qnamaker-api@1.0.0","_nodeVersion":"12.9.0","_npmVersion":"6.10.2","dist":{"integrity":"sha512-rR9KrJOHdte6S2+R2XlMIOuJ+ur/yJu5RAuAE/E2Bkni26QuwjqPURuH9S3i4NNTMCHuxLWA8z9XnTJ6bMhBag==","shasum":"f4560b5cba14b7b1322759e5f9f55de30f8d7ae2","tarball":"https://registry.npmjs.org/@ads-vdh/qnamaker-api/-/qnamaker-api-1.0.0.tgz","fileCount":3,"unpackedSize":8861,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJelHjJCRA9TVsSAnZWagAAVgUP+wT8uIqvq8AVi2rxhiE+\nBMnHj210eMZSgqRPP0ZUcaG9ZGQR5wm/8Ong4VJiYRRpQGrMm8NlOfxYW5X6\naWZKPjGHU5yHyfrF6Adv0hfArMLoPOUOlyqVrPMZBVR9bvXpEhjQuoqNNk9V\nzOqjyyEI9ML8kh8s1g1po/E+TZlfB1Na6ytz0sXXfv2KoRIn6XAODdC8CtUr\nzG4Sn7dUwCBrnfx6RDy7sjojSUIuBeQ0Jn4wn6PFITvNEb6Hqp3gZhAgtQsD\n5YLGYD2jmlPna+di5+7RgPNbqtMg9emNnVjY/kihecuSyMEZvUr5MJj/uzDv\nKrVN47YF38D+FDAkYIHPAAFtcAhMIT6mXWr+bEj8HuhDj2zUN5gPUOjP1B0C\nWni/uuNQQBjrMfbt3Kaz3pxIPcoy7YBWX1ztIHhaJXYMQiRwrkAotepMlknJ\nGSzo84+QgGfuuoFiY7K7mXaNZ03MxZw+QPjs7uZvZVB+sQshGRglO8kiJvhu\nTM7DuBbACvPlj0KWPt7EWffyNE9OfAGt/3Icxwwm/hLDefC/cZNyk1SvhX+k\naNFk4AHzegFBs9FcRGDumtiMxRQ7RRpCdDRcymwcTjrRZOgGLco+S2uVHJIL\nSoqcA9z7wmWo5dtid5maDNwRZk8xwsE1xOM1MZ93H+DQsHRot0gDyrMUrqb1\nH3ou\r\n=1Kir\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC+b38ipZI+rg9A3n/QdIi043VEg9q3VApgHQbZ9JOByAIgbfRgBMb5f91VVtnSGieYN1BMTPPbXnlyq9Bu4xzltss="}]},"maintainers":[{"name":"jmathias3","email":"John.Mathias@vermont.gov"},{"name":"kyle-mit-vdh","email":"Kyle.Mitofsky@vermont.gov"}],"_npmUser":{"name":"kyle-mit-vdh","email":"Kyle.Mitofsky@vermont.gov"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/qnamaker-api_1.0.0_1586788553274_0.30421898423180416"},"_hasShrinkwrap":false},"1.0.1":{"name":"@ads-vdh/qnamaker-api","version":"1.0.1","publishConfig":{"access":"public"},"description":"An unofficial node wrapper for the Microsoft QnAMaker API","main":"index.js","scripts":{},"repository":{"type":"git","url":"git+https://github.com/VermontDepartmentOfHealth/covid-bot.git"},"bugs":{"url":"https://github.com/VermontDepartmentOfHealth/covid-bot/issues"},"homepage":"https://github.com/VermontDepartmentOfHealth/covid-bot#readme","keywords":["azure","QnAMaker","KnoweldgeBase","BotServices"],"author":"","license":"MIT","dependencies":{"node-fetch":"^2.6.0"},"_id":"@ads-vdh/qnamaker-api@1.0.1","_nodeVersion":"12.9.0","_npmVersion":"6.10.2","dist":{"integrity":"sha512-wCZ3pW4Q5wsZ+U1NMPzkQGU34JxpsPjvCT30uy8yIamX7sNkPDosRYylbfB040KQhd7BKDjF2jMKJadzlaqqRw==","shasum":"4c00bd3e1d09bc4734135f706a2ea361d06b6a37","tarball":"https://registry.npmjs.org/@ads-vdh/qnamaker-api/-/qnamaker-api-1.0.1.tgz","fileCount":3,"unpackedSize":8846,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJelH9fCRA9TVsSAnZWagAA5q8P/2AnbHR5z6UezNYIvC1z\nCp6lsSGj6cD+9kl+ilVkEk0GPgdzn68YZJbZ7m80O9auty/rc9hrUAOMEl+S\nayGQrNdD1COQI7FAUw4Xlaa6gqknJjRFyPEuo9HmJ9Y8PKy9B5K/s6H31cxr\nCdvOPmTGw0ta1cKWrPx4Bit23r6S16sV7oR9AUXJeSxzJ4t6WSGPcr54UqTX\nZ0Q33R6GaxCo0QCUVDHAtF+drhSYjjA96/OVWiEQHDzAHDkktUOHXyalcJUO\nLHVifgze0jp91oPeWzed+pFl4S02bqwkEbkGHMQbfCErsYIYtUz2QKyGPEim\nynkLxFmexIBplDuCZz0rSfMMmC4zNdaCreagbhS9J1YCgFQO2zJFFfC3anwF\nSCbQbfpgHWfIRbGvGFSWHl6EXzPYMHTt88icd5cfDmXfF1TKK0fzisWE0FdH\nykS5/swiiE4iVH5RuyzH+/lTepJO6TnjtWNDJevf01SyYkOh222D95ZADbot\nEoqMaBcPYplPxWxjtWJZnywpsoZGwdqGb5Ao5kcxneN9luvFBc3VquJ7RY+k\nKOtnjC/Y1u1HAhnyFqTVy3sKVomcn5bGaHf0CxZg3d3Xe9Kh+F8SrGoaKNxt\nsRbj80dVt3F6EKjOr5NsWlG/zJ6YBAqYHJp9n21jAmE/7e3ZvwcmxeXZaXjx\nXab+\r\n=3qX4\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAWfx1hhRZ6Rv1y75dpt6wB6OuH9mN/B9e3moGc8tVvuAiAj58cXtJGQozYbnH8k+JwHjgD17bvEyRAKwZE1Uh95gg=="}]},"maintainers":[{"name":"jmathias3","email":"John.Mathias@vermont.gov"},{"name":"kyle-mit-vdh","email":"Kyle.Mitofsky@vermont.gov"}],"_npmUser":{"name":"kyle-mit-vdh","email":"Kyle.Mitofsky@vermont.gov"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/qnamaker-api_1.0.1_1586790239212_0.295516548160625"},"_hasShrinkwrap":false},"1.0.3":{"name":"@ads-vdh/qnamaker-api","version":"1.0.3","publishConfig":{"access":"public"},"description":"An unofficial node wrapper for the Microsoft QnAMaker API","main":"index.js","scripts":{},"repository":{"type":"git","url":"git+https://github.com/VermontDepartmentOfHealth/covid-bot.git"},"bugs":{"url":"https://github.com/VermontDepartmentOfHealth/covid-bot/issues"},"homepage":"https://github.com/VermontDepartmentOfHealth/covid-bot#readme","keywords":["azure","QnAMaker","KnoweldgeBase","BotServices"],"author":"","license":"MIT","dependencies":{"node-fetch":"^2.6.0"},"_id":"@ads-vdh/qnamaker-api@1.0.3","_nodeVersion":"12.9.0","_npmVersion":"6.10.2","dist":{"integrity":"sha512-eYuUdcD45lwscH+l0Zh0vQHk9+kZ9WG8yt1c6tsg2k2CZDbmGdV8UR/5WWcDgfFbKuHXemjm3FHVmUCKzerGNQ==","shasum":"bd73c5e159943f783a3451d8951f11286d037b87","tarball":"https://registry.npmjs.org/@ads-vdh/qnamaker-api/-/qnamaker-api-1.0.3.tgz","fileCount":3,"unpackedSize":8910,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJelLlxCRA9TVsSAnZWagAANF8P/3UXE2TmnKBnzw/uK1MP\n0dxEH4F47i8gLEMM1W1GqnvfJ8swnQ0mvywza8wmVz9/ckuMRpAqFvneb2SI\nbDXHBZBNK+iHWp3lWwcEsitmkJdJhSVSO5t7oELogpbI23TLTLHlJnB7oOP6\nTNZt2svgCeTz7BvyHIf/r+3jDBeNYTm/Kfn7X0DS3tttS5Lu7C4KHScXvUo2\nr1ZTUN0wfYc53yFcbYhc6i9OiZSe5tE7L8UTD8Ezl5r1adGa7JlLVbqG4zyD\ncPVfxOpD8TM63kp7tv0z+mfMm2NXxJWpBCT7KBn7382FLiwOmdg1ogn5Pdy+\ntCO8jAbeI3o3d3OU0OTZLl7oftd8MdxSRubLAHGH55Q8pxWdx1rHo8EkrwDw\nyCdhmX3LYLbgZmt7ppeVuIZ6MDfUPMneANOSNsirIJJGBF1I+bO6AJCXzT3o\nKbJisz4tJYbjFUbiOaVgoXDpNhHGmywAEr2JxaZlWg0jTG9wJuFOgzRXWBiW\nh7ZWtlSL/UrwYROE+SdDVuvUhRZMyag9CPPS1X41tkLVXJ4tW4BTyloqdlBW\nh7mGhFHObRhMZD1Reqszj/8GSScDmA2FVjx/TqWgJN1Eo4WI6QRYXgVShjcU\nPVg8eas6zi1baN6tEXsC+aK6BvJZG29pjUAFuqUIzmOw4jDBYxFESXuwqhDQ\nA6zU\r\n=aNTy\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCshafShs38Zc40tJ9sLyTJ1lnCqnSOiLO6rM8/zwLCKgIgCFidwUwvDB19mLEivk4BzPDgrMsftzUtAEr4+gU7sa0="}]},"maintainers":[{"email":"brian.nowak@vermont.gov","name":"bcnowak"},{"email":"John.Mathias@vermont.gov","name":"jmathias3"},{"email":"Kyle.Mitofsky@vermont.gov","name":"kyle-mit-vdh"}],"_npmUser":{"name":"kyle-mit-vdh","email":"Kyle.Mitofsky@vermont.gov"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/qnamaker-api_1.0.3_1586805105338_0.20916008110501405"},"_hasShrinkwrap":false},"1.0.4":{"name":"@ads-vdh/qnamaker-api","version":"1.0.4","publishConfig":{"access":"public"},"description":"An unofficial node wrapper for the Microsoft QnAMaker API","main":"index.js","scripts":{},"repository":{"type":"git","url":"git+https://github.com/VermontDepartmentOfHealth/covid-bot.git"},"bugs":{"url":"https://github.com/VermontDepartmentOfHealth/covid-bot/issues"},"homepage":"https://github.com/VermontDepartmentOfHealth/covid-bot#readme","keywords":["azure","QnAMaker","KnoweldgeBase","BotServices"],"author":"","license":"MIT","dependencies":{"node-fetch":"^2.6.0"},"_id":"@ads-vdh/qnamaker-api@1.0.4","_nodeVersion":"12.9.0","_npmVersion":"6.10.2","dist":{"integrity":"sha512-UVcNM43Aj6zviXbtB4GmZv9xPQZ2U/rKovX3lOXwzbw2JzgSc/mF80zRxuIikSr7aTLz18JqBzgWPwaesFoyeA==","shasum":"f8c0b2bb1335795af79f0b953ffdfe5ce6ca1171","tarball":"https://registry.npmjs.org/@ads-vdh/qnamaker-api/-/qnamaker-api-1.0.4.tgz","fileCount":3,"unpackedSize":8910,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJelLm+CRA9TVsSAnZWagAApnQP/AmhHsBtScuab4q3mKHP\nvCripMBaGjL/zHUEVCrOBWtO8Ao26A7vyvLJdv++EqvSKM3dIS7T2j61QxUk\n/lv0TCMJ55/stYdtvVkb8hhaMcCOpLoadH2/TJpMhlRwnhxc1+//z3LbdQ1T\nqxJ6YJ+nJgrkgxHePOmQ0fIfw2y1RK6vJqyP/9Xmeic+fwjb69wsUN1Xu+WH\nLZmAuLbrRLXwc7uK8J/qdvlxBoWE8Oj3mRtn2bqG783eupr1+EZF0+Dzw+Po\n2/0x5j+vSTQPeNruBeq6hHCY1iC3jODmup3RkFehA76VZpSVhTVS9w8aJwla\nyShfCfeElvqjSTii+RqeITzb/nE2HlkY+yf5UbFbzB+QRInUQoLOqcIgFXhc\n0oqff2Mne/M7pi/FNQNOw1ohoYaCOz8EbnQisMTcy069BAqbEvt1ZJBvwmig\n8m2sy9Kqf1/DekJbdCAiG6HudOPzEJzQRgncIL+4dstXMNeZ2rXocz0W59W1\n+LlDWcVZ3YvmeEtQLq2rt1WY8NjBKRs14k+rZkcaWiIm2z+ygik4RXj/1D80\nQnXbDj89qu/urKzf6FWm9rzPbJfNHYJfGRnHqTrdyXbPMEVppKR+QD5fpA+4\nLtppeLneAHVITuLnDa8DQ0sYrqEEamFaSGSZoYOTkM/Ww98SuT2t3XruUrcE\nayKP\r\n=mfP1\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD0qWis1PGVu2UvanAA4UJNxqpG4XrS/yA8yGx2ebjb6AIgO16ld0+3RSJxFdjkWukaZPfyZhwdvTQuSTMKb4YJkX4="}]},"maintainers":[{"email":"brian.nowak@vermont.gov","name":"bcnowak"},{"email":"John.Mathias@vermont.gov","name":"jmathias3"},{"email":"Kyle.Mitofsky@vermont.gov","name":"kyle-mit-vdh"}],"_npmUser":{"name":"kyle-mit-vdh","email":"Kyle.Mitofsky@vermont.gov"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/qnamaker-api_1.0.4_1586805181619_0.26301129815278923"},"_hasShrinkwrap":false}},"time":{"created":"2020-04-13T14:35:53.013Z","1.0.0":"2020-04-13T14:35:53.435Z","modified":"2022-04-04T11:37:48.073Z","1.0.1":"2020-04-13T15:03:59.373Z","1.0.3":"2020-04-13T19:11:45.462Z","1.0.4":"2020-04-13T19:13:01.785Z"},"maintainers":[{"email":"kyle.mitofsky@vermont.gov","name":"ads-vdh-user"},{"email":"brian.nowak@vermont.gov","name":"bcnowak"},{"email":"John.Mathias@vermont.gov","name":"jmathias3"},{"email":"Kyle.Mitofsky@vermont.gov","name":"kyle-mit-vdh"}],"description":"An unofficial node wrapper for the Microsoft QnAMaker API","homepage":"https://github.com/VermontDepartmentOfHealth/covid-bot#readme","keywords":["azure","QnAMaker","KnoweldgeBase","BotServices"],"repository":{"type":"git","url":"git+https://github.com/VermontDepartmentOfHealth/covid-bot.git"},"bugs":{"url":"https://github.com/VermontDepartmentOfHealth/covid-bot/issues"},"license":"MIT","readme":"Provides a wrapper around the [Cognitive Services APIs](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/) for QnaMaker\r\n\r\n- [KnowledgeBase](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase)\r\n- [Alterations](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/alterations)\r\n\r\n## Installation\r\n\r\nInstall [on npm](https://www.npmjs.com/package/@ads-vdh/qnamaker-api)\r\n\r\n```bash\r\nnpm install @ads-vdh/qnamaker-api --save\r\n```\r\n\r\n## Usage\r\n\r\n**Initialize the Client**:\r\n\r\n```js\r\nlet qnaMakerApi = require(\"@ads-vdh/qnamaker-api\");\r\n\r\nlet client = qnaMakerApi({\r\n  endpoint: endpoint,\r\n  apiKey: ocpApimSubscriptionKey,\r\n  kbId: kbId, // optional (sets default for each method)\r\n});\r\n```\r\n\r\n**Knowledge Base Methods**:\r\n\r\n```js\r\nlet knowledgeBases = await client.knowledgeBase.listAll();\r\nlet knowledgeBase = await client.knowledgeBase.download(kbId);\r\nlet kbDetails = await client.knowledgeBase.getDetails(kbId);\r\n\r\nawait client.knowledgeBase.publish(kbId);\r\nawait client.knowledgeBase.replace(kbId, qnaList);\r\nawait client.knowledgeBase.replace(kbId, qnaUpdates);\r\n```\r\n\r\n**Alterations Methods**:\r\n\r\n```js\r\nlet alterations = await client.alterations.get();\r\nawait client.alterations.replace(alterations);\r\n```\r\n\r\n## Recommendations\r\n\r\nStore your environment variables in a file named `.env` that looks something like this:\r\n\r\n```ini\r\nEndpoint=https://***.cognitiveservices.azure.com\r\nkbId=***\r\nOcpApimSubscriptionKey=***\r\n```\r\n\r\nThen use the [`dot-env`](https://www.npmjs.com/package/dotenv) package to read them in like this:\r\n\r\n```js\r\nrequire(\"dotenv\").config();\r\n```\r\n\r\nwhich should then make the environment variables available like this:\r\n\r\n```js\r\nlet client = qnaMakerApi({\r\n  endpoint: process.env.Endpoint,\r\n  apiKey: process.env.OcpApimSubscriptionKey,\r\n  kbId: process.env.kbId,\r\n});\r\n```\r\n","readmeFilename":"ReadMe.md"}