rulvar API reference

---

rulvar API reference / @rulvar/openai / mapResponsesStream

Function: mapResponsesStream()

function mapResponsesStream(
   stream, 
   ids, 
   emit, 
options?): Promise<void>;

Defined in: packages/openai/src/wire.ts:266

Maps the typed Responses SSE stream to ChatEvents. Canonical parts come from the typed output array, never the output_text aggregate. Raw output items ride finish.providerMetadata.openai.outputItems so the runtime can retain reasoning items as provider-raw parts.

Parameters

Parameter	Type
stream	AsyncIterable<ResponsesStreamEvent>
ids	OpenAiIdMap
emit	(event) => void
options?	{ effortDownmapped?: boolean; }
options.effortDownmapped?	boolean

Returns

Promise<void>