Package Exports

@nlbridge/express
@nlbridge/express/esm/nlbridge-express.js
@nlbridge/express/index.js
@nlbridge/express/umd/nlbridge-express.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@nlbridge/express) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

`nlbridge` Express.js 🌲💬 🌉

About `nlbridge`

nlbridge is a Node.js library that provides utilities, middleware, and a development server for building APIs powered by large language models.

This package @nlbridge/express provides an Express.js middleware for nlbridge. It can be used to build custom APIs that connect to large language models, and expose them as HTTP endpoints. It's designed to easily integrate with nlux (the conversational UI React and JS library), but it can also be used independently with any other client.

Using `@nlbridge/express`

To use the nlbridge middleware in your own Express.js server, install the @nlbridge/express package:

npm install @nlbridge/express

Then, use the middleware in your Express.js server:

import {middleware} from '@nlbridge/express';

const app = express();

app.use(middleware(
    // The AI backend to use (e.g. 'openai'). Only OpenAI is supported at the moment.
    'openai',
    // Configuration object. Ref below for details.
    config,
));

Config is an object with the following type:

type MiddlewareConfig = {
    apiKey?: string;
    chatModel?: string;
    chatMode?: 'stream' | 'block';
};

Building UIs with `nlux` and `nlbridge`

nlbridge is designed to work seamlessly with nlux, the conversational UI library for any large language model.
To learn more, please refer to the nlux documentation.