@vraksha/bottender-rasa 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,88 @@
+# @vraksha/bottender-rasa
+
+[Rasa NLU](https://rasa.com/docs/rasa/nlu/about/) integration for Bottender.
+
+## Installation
+
+You can install it with npm:
+
+```sh
+npm install @vraksha/bottender-rasa
+```
+
+or Yarn:
+
+```sh
+yarn add @vraksha/bottender-rasa
+```
+
+## Usage
+
+```js
+const { chain } = require('bottender');
+const rasa = require('@vraksha/bottender-rasa');
+
+async function SayHello(context) {
+  await context.sendText('Hello!');
+}
+
+async function Unknown(context) {
+  await context.sendText('Sorry, I don’t know what you say.');
+}
+
+const Rasa = rasa({
+  origin: 'http://localhost:5005',
+  actions: {
+    greeting: SayHello,
+  },
+  confidenceThreshold: 0.7,
+});
+
+module.exports = async function App() {
+  return chain([
+    Rasa, //
+    Unknown,
+  ]);
+};
+```
+
+## Reference
+
+### origin
+
+The origin of the Rasa NLU server.
+
+Type: `string`.
+Required.
+
+### actions
+
+Actions to be executed when the event matches corresponding intent.
+
+Type: `Record<string, Action>`.
+Required.
+
+### confidenceThreshold
+
+Threshold of the answer confidence. The action only be executed when confidence is over this threshold.
+
+Type: `number`.
+Required.
+
+### emulationMode,
+
+The emulation mode to use in the request.
+
+Type: `'WIT' | 'LUIS' | 'DIALOGFLOW'`.
+Optional.
+
+### jwt
+
+The JSON Web Token (JWT) to use in the request.
+
+Type: `string`.
+Optional.
+
+## License
+
+MIT © [Yoctol](https://github.com/Yoctol/bottender)

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import { Action, Context } from '@vraksha/bottender';
+import { Entity, Intent } from './types';
+declare const _default: ({ origin, actions, confidenceThreshold, emulationMode, jwt, }: {
+    origin: string;
+    actions: Record<string, Action<Context, {
+        intent: Intent;
+        entities: Entity[];
+    }>>;
+    confidenceThreshold: number;
+    emulationMode?: "WIT" | "LUIS" | "DIALOGFLOW" | undefined;
+    jwt?: string | 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":"AACA,OAAO,EAAE,MAAM,EAAE,OAAO,EAAa,MAAM,oBAAoB,CAAC;AAGhE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAgB,MAAM,SAAS,CAAC;;YAuB7C,MAAM;aACL,OACP,MAAM,EACN,OACE,OAAO,EACP;QACE,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,EAAE,CAAC;KACpB,CACF,CACF;yBACoB,MAAM;;;MAGzB,OAAO,OAAO,CAAC;AArBnB,kBA6DE"}

package/dist/index.js

@@ -0,0 +1,48 @@
+"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 bottender_1 = require("@vraksha/bottender");
+const lodash_1 = require("lodash");
+module.exports = function rasa({ origin = 'http://localhost:5005', actions, confidenceThreshold, emulationMode, jwt, }) {
+    return function Rasa(context, { next }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!context.event.isText) {
+                return next;
+            }
+            const { data } = yield axios_1.default.post(`${origin}/model/parse`, {
+                text: context.event.text,
+                message_id: (0, lodash_1.get)(context, 'event.message.id'),
+            }, {
+                params: {
+                    emulation_mode: emulationMode,
+                },
+                headers: jwt ? { Authorization: `bearer ${jwt}` } : undefined,
+            });
+            const { intent, entities } = data;
+            if (intent && intent.confidence > confidenceThreshold) {
+                context.setIntent(intent.name);
+                context.setAsHandled();
+                const TargetAction = actions[intent.name];
+                if (TargetAction) {
+                    return (0, bottender_1.withProps)(TargetAction, { intent, entities });
+                }
+            }
+            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,kDAAgE;AAChE,mCAA6B;AAkB7B,iBAAS,SAAS,IAAI,CAAC,EACrB,MAAM,GAAG,uBAAuB,EAChC,OAAO,EACP,mBAAmB,EACnB,aAAa,EACb,GAAG,GAgBJ;IACC,OAAO,SAAe,IAAI,CACxB,OAAgB,EAChB,EAAE,IAAI,EAA8B;;YAEpC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE;gBACzB,OAAO,IAAI,CAAC;aACb;YAGD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,eAAK,CAAC,IAAI,CAC/B,GAAG,MAAM,cAAc,EACvB;gBACE,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI;gBACxB,UAAU,EAAE,IAAA,YAAG,EAAC,OAAO,EAAE,kBAAkB,CAAC;aAC7C,EACD;gBACE,MAAM,EAAE;oBACN,cAAc,EAAE,aAAa;iBAC9B;gBACD,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS;aAC9D,CACF,CAAC;YAEF,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;YAElC,IAAI,MAAM,IAAI,MAAM,CAAC,UAAU,GAAG,mBAAmB,EAAE;gBACrD,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC/B,OAAO,CAAC,YAAY,EAAE,CAAC;gBAEvB,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC1C,IAAI,YAAY,EAAE;oBAChB,OAAO,IAAA,qBAAS,EAAC,YAAY,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;iBACtD;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,18 @@
+export type ParsedResult = {
+    entities: Entity[];
+    intent: Intent;
+    intent_ranking: Intent[];
+    text: string;
+};
+export type Intent = {
+    name: string;
+    confidence: number;
+};
+export type Entity = {
+    start: number;
+    end: number;
+    value: string;
+    entity: string;
+    confidence: 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,YAAY,GAAG;IACzB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;CACpB,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,40 @@
+{
+  "name": "@vraksha/bottender-rasa",
+  "version": "1.7.0",
+  "description": "Rasa NLU 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": {
+    "@types/lodash": "^4.14.149",
+    "axios": "^0.21.4",
+    "lodash": "^4.17.15"
+  },
+  "peerDependencies": {
+    "@vraksha/bottender": ">= 1.2.0-0"
+  },
+  "devDependencies": {
+    "@vraksha/bottender": "1.7.0"
+  },
+  "keywords": [
+    "bot",
+    "bottender",
+    "chatbot",
+    "language",
+    "messaging",
+    "nlu",
+    "rasa",
+    "understanding"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}