Getting Started

import { Router, Route, OpenAIEncoder } from 'semantic-node-router';

// 1. Create an encoder
const encoder = new OpenAIEncoder({
  apiKey: process.env.OPENAI_API_KEY,
  model: 'text-embedding-3-small'
});

// 2. Define your routes
const routes = [
  new Route({
    name: 'greeting',
    utterances: ['hello', 'hi there', 'hey', 'good morning']
  }),
  new Route({
    name: 'farewell',
    utterances: ['goodbye', 'bye', 'see you later']
  }),
  new Route({
    name: 'technical_support',
    utterances: [
      'my app is crashing',
      'I got an error',
      'something is broken'
    ]
  })
];

// 3. Create and initialize router
const router = new Router({
  routes,
  encoder
});

await router.initialize(); // Encodes all utterances

// 4. Route queries
const result = await router.route('The app is not working');

console.log(result);
// {
//   route: 'technical_support',
//   score: 0.87
// }

import { Router, Route, TransformersEncoder } from 'semantic-node-router';

// Create and initialize encoder (loads model - one-time ~10s)
const encoder = new TransformersEncoder();
await encoder.initialize();

// Create router
const router = new Router({ routes, encoder });
await router.initialize();

// Route queries (fast! ~10-50ms)
const result = await router.route('hey there');
// { route: 'greeting', score: 0.92 }