SAP Conversational AI official SDK for Node.js
Branch: master
Clone or download
Latest commit 492bf98 Jan 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
spec Fix new domain name Jan 4, 2019
src Fix new domain name Jan 4, 2019
.gitignore chore(deps) update deps Apr 13, 2018
.npmignore One does not simply push dist on github, neither sources on npm Oct 20, 2016
LICENSE Remove recast name Dec 10, 2018
README.md Fix new domain name Jan 4, 2019
index.d.ts Remove recast name Dec 10, 2018
package.json Fix new domain name Jan 4, 2019

README.md

Installation Sample Projects Resources Getting Started on SAP Conversational AI License

SAP Conversational AI - SDK Node.js

SAP Conversational AI official SDK in Node.js

Synospis

This module is a wrapper around the SAP Conversational AI API API, and allows you to:

Installation

Install the package using npm, as shown below:

npm install --save sapcai

You 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 to learn how to select the appropriate token for you versions and environments.

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.

ES5

Using the entire SDK:

var sapcai = require('sapcai').default

var client = new sapcai('YOUR_TOKEN')

Extracting one single API:

var sapcai = require('sapcai').default

var converse = new sapcai.converse('YOUR_TOKEN')

ES6

Using the entire SDK:

import sapcai from 'sapcai'

const client = new sapcai('YOUR_TOKEN')

Extracting one single API:

import { converse } from 'sapcai'

const clientConverse = new converse('YOUR_TOKEN')

Sample projects

Check out our NodeJS starter-kit for a usage example of the SDK.

Resources

You can follow us on Twitter at @sapcai for updates and releases.

Getting started with SAP Conversational AI

We build products to help enterprises and developers have a better understanding of user inputs.

  • NLP API: a unique API for text processing, and augmented training.
  • 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.
  • Bot Connector API: standardizes the messaging format across all channels, letting you connect your bots to any channel in minutes.

Learn more about:

API Documentation Discover the platform First bot tutorial Advanced NodeJS tutorial Advanced Python tutorial

License

Copyright (c) [2019] SAP Conversational AI

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.