AI
AI SDK RSCrender (Deprecated)

render (Deprecated)

A helper function to create a streamable UI from LLM providers. This function is similar to AI SDK Core APIs and supports the same model interfaces.

Note: render has been deprecated in favor of streamUI. During migration, please ensure that the messages parameter follows the updated specification.

Import 

import { render } from "ai/rsc"

API Signature

Parameters

model:

string
Model identifier, must be OpenAI SDK compatible.

provider:

provider client
Currently the only provider available is OpenAI. This needs to match the model name.

initial?:

ReactNode
The initial UI to render.

messages:

Array<SystemMessage | UserMessage | AssistantMessage | ToolMessage>
A list of messages that represent a conversation.
SystemMessage

role:

'system'
The role for the system message.

content:

string
The content of the message.
UserMessage

role:

'user'
The role for the user message.

content:

string
The content of the message.
AssistantMessage

role:

'assistant'
The role for the assistant message.

content:

string
The content of the message.

tool_calls:

ToolCall[]
A list of tool calls made by the model.
ToolCall

id:

string
The id of the tool call.

type:

'function'
The type of the tool call.

function:

Function
The function to call.
Function

name:

string
The name of the function.

arguments:

string
The arguments of the function.
ToolMessage

role:

'tool'
The role for the tool message.

content:

string
The content of the message.

toolCallId:

string
The id of the tool call.

functions?:

Record<string, Tool>
Tools that are accessible to and can be called by the model.
Tool

description?:

string
Information about the purpose of the tool including details on how and when it can be used by the model.

parameters:

zod schema
The typed schema that describes the parameters of the tool that can also be used to validation and error handling.

render?:

async (parameters) => any
An async function that is called with the arguments from the tool call and produces a result.

tools?:

Record<string, Tool>
Tools that are accessible to and can be called by the model.
Tool

description?:

string
Information about the purpose of the tool including details on how and when it can be used by the model.

parameters:

zod schema
The typed schema that describes the parameters of the tool that can also be used to validation and error handling.

render?:

async (parameters) => any
An async function that is called with the arguments from the tool call and produces a result.

text?:

(Text) => ReactNode
Callback to handle the generated tokens from the model.
Text

content:

string
The full content of the completion.

delta:

string
The delta.

done:

boolean
Is it done?

temperature?:

number
The temperature to use for the model.

Returns

It can return any valid ReactNode.