Arize Phoenix TS
    Preparing search index...

    Function tracePrompt

    • Experimental

      Wraps a function with tracing capabilities, specifically marking it as a PROMPT span.

      This is a convenience function that wraps withSpan with the OpenInference span kind pre-configured to PROMPT. Prompt spans represent operations that construct, render, or template a prompt before it is sent to a language model, such as formatting a prompt template with variables or assembling a set of messages.

      This API is experimental and may change in future versions

      Type Parameters

      • Fn extends AnyFn

        The function type being wrapped, preserving original signature

      Parameters

      • fn: Fn

        The function to wrap with PROMPT span tracing

      • Optionaloptions: Omit<SpanTraceOptions<AnyFn>, "kind">

        Configuration options for tracing behavior (excluding kind)

        • tracer

          Custom OpenTelemetry tracer instance (otherwise the current global tracer provider is resolved when the wrapper is invoked)

        • name

          Custom span name (defaults to function name)

        • openTelemetrySpanKind

          OpenTelemetry span kind (defaults to INTERNAL)

        • processInput

          Custom function to process input arguments into attributes

        • processOutput

          Custom function to process output values into attributes

        • attributes

          Base attributes to be added to every span created

      Returns Fn

      A wrapped function with identical signature that creates PROMPT spans during execution

      // Trace a prompt template rendering
      const renderPrompt = (variables: Record<string, string>) => {
        return promptTemplate.format(variables);
      };
      const tracedPrompt = tracePrompt(renderPrompt, { name: "render-prompt" });

    Settings

    Member Visibility