Arize Phoenix TS
    Preparing search index...

    Function traceRetriever

    • Experimental

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

      This is a convenience function that wraps withSpan with the OpenInference span kind pre-configured to RETRIEVER. Retriever spans represent operations that fetch relevant documents or context from a knowledge base, vector store, or search index, typically as part of a retrieval-augmented generation (RAG) workflow.

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

      // Trace a vector store similarity search
      const retrieveDocuments = async (query: string) => {
        return await vectorStore.similaritySearch(query, 5);
      };
      const tracedRetriever = traceRetriever(retrieveDocuments, { name: "vector-search" });

    Settings

    Member Visibility