@vraksha/bottender-luis 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,132 @@
+# @vraksha/bottender-luis
+
+[LUIS](https://www.luis.ai/) integration for Bottender.
+
+## Installation
+
+You can install it with npm:
+
+```sh
+npm install @vraksha/bottender-luis
+```
+
+or Yarn:
+
+```sh
+yarn add @vraksha/bottender-luis
+```
+
+## Usage
+
+```js
+const { chain } = require('bottender');
+const luis = require('@vraksha/bottender-luis');
+
+async function SayHello(context) {
+  await context.sendText('Hello!');
+}
+
+async function Unknown(context) {
+  await context.sendText('Sorry, I don’t know what you say.');
+}
+
+const Luis = luis({
+  appId: 'LUIS_APP_ID',
+  appKey: 'LUIS_APP_KEY',
+  endpoint: 'https://westus.api.cognitive.microsoft.com',
+  actions: {
+    greeting: SayHello,
+  },
+  scoreThreshold: 0.7,
+});
+
+module.exports = async function App() {
+  return chain([
+    Luis, //
+    Unknown,
+  ]);
+};
+```
+
+## Reference
+
+### appId
+
+The LUIS application ID (Guid).
+
+Type: `string`.
+Required.
+
+### appKey
+
+The LUIS application key.
+
+Type: `string`.
+Required.
+
+### endpoint
+
+Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
+
+Type: `string`.
+Required.
+
+### actions
+
+Actions to be executed when the event matches corresponding intent.
+
+Type: `Record<string, Action>`.
+Required.
+
+### scoreThreshold
+
+Threshold of the answer score. The action only be executed when score is over this threshold.
+
+Type: `number`.
+Required.
+
+### verbose
+
+If true, return all intents instead of just the top scoring intent.
+
+Type: `boolean`.
+Optional.
+
+### timezoneOffset
+
+The timezone offset for the location of the request.
+
+Type: `number`.
+Optional.
+
+### staging
+
+Use the staging endpoint slot.
+
+Type: `boolean`.
+Optional.
+
+### spellCheck
+
+Enable spell checking.
+
+Type: `boolean`.
+Optional.
+
+### bingSpellCheckSubscriptionKey
+
+The subscription key to use when enabling Bing spell check.
+
+Type: `string`.
+Optional.
+
+### log
+
+Log query (default is true).
+
+Type: `boolean`.
+Optional.
+
+## License
+
+MIT © [Yoctol](https://github.com/Yoctol/bottender)

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+import { Action, Context } from '@vraksha/bottender';
+import { EntityModel, IntentModel, Sentiment } from './types';
+declare const _default: ({ appId, appKey, endpoint, scoreThreshold, actions, verbose, timezoneOffset, spellCheck, staging, bingSpellCheckSubscriptionKey, log, }: {
+    appId: string;
+    appKey: string;
+    endpoint: string;
+    scoreThreshold: number;
+    actions: Record<string, Action<Context, {
+        topScoringIntent: IntentModel;
+        entities: EntityModel[];
+        sentimentAnalysis: Sentiment;
+    }>>;
+    verbose?: boolean | undefined;
+    timezoneOffset?: number | undefined;
+    spellCheck?: boolean | undefined;
+    staging?: boolean | undefined;
+    bingSpellCheckSubscriptionKey?: string | undefined;
+    log?: boolean | 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,EAAa,MAAM,oBAAoB,CAAC;AAEhE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAc,SAAS,EAAE,MAAM,SAAS,CAAC;;WA+BjE,MAAM;YACL,MAAM;cACJ,MAAM;oBACA,MAAM;aACb,OACP,MAAM,EACN,OACE,OAAO,EACP;QACE,gBAAgB,EAAE,WAAW,CAAC;QAC9B,QAAQ,EAAE,WAAW,EAAE,CAAC;QACxB,iBAAiB,EAAE,SAAS,CAAC;KAC9B,CACF,CACF;;;;;;;MAOC,OAAO,OAAO,CAAC;AAlCnB,kBAoGE"}

package/dist/index.js

@@ -0,0 +1,61 @@
+"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 bottender_1 = require("@vraksha/bottender");
+module.exports = function luis({ appId, appKey, endpoint, scoreThreshold, actions, verbose = true, timezoneOffset, spellCheck, staging, bingSpellCheckSubscriptionKey, log, }) {
+    (0, invariant_1.default)(typeof appId === 'string' && appId.length > 0, 'luis: `appId` is a required parameter.');
+    (0, invariant_1.default)(typeof appKey === 'string' && appKey.length > 0, 'luis: `appKey` is a required parameter.');
+    (0, invariant_1.default)(typeof endpoint === 'string' && endpoint.length > 0, 'luis: `endpoint` is a required parameter.');
+    return function Luis(context, { next }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!context.event.isText) {
+                return next;
+            }
+            const params = {
+                timezoneOffset,
+                verbose,
+                spellCheck,
+                staging,
+                'bing-spell-check-subscription-key': bingSpellCheckSubscriptionKey,
+                log,
+                q: context.event.text,
+            };
+            const { data } = yield axios_1.default.get(`${endpoint}/luis/v2.0/apps/${appId}`, {
+                params,
+                headers: {
+                    'Ocp-Apim-Subscription-Key': appKey,
+                },
+            });
+            const { topScoringIntent, entities, sentimentAnalysis } = data;
+            if (topScoringIntent && topScoringIntent.score > scoreThreshold) {
+                context.setIntent(topScoringIntent.intent);
+                context.setAsHandled();
+                const TargetAction = actions[topScoringIntent.intent];
+                if (TargetAction) {
+                    return (0, bottender_1.withProps)(TargetAction, {
+                        topScoringIntent,
+                        entities,
+                        sentimentAnalysis,
+                    });
+                }
+            }
+            else {
+                context.setAsNotHandled();
+            }
+            return next;
+        });
+    };
+};
+//# 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;AAClC,kDAAgE;AAoBhE,iBAAS,SAAS,IAAI,CAAC,EACrB,KAAK,EACL,MAAM,EACN,QAAQ,EACR,cAAc,EACd,OAAO,EACP,OAAO,GAAG,IAAI,EACd,cAAc,EACd,UAAU,EACV,OAAO,EACP,6BAA6B,EAC7B,GAAG,GAuBJ;IACC,IAAA,mBAAS,EACP,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAC7C,wCAAwC,CACzC,CAAC;IAEF,IAAA,mBAAS,EACP,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAC/C,yCAAyC,CAC1C,CAAC;IAEF,IAAA,mBAAS,EACP,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EACnD,2CAA2C,CAC5C,CAAC;IAEF,OAAO,SAAe,IAAI,CACxB,OAAgB,EAChB,EAAE,IAAI,EAA8B;;YAEpC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE;gBACzB,OAAO,IAAI,CAAC;aACb;YAED,MAAM,MAAM,GAAG;gBACb,cAAc;gBACd,OAAO;gBACP,UAAU;gBACV,OAAO;gBACP,mCAAmC,EAAE,6BAA6B;gBAClE,GAAG;gBACH,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI;aACtB,CAAC;YAGF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,eAAK,CAAC,GAAG,CAC9B,GAAG,QAAQ,mBAAmB,KAAK,EAAE,EACrC;gBACE,MAAM;gBACN,OAAO,EAAE;oBACP,2BAA2B,EAAE,MAAM;iBACpC;aACF,CACF,CAAC;YAEF,MAAM,EAAE,gBAAgB,EAAE,QAAQ,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC;YAE/D,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,KAAK,GAAG,cAAc,EAAE;gBAC/D,OAAO,CAAC,SAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;gBAC3C,OAAO,CAAC,YAAY,EAAE,CAAC;gBAEvB,MAAM,YAAY,GAAG,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;gBAEtD,IAAI,YAAY,EAAE;oBAChB,OAAO,IAAA,qBAAS,EAAC,YAAY,EAAE;wBAC7B,gBAAgB;wBAChB,QAAQ;wBACR,iBAAiB;qBAClB,CAAC,CAAC;iBACJ;aACF;iBAAM;gBACL,OAAO,CAAC,eAAe,EAAE,CAAC;aAC3B;YAED,OAAO,IAAI,CAAC;QACd,CAAC;KAAA,CAAC;AACJ,CAAC,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,34 @@
+export type LuisResult = {
+    alteredQuery: string;
+    compositeEntities: CompositeEntityModel[];
+    connectedServiceResult: LuisResult;
+    entities: EntityModel[];
+    intents: IntentModel[];
+    query: string;
+    sentimentAnalysis: Sentiment;
+    topScoringIntent: IntentModel;
+};
+export type CompositeEntityModel = {
+    children: CompositeChildModel[];
+    parentType: string;
+    value: string;
+};
+export type CompositeChildModel = {
+    type: string;
+    value: string;
+};
+export type IntentModel = {
+    intent: string;
+    score: number;
+};
+export type EntityModel = {
+    endIndex: number;
+    entity: string;
+    startIndex: number;
+    type: string;
+};
+export type Sentiment = {
+    label: string;
+    score: number;
+};
+//# 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,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,oBAAoB,EAAE,CAAC;IAC1C,sBAAsB,EAAE,UAAU,CAAC;IACnC,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB,EAAE,SAAS,CAAC;IAC7B,gBAAgB,EAAE,WAAW,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,EAAE,mBAAmB,EAAE,CAAC;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf,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-luis",
+  "version": "1.7.0",
+  "description": "LUIS 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",
+    "luis",
+    "messaging",
+    "nlu",
+    "understanding"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}