Javascript

The Javascipt SDK allows you to chat with your bot using JavaScript. You can use this to create your own chat widget.

The source code can be found on GitHub.

Installation

NPM

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

Manually

Alternatively you can download the latest release from 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));

Note that in the browser the session is maintained via cookies and the API cannot manually override the browser's handling of the session. That means that you never need (nor should) pass the session ID when using the API in the browser.

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

Parameter Description
url URL to a running engine instance.
sessionId Session id to be passed to the Teneo Engine instance. Pass null if unknown.
inputData Object containing input data. All keys except text will be sent to the Teneo Engine instance as extra parameters.
callback(error: Error, response: TeneoEngineResponse) Optional. Callback for handling the response from the Teneo Engine instance

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

Parameter Description
url URL to a running engine instance.
sessionId Session id to be passed to the Teneo Engine instance. Pass null if unknown.
callback(error: Error, response: TeneoEngineResponse) Optional. Callback for handling the response from the Teneo Engine instance.

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:

teneoApi.sendInput(null, { text: 'Sending some text to the prefilled url' })
    .then(response =>
      console.log(response);
      return teneoApi.close();
    });

Signature

TIE.init(url: string)

Parameters

Parameter Description
url URL to a running engine instance.

Was this page helpful?