@ads-vdh/qnamaker-api

Provides a wrapper around the Cognitive Services APIs for QnaMaker

- KnowledgeBase
- Alterations

Installation

Install on npm

``bash
npm install @ads-vdh/qnamaker-api --save
`

Usage

Initialize the Client:

`js
let qnaMakerApi = require("@ads-vdh/qnamaker-api");

let client = qnaMakerApi({
endpoint: endpoint,
apiKey: ocpApimSubscriptionKey,
kbId: kbId, // optional (sets default for each method)
});
`

Knowledge Base Methods:

`js
let knowledgeBases = await client.knowledgeBase.listAll();
let knowledgeBase = await client.knowledgeBase.download(kbId);
let kbDetails = await client.knowledgeBase.getDetails(kbId);

await client.knowledgeBase.publish(kbId);
await client.knowledgeBase.replace(kbId, qnaList);
await client.knowledgeBase.replace(kbId, qnaUpdates);
`

Alterations Methods:

`js
let alterations = await client.alterations.get();
await client.alterations.replace(alterations);
`

Recommendations

Store your environment variables in a file named .env that looks something like this:

`ini
Endpoint=https://*.cognitiveservices.azure.com
kbId=*
OcpApimSubscriptionKey=*
`

Then use the dot-env package to read them in like this:

`js
require("dotenv").config();
`

which should then make the environment variables available like this:

`js
let client = qnaMakerApi({
endpoint: process.env.Endpoint,
apiKey: process.env.OcpApimSubscriptionKey,
kbId: process.env.kbId,
});
``