streamToText

function streamToText(stream): Promise<ChatResult>;

Defined in: packages/ai/src/stream-to-response.ts:60

Read a StreamChunk async iterable to the end and return its text and chunks.

text joins the deltas of every TEXT_MESSAGE_CONTENT event. chunks keeps every chunk in order, so tool calls and interrupt outcomes are not lost.

Parameters#

stream#

AsyncIterable<AGUIEvent>

AsyncIterable of StreamChunks from chat()

Returns#

Promise<ChatResult>

A ChatResult with the joined text and every chunk.

Throws#

The error from the first RUN_ERROR chunk.

Example#

const stream = chat({
  adapter: openaiText('gpt-5.5'),
  messages: [{ role: 'user', content: 'Hello!' }]
});
const { text } = await streamToText(stream);
console.log(text); // "Hello! How can I help you today?"