@vraksha/bottender-qna-maker 1.7.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017-present Yoctol (github.com/Yoctol/bottender)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,97 @@
+# @vraksha/bottender-qna-maker
+
+[QnA Maker](https://www.qnamaker.ai/) integration for Bottender.
+
+## Installation
+
+You can install it with npm:
+
+```sh
+npm install @vraksha/bottender-qna-maker
+```
+
+or Yarn:
+
+```sh
+yarn add @vraksha/bottender-qna-maker
+```
+
+## Usage
+
+```js
+const { chain } = require('bottender');
+const qnaMaker = require('@vraksha/bottender-qna-maker');
+
+async function Unknown(context) {
+  await context.sendText('Sorry, I don’t know what you say.');
+}
+
+const QnaMaker = qnaMaker({
+  resourceName: 'RESOURCE_NAME',
+  knowledgeBaseId: 'KNOWLEDGE_BASE_ID',
+  endpointKey: 'ENDPOINT_KEY',
+  scoreThreshold: 70,
+});
+
+module.exports = async function App() {
+  return chain([
+    QnaMaker, //
+    Unknown,
+  ]);
+};
+```
+
+## Reference
+
+### resourceName
+
+Name of Azure Resource.
+
+Type: `string`
+Required.
+
+### knowledgeBaseId
+
+Knowledgebase id.
+
+Type: `string`
+Required.
+
+### endpointKey
+
+API key.
+
+Type: `string`
+Required.
+
+### isTest
+
+Query against the test index.
+
+Type: `boolean`
+Optional.
+
+### qnaId
+
+Exact qnaId to fetch from the knowledgebase, this field takes priority over question.
+
+Type: `string`
+Optional.
+
+### scoreThreshold
+
+Threshold for answers returned based on score.
+
+Type: `number`
+Optional.
+
+### strictFilters
+
+Find only answers that contain these metadata.
+
+Type: `MetadataDTO[]`
+Optional.
+
+## License
+
+MIT © [Yoctol](https://github.com/Yoctol/bottender)

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+import { Action, Context } from '@vraksha/bottender';
+import { MetadataDTO } from './types';
+declare const _default: ({ resourceName, knowledgeBaseId, endpointKey, isTest, qnaId, scoreThreshold, strictFilters, }: {
+    resourceName: string;
+    knowledgeBaseId: string;
+    endpointKey: string;
+    isTest?: string | undefined;
+    qnaId?: string | undefined;
+    scoreThreshold?: number | undefined;
+    strictFilters?: MetadataDTO[] | undefined;
+}) => Action<Context>;
+export = _default;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAErD,OAAO,EAAE,WAAW,EAAuB,MAAM,SAAS,CAAC;;kBA0B3C,MAAM;qBACH,MAAM;iBACV,MAAM;;;;;MAKjB,OAAO,OAAO,CAAC;AAhBnB,kBAgFE"}

package/dist/index.js

@@ -0,0 +1,59 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const axios_1 = __importDefault(require("axios"));
+const invariant_1 = __importDefault(require("invariant"));
+const RECOMMENDED_THRESHOLD = 50;
+module.exports = function qnaMaker({ resourceName, knowledgeBaseId, endpointKey, isTest, qnaId, scoreThreshold = RECOMMENDED_THRESHOLD, strictFilters, }) {
+    (0, invariant_1.default)(typeof resourceName === 'string' && resourceName.length > 0, 'qna-maker: `resourceName` is a required parameter.');
+    (0, invariant_1.default)(typeof knowledgeBaseId === 'string' && knowledgeBaseId.length > 0, 'qna-maker: `knowledgeBaseId` is a required parameter.');
+    (0, invariant_1.default)(typeof endpointKey === 'string' && endpointKey.length > 0, 'qna-maker: `endpointKey` is a required parameter.');
+    return function QnaMaker(context, { next }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!context.event.isText || !context.session) {
+                return next;
+            }
+            const { data } = yield axios_1.default.post(`https://${resourceName}.azurewebsites.net/qnamaker/knowledgebases/${knowledgeBaseId}/generateAnswer`, {
+                isTest,
+                qnaId,
+                question: context.event.text,
+                scoreThreshold,
+                strictFilters,
+                top: 1,
+                userId: context.session.user ? context.session.user.id : undefined,
+            }, {
+                headers: {
+                    Authorization: `EndpointKey ${endpointKey}`,
+                },
+            });
+            const topAnswer = data.answers[0];
+            if (!topAnswer || (next && topAnswer.id === -1)) {
+                context.setAsNotHandled();
+                return next;
+            }
+            return function TopAnswer() {
+                return __awaiter(this, void 0, void 0, function* () {
+                    if (topAnswer.id !== -1) {
+                        context.setIntent(`qna_${topAnswer.id}`);
+                        context.setAsHandled();
+                    }
+                    else {
+                        context.setAsNotHandled();
+                    }
+                    yield context.sendText(topAnswer.answer);
+                });
+            };
+        });
+    };
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,kDAA0B;AAC1B,0DAAkC;AAOlC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAajC,iBAAS,SAAS,QAAQ,CAAC,EACzB,YAAY,EACZ,eAAe,EACf,WAAW,EACX,MAAM,EACN,KAAK,EACL,cAAc,GAAG,qBAAqB,EACtC,aAAa,GASd;IACC,IAAA,mBAAS,EACP,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAC3D,oDAAoD,CACrD,CAAC;IAEF,IAAA,mBAAS,EACP,OAAO,eAAe,KAAK,QAAQ,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EACjE,uDAAuD,CACxD,CAAC;IAEF,IAAA,mBAAS,EACP,OAAO,WAAW,KAAK,QAAQ,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EACzD,mDAAmD,CACpD,CAAC;IAEF,OAAO,SAAe,QAAQ,CAC5B,OAAgB,EAChB,EAAE,IAAI,EAA8B;;YAEpC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;gBAC7C,OAAO,IAAI,CAAC;aACb;YAGD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,eAAK,CAAC,IAAI,CAC/B,WAAW,YAAY,8CAA8C,eAAe,iBAAiB,EACrG;gBACE,MAAM;gBACN,KAAK;gBACL,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI;gBAC5B,cAAc;gBACd,aAAa;gBACb,GAAG,EAAE,CAAC;gBACN,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS;aACnE,EACD;gBACE,OAAO,EAAE;oBACP,aAAa,EAAE,eAAe,WAAW,EAAE;iBAC5C;aACF,CACF,CAAC;YAKF,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAElC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,IAAI,SAAS,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE;gBAC/C,OAAO,CAAC,eAAe,EAAE,CAAC;gBAC1B,OAAO,IAAI,CAAC;aACb;YAED,OAAO,SAAe,SAAS;;oBAC7B,IAAI,SAAS,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE;wBACvB,OAAO,CAAC,SAAS,CAAC,OAAO,SAAS,CAAC,EAAE,EAAE,CAAC,CAAC;wBACzC,OAAO,CAAC,YAAY,EAAE,CAAC;qBACxB;yBAAM;wBACL,OAAO,CAAC,eAAe,EAAE,CAAC;qBAC3B;oBAED,MAAM,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBAC3C,CAAC;aAAA,CAAC;QACJ,CAAC;KAAA,CAAC;AACJ,CAAC,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,40 @@
+export type QnaContext = {
+    isContextOnly: boolean;
+    prompts: PromptDTO[];
+};
+export type MetadataDTO = {
+    name: string;
+    value: string;
+};
+export type PromptDTO = {
+    displayOrder: number;
+    displayText: string;
+    qna: Qna;
+    qnaId: number;
+};
+export type Qna = {
+    answer: string;
+    context: QnaContext;
+    id: number;
+    metadata: MetadataDTO[];
+    questions: string[];
+    source: string;
+};
+export type QnaSearchResult = Qna & {
+    score: number;
+};
+export type QnaSearchResultList = {
+    answers: QnaSearchResult[];
+};
+export type QueryDTO = {
+    context?: QnaContext;
+    isTest?: boolean;
+    qnaId?: string;
+    question: string;
+    rankerType?: string;
+    scoreThreshold?: number;
+    strictFilters?: MetadataDTO[];
+    top?: number;
+    userId?: string;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG;IACvB,aAAa,EAAE,OAAO,CAAC;IACvB,OAAO,EAAE,SAAS,EAAE,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE,GAAG,CAAC;IACT,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,GAAG,GAAG;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,UAAU,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,GAAG,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtD,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,eAAe,EAAE,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,WAAW,EAAE,CAAC;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@vraksha/bottender-qna-maker",
+  "version": "1.7.0",
+  "description": "QnA Maker integration for Bottender.",
+  "license": "MIT",
+  "homepage": "https://bottender.js.org/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Yoctol/bottender.git"
+  },
+  "main": "dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "axios": "^0.21.4",
+    "invariant": "^2.2.4"
+  },
+  "peerDependencies": {
+    "@vraksha/bottender": ">= 1.2.0-0"
+  },
+  "devDependencies": {
+    "@vraksha/bottender": "1.7.0"
+  },
+  "keywords": [
+    "bot",
+    "bottender",
+    "chatbot",
+    "language",
+    "messaging",
+    "nlu",
+    "qna-maker",
+    "understanding"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}