Arize Phoenix TS
    Preparing search index...

    Function traceEmbedding

    • Experimental

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

      This is a convenience function that wraps withSpan with the OpenInference span kind pre-configured to EMBEDDING. Embedding spans represent operations that convert text or other data into vector representations, such as generating embeddings for documents or queries used in semantic search and retrieval.

      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 EMBEDDING 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 EMBEDDING spans during execution

      // Trace an embedding generation call
      const embedText = async (text: string) => {
        return await client.embeddings.create({ model: "text-embedding-3-small", input: text });
      };
      const tracedEmbedding = traceEmbedding(embedText, { name: "embed-text" });

    Settings

    Member Visibility