Remove recast name

Author: Stefan Selent

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 RecastAI
+Copyright (c) 2016 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

README.md

@@ -1,96 +1,98 @@
 <p align="center">
-  <img src="misc/logo2.png" />
+  <img src="https://cdn.cai.tool.sap/brand/sapcai/sap-cai-black.svg" />
 </p>
 
-| [Installation](#installation) | [Sample Projects](#sample-projects) | [Resources]( #resources) | [Getting Started on Recast.AI]( #getting-started-with-recastai) | [License](#license) |
+| [Installation](#installation) | [Sample Projects](#sample-projects) | [Resources]( #resources) | [Getting Started on SAP Conversational AI]( #getting-started-with-sap-conversational-ai) | [License](#license) |
 |---|---|---|---|---|
 <div>
-<a href="https://slack.recast.ai/">💬 Questions / Comments? Join the discussion on our community Slack channel!</a>
+<a href="https://slack.cai.tool.sap">💬 Questions / Comments? Join the discussion on our community Slack channel!</a>
 </div>
 
-# Recast.AI - SDK Node.js
-Recast.AI official SDK in Node.js
+# SAP Conversational AI - SDK Node.js
+SAP Conversational AI official SDK in Node.js
 
 ## Synospis
 
-This module is a wrapper around the [Recast.AI](https://recast.ai/) [API](https://man.recast.ai/) API, and allows you to:
-* [Analyse your text](https://github.com/RecastAI/SDK-NodeJS/wiki/Analyse-text)
-* [Manage your conversation](https://github.com/RecastAI/SDK-NodeJS/wiki/Manage-your-conversation)
-* [Receive and send messages](https://github.com/RecastAI/SDK-NodeJS/wiki/Receive-and-send-messages)
+This module is a wrapper around the [SAP Conversational AI](https://cai.tool.sap/) [API](https://cai.tool.sap/docs/) API, and allows you to:
+* [Analyse your text](https://github.com/SAPConversationalAI/SDK-NodeJS/wiki/Analyse-text)
+* [Manage your conversation](https://github.com/SAPConversationalAI/SDK-NodeJS/wiki/Manage-your-conversation)
+* [Receive and send messages](https://github.com/SAPConversationalAI/SDK-NodeJS/wiki/Receive-and-send-messages)
 
 ## Installation
 
 Install the package using npm, as shown below:
 ```bash
-npm install --save recastai
+npm install --save sapcai
 ```
 
-You can now use the SDK in your code.
+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](https://cai.tools.sap/docs/concepts/versioning) 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](https://cai.tools.sap/docs/concepts/versioning).
 
 #### ES5
 
 Using the entire SDK:
 ```js
-var recastai = require('recastai').default
+var sapcai = require('sapcai').default
 
-var client = new recastai('YOUR_TOKEN')
+var client = new sapcai('YOUR_TOKEN')
 ```
 
 Extracting one single API:
 ```js
-var recastai = require('recastai').default
+var sapcai = require('sapcai').default
 
-var converse = new recastai.converse('YOUR_TOKEN')
+var converse = new sapcai.converse('YOUR_TOKEN')
 ```
 
 #### ES6
 
 Using the entire SDK:
 ```js
-import recastai from 'recastai'
+import sapcai from 'sapcai'
 
-const client = new recastai('YOUR_TOKEN')
+const client = new sapcai('YOUR_TOKEN')
 ```
 
 Extracting one single API:
 ```js
-import { converse } from 'recastai'
+import { converse } from 'sapcai'
 
 const clientConverse = new converse('YOUR_TOKEN')
 ```
 
 ## Sample projects
 
-Check out our [NodeJS starter-kit](https://github.com/RecastAI/starter-NodeJS) for a usage example of the SDK.
+Check out our [NodeJS starter-kit](https://github.com/SAPConversationalAI/starter-NodeJS) for a usage example of the SDK.
 
 ## Resources
-* [Bot Builder Guide](https://recast.ai/docs): Best practices and tips to use the Recast.AI platform 
-* [API Documentation](https://man.recast.ai/)
-* [Your first bot](https://blog.recast.ai/build-your-first-bot-with-recast-ai/) - Build your first bot with Bot Builder
-* [Advanced chatbot tutorial(Moviebot)](https://recast.ai/blog/nodejs-chatbot-movie-bot/) - Overview of how to get started building your bot's server
+* [Bot Builder Guide](https://cai.tool.sap/docs) - Best practices and tips to use the SAP Conversational AI platform 
+* [API Documentation](https://cai.tool.sap/docs/)
+* [Your first bot](https://cai.tool.sap/blog/build-your-first-bot-with-recast-ai/) - Build your first bot with Bot Builder
+* [Advanced chatbot tutorial(Moviebot)](https://cai.tool.sap/blog/nodejs-chatbot-movie-bot/) - Overview of how to get started building your bot's server
 
 ## Author
 
-Jérôme Houdan, jerome.houdan@recast.ai
+Jérôme Houdan, jerome.houdan@sap.com
 
-You can follow us on Twitter at [@recastai](https://twitter.com/recastai) for updates and releases.
+You can follow us on Twitter at [@sapcai](https://twitter.com/sapcai) for updates and releases.
 
-## Getting started with Recast.AI
+## 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 Recast.AI's NLP API. Design even the most complex conversation flow, use all rich messaging formats and connect to external APIs and services.
+-   **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](https://recast.ai/docs/api-reference/) | [Discover the platform](https://recast.ai/docs/create-your-bot) | [First bot tutorial](https://recast.ai/blog/build-your-first-bot-with-recast-ai/) | [Advanced NodeJS tutorial](https://recast.ai/blog/nodejs-chatbot-movie-bot/) | [Advanced Python tutorial](https://recast.ai/blog/python-cryptobot/) |
+| [API Documentation](https://cai.tool.sap/docs/api-reference/) | [Discover the platform](https://cai.tool.sap/docs/create-your-bot) | [First bot tutorial](https://cai.tool.sap/blog/build-your-first-bot-with-recast-ai/) | [Advanced NodeJS tutorial](https://cai.tool.sap/blog/nodejs-chatbot-movie-bot/) | [Advanced Python tutorial](https://cai.tool.sap/blog/python-cryptobot/) |
 |---|---|---|---|---|
 
 ## License
 
-Copyright (c) [2018] [Recast.AI](https://recast.ai)
+Copyright (c) [2018] [SAP Conversational AI](https://cai.tool.sap)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

index.d.ts

@@ -1,9 +1,9 @@
-declare module 'recastai' {
+declare module 'sapcai' {
     export interface Message {
         chatId: string;
         content: string;
         conversationId: string;
-        recastToken: string;
+        sapcaiToken: string;
         senderId: string;
         type: string;
         addReply(replies: object[]): void;

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "recastai",
+  "name": "sapcai",
   "version": "4.0.0",
-  "description": "Recast.AI official SDK in NodeJs",
+  "description": "SAP Conversational AI official SDK in NodeJs",
   "main": "lib/index.js",
   "types": "index.d.ts",
   "directories": {
@@ -15,17 +15,17 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/RecastAI/SDK-NodeJs.git"
+    "url": "git+https://github.com/SAPConversationalAI/SDK-NodeJs.git"
   },
   "keywords": [
-    "recastai"
+    "sapcai"
   ],
-  "author": "Jerome Houdan <jerome.houdan@recast.ai> (https://recast.ai)",
+  "author": "Jerome Houdan <jerome.houdan@sap.com> (https://cai.tool.sap)",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/RecastAI/SDK-NodeJs/issues"
+    "url": "https://github.com/SAPConversationalAI/SDK-NodeJs/issues"
   },
-  "homepage": "https://github.com/RecastAI/SDK-NodeJs#readme",
+  "homepage": "https://github.com/SAPConversationalAI/SDK-NodeJs#readme",
   "devDependencies": {
     "babel-cli": "^6.22.0",
     "babel-eslint": "^6.0.4",

spec/test.js

@@ -6,14 +6,15 @@ import nock from 'nock'
 import path from 'path'
 
 import Client from '../src'
-import { Entity, Conversation, RecastError, Response } from '../src/apis/resources'
+import { Entity, Conversation, SapcaiError, Response } from '../src/apis/resources'
 import json from './resource/json'
 import conversationJson from './resource/conversationJson'
 
-const TOKEN = process.env.RECAST_TOKEN || 'FAKE_TOKEN'
+const TOKEN = process.env.SAPCAI_TOKEN || 'FAKE_TOKEN'
 const LANGUAGE = 'FR'
-const BOT_SLUG = process.env.RECAST_BOT_SLUG || 'FAKE_BOT_SLUG'
-const USER_SLUG = process.env.RECAST_USER_SLUG || 'FAKE_USER_SLUG'
+const BOT_SLUG = process.env.SAPCAI_BOT_SLUG || 'FAKE_BOT_SLUG'
+const USER_SLUG = process.env.SAPCAI_USER_SLUG || 'FAKE_USER_SLUG'
+const BOT_VERSION = process.env.SAPCAI_BOT_VERSION || 'v1'
 
 describe('Client class', () => {
 
@@ -38,7 +39,7 @@ describe('Client class', () => {
 
   it('should be instanciable all params', () => {
     expect(new Client(TOKEN, LANGUAGE, USER_SLUG, BOT_SLUG)).to.be.an.instanceof(Client)
-    expect(new Client(TOKEN, LANGUAGE, USER_SLUG, BOT_SLUG).train).to.not.be.undefined
+    expect(new Client(TOKEN, LANGUAGE, BOT_VERSION, USER_SLUG, BOT_SLUG).train).to.not.be.undefined
   })
 
   // Attribute
@@ -57,12 +58,12 @@ describe('Client class', () => {
   const client = new Client(TOKEN)
 
   describe('textRequest', () => {
-    nock('https://api.recast.ai')
+    nock('https://api.cai.tool.sap')
       .post('/v2/request')
       .once()
       .reply(200, json)
 
-    nock('https://api.recast.ai')
+    nock('https://api.cai.tool.sap')
       .post('/v2/request')
       .once()
       .reply(404, 'invalid parameter')
@@ -93,12 +94,12 @@ describe('Client class', () => {
   })
 
   describe('textConversation', () => {
-    nock('https://api.recast.ai')
+    nock('https://api.cai.tool.sap')
       .post('/v2/converse')
       .once()
       .reply(200, json)
 
-    nock('https://api.recast.ai')
+    nock('https://api.cai.tool.sap')
       .post('/v2/converse')
       .once()
       .reply(404, 'invalid parameter')
@@ -201,9 +202,9 @@ describe('Entity class', () => {
   })
 })
 
-describe('RecastError', () => {
+describe('SapcaiError', () => {
   it('should throw an error', () => {
-    assert.throws(() => { RecastError() }, TypeError, 'Cannot call a class as a function')
+    assert.throws(() => { SapcaiError() }, TypeError, 'Cannot call a class as a function')
   })
 })
 
@@ -246,14 +247,14 @@ describe('Conversation class', () => {
 })
 
 describe('Train class', () => {
-  const client = new Client(TOKEN, LANGUAGE, USER_SLUG, BOT_SLUG)
+  const client = new Client(TOKEN, LANGUAGE, BOT_VERSION, USER_SLUG, BOT_SLUG)
   describe('Bots api', () => {
-    nock('https://api.recast.ai')
+    nock('https://api.cai.tool.sap')
       .get(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}`)
       .once()
       .reply(200, 'success')
 
-    nock('https://api.recast.ai')
+    nock('https://api.cai.tool.sap')
       .put(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}`, { name: 'foo' })
       .once()
       .reply(200, {})
@@ -276,17 +277,17 @@ describe('Train class', () => {
   })
 
   describe('Entities api', () => {
-    nock('https://api.recast.ai')
-      .get(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/entities`)
+    nock('https://api.cai.tool.sap')
+      .get(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/versions/${BOT_VERSION}/dataset/entities`)
       .once()
       .reply(200, 'success')
 
-    nock('https://api.recast.ai')
+    nock('https://api.cai.tool.sap')
       .get('/v2/entities')
       .once()
       .reply(200, 'success')
 
-    nock('https://api.recast.ai')
+    nock('https://api.cai.tool.sap')
       .post('/v2/entities', { slug: 'foo' })
       .once()
       .reply(200, {})
@@ -322,30 +323,32 @@ describe('Train class', () => {
     const synonymSlug = 'mySynonym'
     const data = { slug: 'myGazette' }
 
-    nock('https://api.recast.ai')
-      .get(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/entities`)
+    nock('https://api.cai.tool.sap')
+      .get(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/versions/${BOT_VERSION}/dataset/gazettes`)
       .once().reply(200, 'success')
-      .get(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/gazettes`)
+      .get(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/versions/${BOT_VERSION}/dataset/gazettes/${slug}`)
       .once().reply(200, 'success')
-      .get(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/logs/${slug}`)
+      .delete(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/versions/${BOT_VERSION}/dataset/gazettes/${slug}`)
       .once().reply(200, 'success')
-      .delete(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/logs/${slug}`)
+      .get(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/versions/${BOT_VERSION}/dataset/logs/${slug}`)
       .once().reply(200, 'success')
-      .post(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/gazettes`, data)
+      .delete(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/versions/${BOT_VERSION}/dataset/logs/${slug}`)
       .once().reply(200, 'success')
-      .put(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/gazettes`, data)
+      .post(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/versions/${BOT_VERSION}/dataset/gazettes`, data)
       .once().reply(200, 'success')
-      .get(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/gazettes/${slug}/synonyms`)
+      .put(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/versions/${BOT_VERSION}/dataset/gazettes`, data)
       .once().reply(200, 'success')
-      .get(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/gazettes/${gazetteSlug}/synonyms/${synonymSlug}`)
+      .get(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/versions/${BOT_VERSION}/dataset/gazettes/${slug}/synonyms`)
       .once().reply(200, 'success')
-      .post(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/gazettes/${slug}/synonyms`, data)
+      .get(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/versions/${BOT_VERSION}/dataset/gazettes/${gazetteSlug}/synonyms/${synonymSlug}`)
       .once().reply(200, 'success')
-      .post(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/gazettes/${slug}/synonyms/bulk_create`, [data])
+      .post(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/versions/${BOT_VERSION}/dataset/gazettes/${slug}/synonyms`, data)
       .once().reply(200, 'success')
-      .put(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/gazettes/${gazetteSlug}/synonyms/${synonymSlug}`, data)
+      .post(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/versions/${BOT_VERSION}/dataset/gazettes/${slug}/synonyms/bulk_create`, [data])
       .once().reply(200, 'success')
-      .delete(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/gazettes/${gazetteSlug}/synonyms/${synonymSlug}`)
+      .put(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/versions/${BOT_VERSION}/dataset/gazettes/${gazetteSlug}/synonyms/${synonymSlug}`, data)
+      .once().reply(200, 'success')
+      .delete(`/v2/users/${USER_SLUG}/bots/${BOT_SLUG}/versions/${BOT_VERSION}/dataset/gazettes/${gazetteSlug}/synonyms/${synonymSlug}`)
       .once().reply(200, 'success')
 
     it('Should list gazettes', done => {

src/apis/build/index.js

@@ -31,34 +31,34 @@ export default class Build {
     return request.send(data).then(res => res.body.results)
   }
 
-  getConversation = (user, bot, conversationId, options = {}) => {
+  getConversation = (user, bot, version, conversationId, options = {}) => {
     const token = options.token || this.token
     const proxy = options.proxy
 
-    const request = agent('GET', `${constants.DIALOG_ENDPOINT}/users/${user}/bots/${bot}/builders/v1/conversation_states/${conversationId}`)
+    const request = agent('GET', `${constants.DIALOG_ENDPOINT}/users/${user}/bots/${bot}/versions/${version}/builder/v1/conversation_states/${conversationId}`)
       .set('Authorization', `Token ${token}`)
     if (proxy) { request.proxy(proxy) }
     return request.send()
   }
 
-  updateConversation = (user, bot, conversationId, data = {}, options = {}) => {
+  updateConversation = (user, bot, version, conversationId, data = {}, options = {}) => {
     const token = options.token || this.token
     const proxy = options.proxy
     if (data.memory && data.memory.constructor !== Object) {
       return Promise.reject('Invalid memory parameter')
     }
 
-    const request = agent('PUT', `${constants.DIALOG_ENDPOINT}/users/${user}/bots/${bot}/builders/v1/conversation_states/${conversationId}`)
+    const request = agent('PUT', `${constants.DIALOG_ENDPOINT}/users/${user}/bots/${bot}/versions/${version}/builder/v1/conversation_states/${conversationId}`)
       .set('Authorization', `Token ${token}`)
     if (proxy) { request.proxy(proxy) }
     return request.send(data)
   }
 
-  deleteConversation = (user, bot, conversationId, options = {}) => {
+  deleteConversation = (user, bot, version, conversationId, options = {}) => {
     const token = options.token || this.token
     const proxy = options.proxy
 
-    const request = agent('DELETE', `${constants.DIALOG_ENDPOINT}/users/${user}/bots/${bot}/builders/v1/conversation_states/${conversationId}`)
+    const request = agent('DELETE', `${constants.DIALOG_ENDPOINT}/users/${user}/bots/${bot}/versions/${version}/builder/v1/conversation_states/${conversationId}`)
       .set('Authorization', `Token ${token}`)
     if (proxy) { request.proxy(proxy) }
     return request.send()

src/apis/constants.js

@@ -1,10 +1,10 @@
 export default {
-  REQUEST_ENDPOINT: 'https://api.recast.ai/v2/request',
-  CONVERSE_ENDPOINT: 'https://api.recast.ai/v2/converse',
-  DIALOG_ENDPOINT: 'https://api.recast.ai/build/v1',
-  CONVERSATION_ENDPOINT: 'https://api.recast.ai/connect/v1/messages',
-  MESSAGE_ENDPOINT: 'https://api.recast.ai/connect/v1/conversations/:conversation_id/messages',
-  TRAIN_ENDPOINT: 'https://api.recast.ai/v2',
+  REQUEST_ENDPOINT: 'https://api.cai.tool.sap/v2/request',
+  CONVERSE_ENDPOINT: 'https://api.cai.tool.sap/v2/converse',
+  DIALOG_ENDPOINT: 'https://api.cai.tool.sap/build/v1',
+  CONVERSATION_ENDPOINT: 'https://api.cai.tool.sap/connect/v1/messages',
+  MESSAGE_ENDPOINT: 'https://api.cai.tool.sap/connect/v1/conversations/:conversation_id/messages',
+  TRAIN_ENDPOINT: 'https://api.cai.tool.sap/v2',
 
   ACT_ASSERT: 'assert',
   ACT_COMMAND: 'command',