JavaScript

The JavaScipt SDK allows you to add a custom chat experience to web pages. For example, you can use the JavaScript SDK to create your own web-based chat widget.

The source code can be found on GitHub.

Usage example

const teneoEngineUrl = 'https://some.teneo/engine-instance/';

const logResponse = (response) => {
  console.log(response.output);
  return response;
}

TIE.sendInput(teneoEngineUrl, null, {text: 'Hello there'})
  .then(logResponse)
  .then(() => TIE.sendInput(teneoEngineUrl, null, {text: 'How are you doing?'}))
  .then(logResponse)
  .then(() => TIE.close(teneoEngineUrl));

Download options

To use the Teneo JavaScript client api in a web project, the tie-client.js file needs to be added to your project. You can obtain it in the following ways:

Download compiled tie-client.js

You can download the latest release of the tie-client.js file from the releases on Github.

Download source code and compile it yourself

If you prefer to download the repository from github and compile the tie-client.js file yourself, proceed as follows:

Download or clone the SDK repository from Github:

git clone https://github.com/artificialsolutions/tie-api-client-js.git

Install dependencies:

npm install

Run the build script:

npm run build

You can now find tie-client.js file in the /dist folder.

Use NPM to include the SDK in your project

If you have an existing project and you want to add the SDK to your project using NPM, 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.

const teneoApi = TIE.init('http://some.teneo/engine-instance/');

Once initialized, you no longer need to provide the url subsequent api calls. The same usage example as above then looks like this:

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

const logResponse = (response) => {
  console.log(response.output);
  return response;
}

teneoApi.sendInput(null, {text: 'Hello there'})
  .then(logResponse)
  .then(() => teneoApi.sendInput(null, {text: 'How are you doing?'}))
  .then(logResponse)
  .then(() => teneoApi.close());

Signature

TIE.init(url: string)

Parameters

Managing sessions

Generally, you should not need to pass the session ID when using the API in the browser.