Interface LDAIClient

Interface for performing AI operations using LaunchDarkly.

interface LDAIClient {
    interpolateTemplate(template: string, variables: Record<string, unknown>): string;
    modelConfig<TDefault>(key: string, context: LDContext, defaultValue: TDefault, variables?: Record<string, unknown>): Promise<LDAIConfig>;
}

Methods

interpolateTemplate modelConfig

Methods

interpolateTemplate

  • interpolateTemplate(template, variables): string

  • Parses and interpolates a template string with the provided variables.

    Parameters

    • template: string

      The template string to be parsed and interpolated.

    • variables: Record<string, unknown>

      An object containing the variables to be used for interpolation.

    Returns string

    The interpolated string.

modelConfig

  • modelConfig<TDefault>(key, context, defaultValue, variables?): Promise<LDAIConfig>

  • Retrieves and processes a prompt template based on the provided key, LaunchDarkly context, and variables.

    Type Parameters

    Parameters

    • key: string

      A unique identifier for the prompt template. This key is used to fetch the correct prompt from storage or configuration.

    • context: LDContext

      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.

    • defaultValue: TDefault

      A fallback value to be used if the prompt template associated with the key is not found or if any errors occur during processing.

    • Optionalvariables: Record<string, unknown>

      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.

    Returns Promise<LDAIConfig>

    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.

    Example

    const key = "welcome_prompt";
    const context = {...};
    const variables = {username: 'john'};
    const defaultValue = {};

    const result = modelConfig(key, context, defaultValue, variables);
    // Output:
    {
      modelId: "gpt-4o",
      temperature: 0.2,
      maxTokens: 4096,
      userDefinedKey: "myValue",
      prompt: [
        {
          role: "system",
          content: "You are an amazing GPT."
        },
        {
          role: "user",
          content: "Explain how you're an amazing GPT."
        }
      ]
    }

Settings

Member Visibility

On This Page

Methods