Welcome to the official NLX SDK. In this repository you will find several packages that help you use NLX in different ways.
-
I want users of my website to be able to chat or talk to my NLX conversational application, optionally allowing it to interact with my own application using Voice+.
➡️ @nlxai/touchpoint-ui -
I want to build a very custom chat experience for my users, with customizations outwith what Touchpoint provides.
➡️ @nlxai/core -
I want a native mobile experience for my users.
➡️ iOS SDK or Android SDK or @nlxai/core or use the REST API -
I want to integrate my application with a channel not directly supported by NLX.
➡️ @nlxai/core or use the REST API -
I want my application using a telephony channel to interect with my website.
➡️ @nlxai/core. -
I want to automate aspects of my integration with NLX, such as typecheck modalities, sync OpenAPI docs into Data requests or run conversation tests.
➡️ @nlxai/cli
The documentation here on GitHub assumes you are familiar with Typescript and using NPM tooling and package management. However, most of our SDK supports holtinking from CDNs and using JavaScript. Please refer to our documentation website for details.
As such all of these projects come with complete TypeScript type definitions available to use.
The project overall is MIT licensed. Most packages however are licensed under the Attribution-NonCommercial 4.0 International license. NLX customers also get a commercial license as part of their agreement with NLX.