{"_id":"@caiproject/sapcai","_rev":"1-90f5523871d6f46b823d1d558cf3f1d5","name":"@caiproject/sapcai","dist-tags":{"latest":"1.1.0"},"versions":{"1.1.0":{"name":"@caiproject/sapcai","version":"1.1.0","description":"SAP Conversational AI official SDK in NodeJs","main":"lib/index.js","types":"index.d.ts","directories":{"lib":"lib"},"scripts":{"test":"mocha spec/test.js --compilers js:babel-register","test_coverage":"npm run build && istanbul cover _mocha spec/test.js","build":"babel src -d lib","lint":"eslint src spec"},"repository":{"type":"git","url":"git://github.com/sofiatabioye/SDK-NodeJS.git"},"keywords":["sapcai"],"author":{"name":"SAP CAI team"},"license":"MIT","bugs":{"url":"https://github.com/SAPConversationalAI/SDK-NodeJs/issues"},"homepage":"https://github.com/SAPConversationalAI/SDK-NodeJs#readme","devDependencies":{"babel-cli":"^6.22.0","babel-eslint":"^6.0.4","babel-plugin-transform-runtime":"^6.22.0","babel-preset-es2015":"^6.22.0","babel-preset-stage-0":"^6.22.0","babel-register":"^6.22.0","eslint":"^2.9.0","eslint-config-zavatta":"^3.0.1","eslint-plugin-import":"^1.6.1","sinon":"^1.17.5"},"dependencies":{"babel-runtime":"^6.22.0","chai":"^4.1.2","form-data":"^1.0.1","lodash":"^4.12.0","mocha":"^5.1.0","nock":"^8.0.0","superagent":"^3.8.2","superagent-promise":"^1.1.0","superagent-proxy":"^1.0.3"},"babel":{"presets":["es2015","stage-0"],"plugins":["transform-runtime"]},"eslintConfig":{"extends":["zavatta"],"rules":{"camelcase":0,"no-undef":0,"guard-for-in":0,"no-else-return":0}},"gitHead":"9c8ac4391edcb5198bf6fa4204d7c7221e511ca1","_id":"@caiproject/sapcai@1.1.0","_nodeVersion":"14.17.0","_npmVersion":"6.14.13","dist":{"integrity":"sha512-H66UMlsbcqXO6m6wUj9cEwEi/+XA3Hc6AKNNTZz5k46v0+eoqutd8tAPJMh/U6wjBW33qan2SDQ7I4RkBZU7Wg==","shasum":"95285777541e6da810bbf19ee806b4cb4ec8b393","tarball":"https://registry.npmjs.org/@caiproject/sapcai/-/sapcai-1.1.0.tgz","fileCount":24,"unpackedSize":78699,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg6CoKCRA9TVsSAnZWagAAhHMP/iRgNQz6UBUcxnUnUdUS\nEmhYKJIlzoepeO5ik0selswUhpoaovhAYIT9MRCJZOwft50EFEcyJROBwPgu\nozvKpmeckMns0zYfeWMQWgGv9sTfhP1h095XW9NTHwCjCbUSkYGrInJWAS5J\ndNz2tmVmSV4hdKRZnLhGLII7lD2n0dOH3tGyKQrZgKOug9r8p0spdIEZyqbh\nruWG1A651G67KPCRw3uMtHKlMEL/pebpxcXzDCiT85E/Ow6CJeojfRgfpb7n\nE2TfjeBaCYlLxdbUjJ9sCggd6uUpLG0ZDk93xcKhjCT+4nx+MdwXCb2BFhv2\nymvfz4PBDA7+3gcusIdOj4XAqh4mxwNhtvkC1vj5zKQNdbOhC2R5Ndk7tJ2d\njFHn6Rja/euyQyQYUt7MbCsiiqWQvUnNXqsBpx7hJX6/7ohRTuMxdkXZFmNn\nST7PMWEbj/IKXIKQ/O1vD8lhzUaDriJueGMIlKfdMGwcUYYhyDq7tDT+hMSm\nMteCWrVlBgBjTZy7YNjxh/vD3BWYs2V6i3J+lbGTteFw9OWIKKPWylDDRR5C\nx5E8uPnr00/Z9t2Tfe8ZOpvueEvpIzuZ8EqQ16rtOWpMiMVWpku+ZzREY0XL\niUSz1I3Pxz+GBoSqBV7mpxyMhytDdC+WDPTJNFjSd2R+a3Zqh+CpxPt7i28c\n/uNE\r\n=B1QW\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEdTqJfVwFjTr8QRV82WIHbC59K3A8mEwL06ZNsCTt2xAiAyOsioW1F8SqJRBLz0nWoGLRITctSO7I6C8zZgY8eNDw=="}]},"_npmUser":{"name":"sofiat","email":"abioye.sofiat@outlook.com"},"maintainers":[{"name":"sofiat","email":"abioye.sofiat@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sapcai_1.1.0_1625827849967_0.3947443494466325"},"_hasShrinkwrap":false}},"time":{"created":"2021-07-09T10:50:49.600Z","1.1.0":"2021-07-09T10:50:50.125Z","modified":"2022-04-04T21:31:04.542Z"},"maintainers":[{"name":"sofiat","email":"abioye.sofiat@outlook.com"}],"description":"SAP Conversational AI official SDK in NodeJs","homepage":"https://github.com/SAPConversationalAI/SDK-NodeJs#readme","keywords":["sapcai"],"repository":{"type":"git","url":"git://github.com/sofiatabioye/SDK-NodeJS.git"},"author":{"name":"SAP CAI team"},"bugs":{"url":"https://github.com/SAPConversationalAI/SDK-NodeJs/issues"},"license":"MIT","readme":"\n# SAP Conversational AI - SDK Node.js\nSAP Conversational AI official SDK in Node.js\n\n# 🚨 Sunset of Open Source SDKs for SAP Conversational AI \n \nSAP Conversational AI provides several SDKs, which are all open-source and hosted on GitHub.  \nStarting from January 2021, please note that we inform you that the SDKs will not be available anymore and the public repository of the project will be archived from GitHub.  \n\n## ✨ Why are we sunsetting our SDKs? \n \nFirstly, we noticed over the past year that these SDKs were not used much by our users.  \nThis is because our platform usage has become easier, including the APIs. \n\nSecondly, our APIs have undergone major changes. We would need to adapt the SDKs in order to keep them working, which will lead to a significant cost from our side. \n\nHence, we decided to sunset this open source version starting from January 2021.  \n \n## ✨ What does it mean for me as a user? \n \nAny changes in our API’s will not be reflected in our SDKs. Hence, the code might not work unless you adjust the same.  \n\n## ✨ What are the next steps? \n \nIf you are interested in taking the ownership of the project on GitHub, please get in touch with us and we can discuss the process. Otherwise, if there are no objections from anyone, we would archive the project following the open source sunset process.  \n\nPlease use the platform SAP Answers if you have any other questions related to this topic. \n \nHappy bot building! \n \nThe SAP Conversational AI team\n\n---\n\n\n## Synospis\n\nThis module is a wrapper around the [SAP Conversational AI](https://cai.tools.sap/) [API](https://cai.tools.sap/docs/api-reference) API, and allows you to:\n* [Analyse your text](https://github.com/SAPConversationalAI/SDK-NodeJS/wiki/Analyse-text)\n* [Manage your conversation](https://github.com/SAPConversationalAI/SDK-NodeJS/wiki/Manage-your-conversation)\n* [Receive and send messages](https://github.com/SAPConversationalAI/SDK-NodeJS/wiki/Receive-and-send-messages)\n\n## Installation\n\nInstall the package using npm, as shown below:\n```bash\nnpm install --save sapcai\n```\n\nYou can now use the SDK in your code. All you need is your bot's token. In case you have enabled our versioning feature in the settings of your bot, you can refer to our [versioning documentation](https://cai.tools.sap/docs/concepts/versioning) to learn how to select the appropriate token for you versions and environments.\n\n_Note:_ The `train` API needs to be initialized with the bot version. If versioning is not enabled for the bot, the default `v1` should be used. For more info see our documentation on [versioning](https://cai.tools.sap/docs/concepts/versioning).\n\n#### ES5\n\nUsing the entire SDK:\n```js\nvar sapcai = require('sapcai').default\n\nvar client = new sapcai('YOUR_TOKEN')\n```\n\nExtracting one single API:\n```js\nvar sapcai = require('sapcai').default\n\nvar converse = new sapcai.converse('YOUR_TOKEN')\n```\n\n#### ES6\n\nUsing the entire SDK:\n```js\nimport sapcai from 'sapcai'\n\nconst client = new sapcai('YOUR_TOKEN')\n```\n\nExtracting one single API:\n```js\nimport { converse } from 'sapcai'\n\nconst clientConverse = new converse('YOUR_TOKEN')\n```\n\n## Sample projects\n\nCheck out our [NodeJS starter-kit](https://github.com/SAPConversationalAI/starter-NodeJS) for a usage example of the SDK.\n\n## Resources\n* [Bot Builder Guide](https://cai.tools.sap/docs) - Best practices and tips to use the SAP Conversational AI platform \n* [API Documentation](https://cai.tools.sap/docs/api-reference)\n* [Your first bot](https://cai.tools.sap/blog/build-your-first-bot-with-recast-ai/) - Build your first bot with Bot Builder\n* [Advanced chatbot tutorial(Moviebot)](https://cai.tools.sap/blog/nodejs-chatbot-movie-bot/) - Overview of how to get started building your bot's server\n\nYou can follow us on Twitter at [@sapcai](https://twitter.com/sapcai) for updates and releases.\n\n## Getting started with SAP Conversational AI\n\nWe build products to help enterprises and developers have a better understanding of user inputs.\n\n-   **NLP API**: a unique API for text processing, and augmented training.\n-   **Bot Building Tools**: all you need to create smart bots powered by SAP Conversational AI's NLP API. Design even the most complex conversation flow, use all rich messaging formats and connect to external APIs and services.\n-   **Bot Connector API**: standardizes the messaging format across all channels, letting you connect your bots to any channel in minutes.\n\nLearn more about:\n\n| [API Documentation](https://cai.tools.sap/docs/api-reference/) | [Discover the platform](https://cai.tools.sap/docs/create-your-bot) | [First bot tutorial](https://cai.tools.sap/blog/build-your-first-bot-with-recast-ai/) | [Advanced NodeJS tutorial](https://cai.tools.sap/blog/nodejs-chatbot-movie-bot/) | [Advanced Python tutorial](https://cai.tools.sap/blog/python-cryptobot/) |\n|---|---|---|---|---|\n\n## License\n\nCopyright (c) [2019] [SAP Conversational AI](https://cai.tools.sap)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","readmeFilename":"README.md"}