@launchdarkly/server-sdk-ai 0.1.0 → 0.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@launchdarkly/server-sdk-ai",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "LaunchDarkly AI SDK for Server-Side JavaScript",
   "homepage": "https://github.com/launchdarkly/js-core/tree/main/packages/sdk/server-ai",
   "repository": {
@@ -16,7 +16,7 @@
     "prettier": "prettier --write '**/*.@(js|ts|tsx|json|css)' --ignore-path ../../../.prettierignore",
     "lint:fix": "yarn run lint --fix",
     "check": "yarn prettier && yarn lint && yarn build && yarn test",
-    "test": "echo No tests added yet."
+    "test": "jest"
   },
   "keywords": [
     "launchdarkly",

package/src/LDAIClientImpl.ts

@@ -41,7 +41,10 @@ export class LDAIClientImpl implements LDAIClient {
     const value: VariationContent = await this._ldClient.variation(key, context, defaultValue);
     // We are going to modify the contents before returning them, so we make a copy.
     // This isn't a deep copy and the application developer should not modify the returned content.
-    const config: LDGenerationConfig = { ...value };
+    const config: LDGenerationConfig = {};
+    if (value.model) {
+      config.model = { ...value.model };
+    }
     const allVariables = { ...variables, ldctx: context };
 
     if (value.prompt) {

package/src/api/LDAIClient.ts

@@ -10,44 +10,50 @@ export interface LDAIClient {
   /**
    * Parses and interpolates a template string with the provided variables.
    *
-   * @param template - The template string to be parsed and interpolated.
-   * @param variables - An object containing the variables to be used for interpolation.
+   * @param template The template string to be parsed and interpolated.
+   * @param variables An object containing the variables to be used for interpolation.
    * @returns The interpolated string.
    */
   interpolateTemplate(template: string, variables: Record<string, unknown>): string;
 
   /**
-   * Retrieves and processes a prompt template based on the provided key, LaunchDarkly context, and
-   * variables.
+   * Retrieves and processes an AI configuration based on the provided key, LaunchDarkly context,
+   * and variables. This includes the model configuration and the processed prompts.
    *
-   * @param key - A unique identifier for the prompt template. This key is used to fetch the correct
-   *  prompt from storage or configuration.
-   * @param context - The LaunchDarkly context object that contains relevant information about the
-   * current environment, user, or session. This context may influence how the prompt is processed
-   * or personalized.
-   * @param variables - A map of key-value pairs representing dynamic variables to be injected into
+   * @param key The key of the AI configuration.
+   * @param context The LaunchDarkly context object that contains relevant information about the
+   * current environment, user, or session. This context may influence how the configuration is
+   * processed or personalized.
+   * @param variables A map of key-value pairs representing dynamic variables to be injected into
    * the prompt template. The keys correspond to placeholders within the template, and the values
    * are the corresponding replacements.
-   * @param defaultValue - A fallback value to be used if the prompt template associated with the
-   * key is not found or if any errors occur during processing.
+   * @param defaultValue A fallback value containing model configuration and prompts. This will
+   * be used if the configurationuration is not available from launchdarkly.
    *
-   * @returns The processed prompt after all variables have been substituted in the stored prompt
-   * template. If the prompt cannot be retrieved or processed, the `defaultValue` is returned.
+   * @returns The AI configurationuration including a processed prompt after all variables have been
+   * substituted in the stored prompt template. This will also include a `tracker` used to track
+   * the state of the AI operation. If the configuration cannot be accessed from LaunchDarkly, then
+   * the return value will include information from the defaultValue.
    *
    * @example
    * ```
    * const key = "welcome_prompt";
    * const context = {...};
    * const variables = {username: 'john'};
-   * const defaultValue = {};
+   * const defaultValue = {
+   *  enabled: false,
+   * };
    *
    * const result = modelConfig(key, context, defaultValue, variables);
    * // Output:
    * {
-   *   modelId: "gpt-4o",
-   *   temperature: 0.2,
-   *   maxTokens: 4096,
-   *   userDefinedKey: "myValue",
+   *   enabled: true,
+   *   config: {
+   *     modelId: "gpt-4o",
+   *     temperature: 0.2,
+   *     maxTokens: 4096,
+   *     userDefinedKey: "myValue",
+   *   },
    *   prompt: [
    *     {
    *       role: "system",
@@ -57,7 +63,8 @@ export interface LDAIClient {
    *       role: "user",
    *       content: "Explain how you're an amazing GPT."
    *     }
-   *   ]
+   *   ],
+   *   tracker: ...
    * }
    * ```
    */

package/src/api/metrics/index.ts

@@ -1,4 +1,3 @@
 export * from './BedrockTokenUsage';
 export * from './LDFeedbackKind';
 export * from './LDTokenUsage';
-export * from './UnderScoreTokenUsage';

package/src/index.ts

@@ -1,3 +1,11 @@
+/**
+ * This is the API reference for the LaunchDarkly AI SDK for Server-Side JavaScript.
+ *
+ * In typical usage, you will call {@link initAi} once at startup time to obtain an instance of
+ * {@link LDAIClient}, which provides access to all of the SDK's functionality.
+ *
+ * @packageDocumentation
+ */
 import { LDAIClient } from './api/LDAIClient';
 import { LDAIClientImpl } from './LDAIClientImpl';
 import { LDClientMin } from './LDClientMin';

package/dist/api/metrics/UnderScoreTokenUsage.d.ts

@@ -1,3 +0,0 @@
-import { LDTokenUsage } from './LDTokenUsage';
-export declare function createUnderscoreTokenUsage(data: any): LDTokenUsage;
-//# sourceMappingURL=UnderScoreTokenUsage.d.ts.map

package/dist/api/metrics/UnderScoreTokenUsage.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"UnderScoreTokenUsage.d.ts","sourceRoot":"","sources":["../../../src/api/metrics/UnderScoreTokenUsage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,GAAG,GAAG,YAAY,CAMlE"}

package/dist/api/metrics/UnderScoreTokenUsage.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createUnderscoreTokenUsage = void 0;
-function createUnderscoreTokenUsage(data) {
-    return {
-        total: data.total_tokens || 0,
-        input: data.prompt_tokens || 0,
-        output: data.completion_tokens || 0,
-    };
-}
-exports.createUnderscoreTokenUsage = createUnderscoreTokenUsage;
-//# sourceMappingURL=UnderScoreTokenUsage.js.map

package/dist/api/metrics/UnderScoreTokenUsage.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"UnderScoreTokenUsage.js","sourceRoot":"","sources":["../../../src/api/metrics/UnderScoreTokenUsage.ts"],"names":[],"mappings":";;;AAEA,SAAgB,0BAA0B,CAAC,IAAS;IAClD,OAAO;QACL,KAAK,EAAE,IAAI,CAAC,YAAY,IAAI,CAAC;QAC7B,KAAK,EAAE,IAAI,CAAC,aAAa,IAAI,CAAC;QAC9B,MAAM,EAAE,IAAI,CAAC,iBAAiB,IAAI,CAAC;KACpC,CAAC;AACJ,CAAC;AAND,gEAMC"}

package/docs/functions/createUnderscoreTokenUsage.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>createUnderscoreTokenUsage | @launchdarkly/server-sdk-ai - v0.1.0</title><meta name="description" content="Documentation for @launchdarkly/server-sdk-ai"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@launchdarkly/server-sdk-ai - v0.1.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@launchdarkly/server-sdk-ai</a></li><li><a href="createUnderscoreTokenUsage.html">createUnderscoreTokenUsage</a></li></ul><h1>Function createUnderscoreTokenUsage</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createUnderscoreTokenUsage" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Underscore<wbr/>Token<wbr/>Usage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/LDTokenUsage.html" class="tsd-signature-type tsd-kind-interface">LDTokenUsage</a><a href="#createUnderscoreTokenUsage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/LDTokenUsage.html" class="tsd-signature-type tsd-kind-interface">LDTokenUsage</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/cc35e9ed1c2a3fe9d6cacb7e9654b9160e90879c/packages/sdk/server-ai/src/api/metrics/UnderScoreTokenUsage.ts#L3">api/metrics/UnderScoreTokenUsage.ts:3</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@launchdarkly/server-sdk-ai - v0.1.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/src/api/metrics/UnderScoreTokenUsage.ts

@@ -1,9 +0,0 @@
-import { LDTokenUsage } from './LDTokenUsage';
-
-export function createUnderscoreTokenUsage(data: any): LDTokenUsage {
-  return {
-    total: data.total_tokens || 0,
-    input: data.prompt_tokens || 0,
-    output: data.completion_tokens || 0,
-  };
-}