Node.js (AI) SDK reference

Overview

This topic documents how to get started with the Node.js (AI) SDK, and links to reference information on all of the supported features. You can use either JavaScript or TypeScript when working with the Node.js (AI) SDK.

Get started

LaunchDarkly AI SDKs interact with AI configs. AI configs are the LaunchDarkly resources that manage your AI prompts and model configurations.

You can use the Node.js (AI) SDK to customize your AI config based on the context that you provide. This means both the prompt and the model evaluation in your generative AI application are specific to each end user, at runtime. You can also use the AI SDKs to record metrics from your AI model generation, including duration and tokens.

Follow these instructions to start using the Node.js (AI) SDK in your application.

Install the SDK

First, install the AI SDK as a dependency in your application using your application's dependency manager. If you want to depend on a specific version, refer to the SDK releases page to identify the latest version. The Node.js (AI) SDK is built on the Node.js (server-side) SDK, so you'll need to install that as well.

Here's how:

npm install @launchdarkly/node-server-sdk
npm install @launchdarkly/server-sdk-ai
COPY

Next, import init and initAi in your application code. If you are using TypeScript, you can optionally import the LaunchDarkly LDAIClient and LDAIConfig. These are implied, so are not strictly required.

Here's how:

import { init } from '@launchdarkly/node-server-sdk';
import { initAi, LDAIClient, LDAIConfig } from '@launchdarkly/server-sdk-ai';
COPY

Initialize the client

After you install and import the SDK, create a single, shared instance of LDClient. When the LDClient is initialized, use it to initialize the LDAIClient. The LDAIClient is how you interact with AI configs. Specify the SDK key to authorize your application to connect to a particular environment within LaunchDarkly.

Here's how:

const ldClient: LDClient = init('sdk-key-123abc');
try {
  await ldClient.waitForInitialization({ timeout: 10 });
  // initialization complete
} catch (error) {
  // timeout or SDK failed to initialize
}
const aiClient: LDAIClient = initAi(ldClient);
COPY

Configure the context

Next, configure the context that will use the AI config, that is, the context that will encounter generated AI content in your application. The context attributes determine which version of the AI config LaunchDarkly serves to the end user, based on the targeting rules in your AI config. If you are using template variables in the prompts in your AI config's versions, the context attributes also fill in values for the template variables.

Here's how:

const context: LDContext = {
  kind: 'user',
  key: 'user-key-123abc',
  firstName: 'Sandy',
  lastName: 'Smith',
  email: 'sandy@example.com',
  groups: ['Google', 'Microsoft'],
};
COPY

Customize an AI config

Then, use modelConfig to customize the AI config. This function returns the customized prompt and model. Customization means that any variables you include in the prompt when you define the AI config version have their values set to the context attributes and variables you pass to modelConfig. Then, you can pass the customized prompt directly to your AI.

The customization process within the AI SDK is similar to evaluating flags in one of LaunchDarkly's client-side, server-side, or edge SDKs, in that the SDK completes the customization without a separate network call.

Here's how:

const fallbackModel = {
  model: { modelId: 'my-default-model', name: 'My default model'},
  prompt: [],
  enabled: true,
};
const aiConfig: LDAIConfig = aiClient.modelConfig(
  'ai-config-key-123abc',
  context,
  fallbackModel,
  { 'exampleCustomVariable': 'exampleCustomValue' },
);
COPY

To learn more, read Customizing AI configs.

Record metrics from AI model generation

Finally, use one of the track[Model] functions to record metrics from your AI model generation.

Here's how:

const { tracker } = aiConfig;
const completion = await tracker.trackOpenAI(
  // Pass in the result of the OpenAI operation.
  // When you call the OpenAI operation, use details from aiConfigValue.
  // For instance, you can pass aiConfig.config.prompt
  // and aiConfig.config.model to your specific OpenAI operation.
  //
  // For a complete example, visit https://github.com/launchdarkly/js-core/tree/main/packages/sdk/server-ai/examples/openai.
);
COPY

Alternatively, you can use the SDK's other track* functions to record these metrics manually. You may need to do this if you are using a model for which the SDK does not provide a convenience track[Model] function. The track[Model] functions are expecting a response, so you may also need to do this if your application requires streaming.

To learn more, read Tracking AI metrics.

Supported features

This SDK supports the following features:

• Anonymous contexts
• Context configuration
• Customizing AI configs
• Private attributes
• Tracking AI metrics