SDK Installation

Install the SDK

The SDK runs in your backend and requires Redis and MongoDB drivers for history and local tool execution.

Install

Install the SDK plus Redis and Mongo drivers.

terminal

npm install @telygent/ai-sdk
npm install ioredis mongodb

Environment

Store credentials and connection strings in your server environment.

.env

TELYGENT_API_KEY=your_api_key
REDIS_URL=redis://localhost:6379
MONGO_URI=mongodb://localhost:27017
MONGO_DB_NAME=appdb

After installing the AI-SDK, there are a few things to setup in the function/controller where you wish to use Telygent AI

Create history store

The history store is where you want to save conversation messages. You can choose to store messages temporarily using Redis or use one of the available DB Stores for example: MongoHistoryStore to save conversations to a collection in your mongo db.

Create database adapter

After creating your history store, you have to connect your database using one of the available db adapters.

Build your registry

This is where you setup what database collections/tables you want the AI to access and what fields are in the tables and instructions on how to use the table etc.

Create AI client

With your history store, db adapter and registry now set, all you need to do is initialize the Telygent AiClient with these details and your apiKey.

Next steps

Define your registry

Set allowed fields, required filters, and model instructions.

Set up DB adapters

Initialize Mongo tooling for local query execution.

Sending requests

Create request handlers with client.query().