@kluai/api-staging v0.0.3

Klu.ai Typescript SDK

Description

Klu SDK for building AI-powerered apps

• Documentation
• GitHub
• Npm

The Klu.ai Typescript SDK is a library that provides access to the Klu API, allowing users to interact with their workspace, including: apps, actions, context, data, and models.

Requirements

The Klu.ai Typescript SDK can be installed in any JS / TS environment. The only requirements is to have npm.

Installation

To install the Klu.ai Typescript SDK, simply run:

npm i @kluai/core

Getting Started

To use the Klu.ai Typescript SDK, you must first obtain an API key from the Klu.AI website. Once you have your API key, you can create a klu object:

import Klu from 'klu';

const klu = new Klu('YOUR_API_KEY');

Once you have a klu object, you can access the different models available in the Klu API:

import Klu from 'klu';

const klu = new Klu('YOUR_API_KEY');
const models = await klu.models.get('model_guid');

There is also a separate function to stream action prompt

Each of these objects provides methods for interacting with the corresponding model in the Klu API. For example, to list all apps in your workspace, you can use:

import Klu from 'klu';

const klu = new Klu('YOUR_API_KEY');
const apps = await klu.apps.paginator.fetchAll();

In a similar manner, in order to get a list of data points for an action, you can do the following

import Klu from 'klu';

const klu = new Klu('YOUR_API_KEY');
const data = await klu.actions.getData('actionId');

There is a special client that allows to stream action prompts. The streaming url can be received from the action creation response.

import Klu from 'klu';

const klu = new Klu('YOUR_API_KEY');

const dataStream = await klu.actions.prompt('actionGuid', 'prompt input', {
  streaming: true,
});
for await (const token of dataStream) {
  tokens.push(token || '');
}

Documentation

For more detailed information on how to use the Klu.ai Typescript SDK, please refer to the API documentation.

License

Free Software: MIT License

The Klu SDK is open source software released under the MIT License. This permissive license allows you to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Klu SDK, subject to a few simple conditions:

• Copyright notice - You must include the copyright notice in all copies or substantial portions of the software.
• License notice - You must include the license notice in all copies or substantial portions of the software.
• Warranty disclaimer - The software is provided "as is" without warranty of any kind. The authors and copyright holders are not liable for any claim, damages or other liability.
• Liability limitation - In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise.