AI SDK UIuseChat
useChat()
Allows you to easily create a conversational user interface for your chatbot application. It enables the streaming of chat messages from your AI provider, manages the state for chat input, and updates the UI automatically as new messages are received.
Import
import { useChat } from 'ai/react'API Signature
Parameters
api:
The chat completion API endpoint offered by the provider.
keepLastMessageOnError:
Keeps the last message when an error happens. This will be the default behavior starting with the next major release. The flag was introduced for backwards compatibility and currently defaults to `false`. Please enable it and update your error handling/resubmit behavior.
id:
An unique identifier for the chat. If not provided, a random one will be generated. When provided, the `useChat` hook with the same `id` will have shared states across components. This is useful when you have multiple components showing the same chat stream.
initialInput:
An optional string for the initial prompt input.
initialMessages:
An optional array of initial chat messages
onToolCall:
Optional callback function that is invoked when a tool call is received. Intended for automatic client-side tool execution. You can optionally return a result for the tool call, either synchronously or asynchronously.
onResponse:
An optional callback that will be called with the response from the API endpoint. Useful for throwing customized errors or logging
onFinish:
An optional callback function that is called when the completion stream ends.
onError:
An optional callback that will be called when the chat stream encounters an error.
generateId:
Optional. A way to provide a function that is going to be used for ids for messages. If not provided generateId is used by default.
headers:
An optional object of headers to be passed to the API endpoint.
body:
An optional, additional body object to be passed to the API endpoint.
credentials:
An optional literal that sets the mode of credentials to be used on the request. Defaults to same-origin.
sendExtraMessageFields:
An optional boolean that determines whether to send extra fields you've added to `messages`. Defaults to `false` and only the `content` and `role` fields will be sent to the API endpoint. If set to `true`, the `name`, `data`, and `annotations` fields will also be sent.
maxToolRoundtrips:
React and SolidJS only. Maximal number of automatic roundtrips for tool calls. An automatic tool call roundtrip is a call to the server with the tool call results when all tool calls in the last assistant message have results. A maximum number is required to prevent infinite loops in the case of misconfigured tools. By default, it is set to 0, which will disable the feature.
streamMode:
An optional literal that sets the mode of the stream to be used. Defaults to `stream-data`. If set to `text`, the stream will be treated as a text stream.
fetch:
Optional. A custom fetch function to be used for the API call. Defaults to the global fetch function.
experimental_prepareRequestBody:
Experimental (React only). When a function is provided, it will be used to prepare the request body for the chat API. This can be useful for customizing the request body based on the messages and data in the chat.
Returns
messages:
The current array of chat messages.
Message
id:
The unique identifier of the message.
role:
The role of the message.
content:
The content of the message.
createdAt?:
The creation date of the message.
name?:
The name of the message.
data?:
Additional data sent along with the message.
annotations?:
Additional annotations sent along with the message.
toolInvocations?:
An array of tool invocations that are associated with the (assistant) message.
ToolInvocation
state:
The state of the tool call when it was partially created.
toolCallId:
ID of the tool call. This ID is used to match the tool call with the tool result.
toolName:
Name of the tool that is being called.
args:
Partial arguments of the tool call. This is a JSON-serializable object.
ToolInvocation
state:
The state of the tool call when it was fully created.
toolCallId:
ID of the tool call. This ID is used to match the tool call with the tool result.
toolName:
Name of the tool that is being called.
args:
Arguments of the tool call. This is a JSON-serializable object that matches the tools input schema.
ToolInvocation
state:
The state of the tool call when the result is available.
toolCallId:
ID of the tool call. This ID is used to match the tool call with the tool result.
toolName:
Name of the tool that is being called.
args:
Arguments of the tool call. This is a JSON-serializable object that matches the tools input schema.
result:
The result of the tool call.
experimental_attachments?:
Additional attachments sent along with the message.
Attachment
name?:
The name of the attachment, usually the file name.
contentType?:
A string indicating the media type of the file.
url:
The URL of the attachment. It can either be a URL to a hosted file or a Data URL.
error:
An error object returned by SWR, if any.
append:
Function to append a message to the chat, triggering an API call for the AI response. It returns a promise that resolves to full response message content when the API call is successfully finished, or throws an error when the API call fails.
ChatRequestOptions
headers:
Additional headers that should be to be passed to the API endpoint.
body:
Additional body JSON properties that should be sent to the API endpoint.
data:
Additional data to be sent to the API endpoint.
reload:
Function to reload the last AI chat response for the given chat history. If the last message isn't from the assistant, it will request the API to generate a new response.
stop:
Function to abort the current API request.
setMessages:
Function to update the `messages` state locally without triggering an API call.
input:
The current value of the input field.
setInput:
Function to update the `input` value.
handleInputChange:
Handler for the `onChange` event of the input field to control the input's value.
handleSubmit:
Form submission handler that automatically resets the input field and appends a user message. You can use the `options` parameter to send additional data, headers and more to the server.
ChatRequestOptions
headers:
Additional headers that should be to be passed to the API endpoint.
body:
Additional body JSON properties that should be sent to the API endpoint.
data:
Additional data to be sent to the API endpoint.
allowEmptySubmit?:
A boolean that determines whether to allow submitting an empty input that triggers a generation. Defaults to `false`.
experimental_attachments?:
An array of attachments to be sent to the API endpoint.
FileList
A list of files that have been selected by the user using an <input type='file'> element. It's also used for a list of files dropped into web content when using the drag and drop API.
Attachment
name?:
The name of the attachment, usually the file name.
contentType?:
A string indicating the media type of the file.
url:
The URL of the attachment. It can either be a URL to a hosted file or a Data URL.
isLoading:
Boolean flag indicating whether a request is currently in progress.
data:
Data returned from StreamData
addToolResult:
React and SolidJS only. Function to add a tool result to the chat. This will update the chat messages with the tool result and call the API route if all tool results for the last message are available.