Node.js

You can use the Teneo JavaScript tie-api-client to chat with your bot from a Node.js application. You can use this to make your bot available on messenger platforms like for example Facebook Messenger and Google Assistant. See Channels for examples of connectors that make use of this SDK.

The source code and installation instructions can be found on GitHub.

Example usage

const TIE = require('@artificialsolutions/tie-api-client');

const teneoEngineUrl = 'https://some.teneo/engine-instance/';
const logResponse = (response) => {
  console.log(response.output);
  return response;
}

TIE.sendInput(teneoEngineUrl, null, { text: 'My name is John' })
  .then(logResponse)
  .then(({ sessionId }) => TIE.sendInput(teneoEngineUrl, sessionId, { text: 'What is my name?' }))
  .then(logResponse)
  .then(({ sessionId }) => TIE.close(teneoEngineUrl, sessionId));

The example above first sends an input 'My name is John' to engine. Because this input does not contain a sessionId, engine will start a new session. The response contains a sessionId which is used when the second input 'What is my name?' is sent to engine. Lastly, the session is closed.

Installation

Ensure you have supported versions of Node and NPM installed (see the engines property in package.json). Then run:

npm i @artificialsolutions/tie-api-client

API Documentation

TIE.sendInput

Sends inputData to the url. Returns a Promise if no callback is provided.

Signature

TIE.sendInput(url: string, sessionId: string, inputData: object, [callback: function])

Parameters

The inputData can look as follows:

{
  text: "Some input text",
  someParam: "foo",
  anotherParam: "bar"
}

TIE.close

Closes the running (or specified session). Returns a Promise if no callback is provided.

Signature

TIE.close(url: string, sessionId: string, [callback: function])

Parameters

TIE.init

Returns a version of the Teneo Interaction Engine API with the Teneo Engine url prefilled.

Signature

TIE.init(url: string)

Parameters

Example

// Initialize engine with url
const teneoApi = TIE.init('https://some.teneo/engine-instance/');

// Once initialized, you no longer need to provide the url in subsequent api calls:
teneoApi.sendInput(null, { text: 'Sending some text to the prefilled url' })
    .then(response => {
      console.log(response);
      return teneoApi.close(response.sessionId);
    });