AI SDK UI

AI SDK UI is designed to help you build interactive chat, completion, and assistant applications with ease. It is framework-agnostic toolkit, streamlining the integration of advanced AI functionalities into your applications.

AI SDK UI contains the following hooks:

useChat

Use a hook to interact with language models in a chat interface.

useCompletion

Use a hook to interact with language models in a completion interface.

useObject

Use a hook for consuming a streamed JSON objects.

useAssistant

Use a hook to interact with OpenAI assistants.

convertToCoreMessages

Convert useChat messages to CoreMessages for AI core functions.

appendResponseMessages

Append CoreMessage[] from an AI response to an existing array of UI messages.

appendClientMessage

Append a client message to an existing array of UI messages.

createDataStream

Create a data stream to stream additional data to the client.

createDataStreamResponse

Create a response object to stream additional data to the client.

pipeDataStreamToResponse

Pipe a data stream to a Node.js ServerResponse object.

streamData

Stream additional data to the client along with generations.

It also contains the following helper functions:

AssistantResponse

Streaming helper for assistant responses.

UI Framework Support

AI SDK UI supports the following frameworks: React, Svelte, Vue.js, and SolidJS (deprecated). Here is a comparison of the supported functions across these frameworks:

Function	React	Svelte	Vue.js	SolidJS (deprecated)
useChat		Chat
useCompletion		Completion
useObject		StructuredObject
useAssistant

Contributions are welcome to implement missing features for non-React frameworks.