Interface LDAIConfigTracker

Readonly resumptionToken

getSummary

• getSummary(): LDAIMetricSummary

• Get a summary of the tracked metrics.

  Returns LDAIMetricSummary

getTrackData

• getTrackData(): {
      configKey: string;
      graphKey?: string;
      modelName: string;
      providerName: string;
      runId: string;
      variationKey: string;
      version: number;
  }

• Get the data for tracking.

  Returns {
      configKey: string;
      graphKey?: string;
      modelName: string;
      providerName: string;
      runId: string;
      variationKey: string;
      version: number;
  }

  • configKey: string

  • Optional graphKey?: string

  • modelName: string

  • providerName: string

  • runId: string

  • variationKey: string

  • version: number

trackBedrockConverseMetrics

• trackBedrockConverseMetrics<TRes>(res): TRes

• Track an operation which uses Bedrock.

  This function will track the duration of the operation, the token usage, and the success or error status.

  Type Parameters

  • TRes extends {
        $metadata: {
            httpStatusCode?: number;
        };
        metrics?: {
            latencyMs?: number;
        };
        usage?: {
            inputTokens?: number;
            outputTokens?: number;
            totalTokens?: number;
        };
    }

  Parameters

  • res: TRes

    The result of the Bedrock operation.

  Returns TRes

  The input operation.

trackDuration

• trackDuration(durationMs): void

• Track the duration of generation.

  At-most-once per execution: subsequent calls on the same tracker are dropped with a warning. Use createTracker() on the config result to obtain a fresh tracker for a new execution.

  Ideally this would not include overhead time such as network communication.

  Parameters

  • durationMs: number

    The duration in milliseconds.

  Returns void

trackDurationOf

• trackDurationOf(func): Promise<any>

• Track the duration of execution of the provided function.

  If the provided function throws, then this method will also throw. In the case the provided function throws, this function will still record the duration.

  This function does not automatically record an error when the function throws.

  Parameters

  • func: (() => Promise<any>)

    The function to track the duration of.

    • • (): Promise<any>

      • Returns Promise<any>

  Returns Promise<any>

  The result of the function.

trackError

• trackError(): void

• An error was encountered during generation.

  At-most-once per execution: subsequent calls (including trackSuccess) on the same tracker are dropped with a warning.

  Returns void

trackFeedback

• trackFeedback(feedback): void

• Track sentiment about the generation.

  At-most-once per execution: subsequent calls on the same tracker are dropped with a warning.

  Parameters

  • feedback: {
        kind: LDFeedbackKind;
    }

    Feedback about the generation.

    • kind: LDFeedbackKind

  Returns void

trackJudgeResult

• trackJudgeResult(result): void

• Track a judge evaluation result.

  No event is emitted when the result was not sampled (result.sampled is false).

  Parameters

  • result: LDJudgeResult

    Judge result containing score, reasoning, and metadata

  Returns void

trackMetricsOf

• trackMetricsOf<TRes>(metricsExtractor, func): Promise<TRes>

• Track metrics for a generic AI operation.

  This function will track the duration of the operation, extract metrics using the provided metrics extractor function, and track success or error status accordingly.

  If the provided function throws, then this method will also throw. In the case the provided function throws, this function will record the duration and an error. A failed operation will not have any token usage data.

  Type Parameters

  • TRes

  Parameters

  • metricsExtractor: ((result) => LDAIMetrics)

    Function that extracts LDAIMetrics from the operation result

    • • (result): LDAIMetrics

      • Parameters

        • result: TRes

        Returns LDAIMetrics

  • func: (() => Promise<TRes>)

    Function which executes the operation

    • • (): Promise<TRes>

      • Returns Promise<TRes>

  Returns Promise<TRes>

  The result of the operation

trackOpenAIMetrics

• trackOpenAIMetrics<TRes>(func): Promise<TRes>

• Track an OpenAI operation.

  This function will track the duration of the operation, the token usage, and the success or error status.

  If the provided function throws, then this method will also throw. In the case the provided function throws, this function will record the duration and an error. A failed operation will not have any token usage data.

  Type Parameters

  • TRes extends {
        usage?: {
            completion_tokens?: number;
            prompt_tokens?: number;
            total_tokens?: number;
        };
    }

  Parameters

  • func: (() => Promise<TRes>)

    Function which executes the operation.

    • • (): Promise<TRes>

      • Returns Promise<TRes>

  Returns Promise<TRes>

  The result of the operation.

trackStreamMetricsOf

• trackStreamMetricsOf<TStream>(streamCreator, metricsExtractor): TStream

• Track metrics for a streaming AI operation.

  This function will track the duration of the operation, extract metrics using the provided metrics extractor function, and track success or error status accordingly.

  Unlike trackMetricsOf, this method is designed for streaming operations where:

  • The stream is created and returned immediately (synchronously)
  • Metrics are extracted asynchronously in the background once the stream completes
  • Duration is tracked from stream creation to metrics extraction completion

  The stream is returned immediately so the caller can begin consuming it without waiting. Metrics extraction happens in the background and does not block stream consumption.

  If the stream creator throws, then this method will also throw and record an error. If metrics extraction fails, the error is logged but does not affect stream consumption.

  Type Parameters

  • TStream

  Parameters

  • streamCreator: (() => TStream)

    Function that creates and returns the stream (synchronous)

    • • (): TStream

      • Returns TStream

  • metricsExtractor: ((stream) => Promise<LDAIMetrics>)

    Function that asynchronously extracts metrics from the stream

    • • (stream): Promise<LDAIMetrics>

      • Parameters

        • stream: TStream

        Returns Promise<LDAIMetrics>

  Returns TStream

  The stream result (returned immediately, not a Promise)

trackSuccess

• trackSuccess(): void

• Generation was successful.

  At-most-once per execution: subsequent calls (including trackError) on the same tracker are dropped with a warning.

  Returns void

trackTimeToFirstToken

• trackTimeToFirstToken(timeToFirstTokenMs): void

• Track the time to first token for this generation.

  At-most-once per execution: subsequent calls on the same tracker are dropped with a warning.

  Parameters

  • timeToFirstTokenMs: number

    The duration in milliseconds.

  Returns void

trackTokens

• trackTokens(tokens): void

• Track information about token usage.

  At-most-once per execution: subsequent calls on the same tracker are dropped with a warning.

  Parameters

  • tokens: LDTokenUsage

    Token usage information.

  Returns void

trackToolCall

• trackToolCall(toolKey): void

• Track a single tool invocation.

  Parameters

  • toolKey: string

    The identifier of the tool that was invoked.

  Returns void

trackToolCalls

• trackToolCalls(toolKeys): void

• Track multiple tool invocations.

  Parameters

  • toolKeys: string[]

    The identifiers of the tools that were invoked.

  Returns void

trackVercelAISDKGenerateTextMetrics

• trackVercelAISDKGenerateTextMetrics<TRes>(func): Promise<TRes>

• Track a Vercel AI SDK generateText operation.

  This function will track the duration of the operation, the token usage, and the success or error status.

  If the provided function throws, then this method will also throw. In the case the provided function throws, this function will record the duration and an error. A failed operation will not have any token usage data.

  Type Parameters

  • TRes extends {
        usage?: {
            completionTokens?: number;
            inputTokens?: number;
            outputTokens?: number;
            promptTokens?: number;
            totalTokens?: number;
        };
    }

  Parameters

  • func: (() => Promise<TRes>)

    Function which executes the operation.

    • • (): Promise<TRes>

      • Returns Promise<TRes>

  Returns Promise<TRes>

  The result of the operation.