ai
Version:
AI SDK by Vercel - The AI Toolkit for TypeScript and JavaScript
27 lines (17 loc) • 944 B
text/mdx
title: useAIState
description: Reference for the useAIState function from the AI SDK RSC
# `useAIState`
<Note type="warning">
AI SDK RSC is currently experimental. We recommend using [AI SDK
UI](/docs/ai-sdk-ui/overview) for production. For guidance on migrating from
RSC to UI, see our [migration guide](/docs/ai-sdk-rsc/migrating-to-ui).
</Note>
It is a hook that enables you to read and update the AI state. The AI state is shared globally between all `useAIState` hooks under the same `<AI/>` provider.
The AI state is intended to contain context and information shared with the AI model, such as system messages, function responses, and other relevant data.
## Import
<Snippet text={`import { useAIState } from "@ai-sdk/rsc"`} prompt={false} />
## API Signature
### Returns
Similar to useState, it is an array where the first element is the current AI state and the second element is a function to update the state.