`readUIMessageStream`

UIMessageChunk 스트림을 UIMessage의 AsyncIterableStream으로 변환해 주는 함수예요.

UI 메시지 스트림은 Chat 사용 사례 밖에서도 유용해요. 예를 들어 터미널 UI, 클라이언트에서의 커스텀 스트림 소비, RSC(React Server Components) 같은 곳에서 사용할 수 있어요.

출처: 문서

본문

readUIMessageStream은 UIMessageChunk 스트림을 UIMessage의 AsyncIterableStream으로 변환해 주는 함수예요.

UI 메시지 스트림은 Chat 사용 사례 밖에서도 유용해요. 예를 들어 터미널 UI, 클라이언트에서의 커스텀 스트림 소비, RSC(React Server Components) 같은 곳에서 활용할 수 있어요.

import { readUIMessageStream } from 'ai';

이름	타입	설명
`message` (선택)	`UIMessage`	대화가 재개될 때 시작점으로 사용할 마지막 어시스턴트 메시지예요. 그 외에는 `undefined`예요.
`stream`	`ReadableStream<UIMessageChunk>`	읽을 `UIMessageChunk` 객체의 스트림이에요.
`onError` (선택)	`(error: unknown) => void`	스트림 처리 중 오류가 발생했을 때 호출되는 함수예요.
`terminateOnError` (선택)	`boolean`	오류 발생 시 스트림을 종료할지 여부예요. 기본값은 `false`예요.

UIMessage의 AsyncIterableStream을 반환해요. 각 스트림 부분은 같은 메시지가 완성되어 가는 과정의 서로 다른 상태를 나타내요.

포괄적인 예제와 사용 사례는 UI 메시지 스트림 읽기 문서를 참고하세요.