judgeval

wrap()

Wrap a supported LLM client to add automatic tracing.

Currently supports OpenAI clients. Detects the client type automatically and applies the appropriate instrumentation.

import OpenAI from "openai";
import { wrap } from "judgeval";

const client = wrap(new OpenAI());

function wrap(client: T): T

Parameters

Returns

T - The same client instance, instrumented in-place.

wrapOpenAI()

Instrument an OpenAI client instance to emit Judgment spans.

Patches the following methods in-place:

• client.chat.completions.create (streaming + non-streaming)
• client.chat.completions.parse (non-streaming)
• client.responses.create (streaming + non-streaming)
• client.images.generate (streaming + non-streaming)

function wrapOpenAI(client: T): T

Parameters

Returns

T - The same client instance (mutated).

validateDatasetSchema()

Validate a dataset JSON Schema client-side before sending. Mirrors the server's structural checks so obvious mistakes fail fast; the server remains the source of truth for full JSON Schema validation.

function validateDatasetSchema(schema: unknown): void

Parameters

Returns

void

inferSchemaFromExamples()

Infer a JSON Schema from a set of examples. Convenience for client.datasets.create() when no explicit schema is supplied. Every example must share the same set of non-null fields; inferred types are JSON Schema primitives only (declare a trace column with an explicit schema).

function inferSchemaFromExamples(examples: Example[]): DatasetSchema

Parameters

Returns

DatasetSchema

getGlobalTextmap()

Return the active composite propagator (W3C TraceContext + Judgment Baggage).

function getGlobalTextmap(): TextMapPropagator<any>

Returns

TextMapPropagator<any>

setGlobalTextmap()

Replace the global text-map propagator.

function setGlobalTextmap(propagator: TextMapPropagator<any>): void

Parameters

Returns

void

inject()

Inject trace context and baggage into an outgoing carrier (e.g. HTTP headers).

Call this before making an outbound HTTP request to propagate the current trace across service boundaries.

const headers: Record<string, string> = {};
propagation.inject(headers);
await fetch("https://api.example.com", { headers });

function inject(carrier: Carrier, context?: Context | undefined, setter: TextMapSetter<Carrier> = defaultTextMapSetter as TextMapSetter<Carrier>): void

Parameters

Returns

void

extract()

Extract trace context and baggage from an incoming carrier.

Low-level primitive — most callers should use Tracer.continueTrace instead, which extracts and installs the context in one step.

function extract(carrier: Carrier, context?: Context | undefined, getter: TextMapGetter<Carrier> = defaultTextMapGetter as TextMapGetter<Carrier>): Context

Parameters

Returns

Context - A new Context with the extracted trace and baggage data.

getBaggage()

Retrieve the baggage attached to the given context.

function getBaggage(context: Context): Baggage | undefined

Parameters

Returns

Baggage | undefined

getActiveBaggage()

Retrieve the baggage attached to the active context.

function getActiveBaggage(): Baggage | undefined

Returns

Baggage | undefined

setBaggage()

Attach a baggage to the given context, returning a new context.

function setBaggage(context: Context, baggage: Baggage): Context

Parameters

Returns

Context

deleteBaggage()

Remove the baggage attached to the given context, returning a new context.

function deleteBaggage(context: Context): Context

Parameters

Returns

Context

baggageEntryMetadataFromString()

Create a serializable BaggageEntryMetadata object from a string.

function baggageEntryMetadataFromString(str: string): BaggageEntryMetadata

Parameters

Returns

BaggageEntryMetadata