@ai-sdk/react
Version:
[React](https://react.dev/) UI components for the [AI SDK](https://sdk.vercel.ai/docs):
1,049 lines (635 loc) • 18.5 kB
Markdown
# @ai-sdk/react
## 1.2.9
### Patch Changes
- @ai-sdk/provider-utils@2.2.7
- @ai-sdk/ui-utils@1.2.8
## 1.2.8
### Patch Changes
- @ai-sdk/provider-utils@2.2.6
- @ai-sdk/ui-utils@1.2.7
## 1.2.7
### Patch Changes
- Updated dependencies [c21fa6d]
- @ai-sdk/provider-utils@2.2.5
- @ai-sdk/ui-utils@1.2.6
## 1.2.6
### Patch Changes
- Updated dependencies [2c19b9a]
- @ai-sdk/provider-utils@2.2.4
- @ai-sdk/ui-utils@1.2.5
## 1.2.5
### Patch Changes
- a043b14: fix (ui): prevent early addToolResult submission
- Updated dependencies [28be004]
- @ai-sdk/provider-utils@2.2.3
- @ai-sdk/ui-utils@1.2.4
## 1.2.4
### Patch Changes
- Updated dependencies [b01120e]
- @ai-sdk/provider-utils@2.2.2
- @ai-sdk/ui-utils@1.2.3
## 1.2.3
### Patch Changes
- Updated dependencies [65243ce]
- @ai-sdk/ui-utils@1.2.2
## 1.2.2
### Patch Changes
- d92fa29: feat: add credentials support to experimental useObject and StructuredObject
## 1.2.1
### Patch Changes
- Updated dependencies [f10f0fa]
- @ai-sdk/provider-utils@2.2.1
- @ai-sdk/ui-utils@1.2.1
## 1.2.0
### Minor Changes
- 5bc638d: AI SDK 4.2
### Patch Changes
- Updated dependencies [5bc638d]
- @ai-sdk/provider-utils@2.2.0
- @ai-sdk/ui-utils@1.2.0
## 1.1.25
### Patch Changes
- Updated dependencies [d0c4659]
- @ai-sdk/provider-utils@2.1.15
- @ai-sdk/ui-utils@1.1.21
## 1.1.24
### Patch Changes
- @ai-sdk/provider-utils@2.1.14
- @ai-sdk/ui-utils@1.1.20
## 1.1.23
### Patch Changes
- @ai-sdk/provider-utils@2.1.13
- @ai-sdk/ui-utils@1.1.19
## 1.1.22
### Patch Changes
- Updated dependencies [1531959]
- @ai-sdk/provider-utils@2.1.12
- @ai-sdk/ui-utils@1.1.18
## 1.1.21
### Patch Changes
- @ai-sdk/provider-utils@2.1.11
- @ai-sdk/ui-utils@1.1.17
## 1.1.20
### Patch Changes
- 6255fbc: fix (ai/react): update messages when initialMessages changes
## 1.1.19
### Patch Changes
- da5c734: fix (react): infinite re-render caused by fillMessageParts
## 1.1.18
### Patch Changes
- Updated dependencies [ddf9740]
- @ai-sdk/ui-utils@1.1.16
- @ai-sdk/provider-utils@2.1.10
## 1.1.17
### Patch Changes
- @ai-sdk/provider-utils@2.1.9
- @ai-sdk/ui-utils@1.1.15
## 1.1.16
### Patch Changes
- 60c3220: fix (ui): set status to ready after stream was aborted
## 1.1.15
### Patch Changes
- c43df41: feat (ui): add useChat status
## 1.1.14
### Patch Changes
- Updated dependencies [2e898b4]
- @ai-sdk/provider-utils@2.1.8
- @ai-sdk/ui-utils@1.1.14
## 1.1.13
### Patch Changes
- Updated dependencies [3ff4ef8]
- @ai-sdk/provider-utils@2.1.7
- @ai-sdk/ui-utils@1.1.13
## 1.1.12
### Patch Changes
- Updated dependencies [166e09e]
- @ai-sdk/ui-utils@1.1.12
## 1.1.11
### Patch Changes
- Updated dependencies [318b351]
- @ai-sdk/ui-utils@1.1.11
## 1.1.10
### Patch Changes
- bcc61d4: feat (ui): introduce message parts for useChat
- Updated dependencies [bcc61d4]
- @ai-sdk/ui-utils@1.1.10
## 1.1.9
### Patch Changes
- Updated dependencies [6b8cc14]
- @ai-sdk/ui-utils@1.1.9
## 1.1.8
### Patch Changes
- @ai-sdk/provider-utils@2.1.6
- @ai-sdk/ui-utils@1.1.8
## 1.1.7
### Patch Changes
- 0d2d9bf: fix (ui): empty submits (with allowEmptySubmit) create user messages
- 0d2d9bf: fix (ui): single assistant message with multiple tool steps
- Updated dependencies [0d2d9bf]
- @ai-sdk/ui-utils@1.1.7
## 1.1.6
### Patch Changes
- Updated dependencies [3a602ca]
- @ai-sdk/provider-utils@2.1.5
- @ai-sdk/ui-utils@1.1.6
## 1.1.5
### Patch Changes
- Updated dependencies [066206e]
- @ai-sdk/provider-utils@2.1.4
- @ai-sdk/ui-utils@1.1.5
## 1.1.4
### Patch Changes
- Updated dependencies [39e5c1f]
- @ai-sdk/provider-utils@2.1.3
- @ai-sdk/ui-utils@1.1.4
## 1.1.3
### Patch Changes
- Updated dependencies [9ce598c]
- @ai-sdk/ui-utils@1.1.3
## 1.1.2
### Patch Changes
- 6f4d063: fix (ai/react): cache addToolResult in useChat
- Updated dependencies [ed012d2]
- @ai-sdk/provider-utils@2.1.2
- @ai-sdk/ui-utils@1.1.2
## 1.1.1
### Patch Changes
- Updated dependencies [e7a9ec9]
- Updated dependencies [0a699f1]
- @ai-sdk/ui-utils@1.1.1
- @ai-sdk/provider-utils@2.1.1
## 1.1.0
### Minor Changes
- 62ba5ad: release: AI SDK 4.1
### Patch Changes
- Updated dependencies [62ba5ad]
- @ai-sdk/provider-utils@2.1.0
- @ai-sdk/ui-utils@1.1.0
## 1.0.14
### Patch Changes
- 44f04d5: feat (ai/react): expose chat id in experimental_prepareRequestBody
## 1.0.13
### Patch Changes
- Updated dependencies [33592d2]
- @ai-sdk/ui-utils@1.0.12
## 1.0.12
### Patch Changes
- Updated dependencies [00114c5]
- Updated dependencies [00114c5]
- @ai-sdk/provider-utils@2.0.8
- @ai-sdk/ui-utils@1.0.11
## 1.0.11
### Patch Changes
- 37f4510: feat (ui): expose useChat id and send it to the server
- Updated dependencies [37f4510]
- @ai-sdk/ui-utils@1.0.10
## 1.0.10
### Patch Changes
- Updated dependencies [2495973]
- Updated dependencies [2495973]
- @ai-sdk/ui-utils@1.0.9
## 1.0.9
### Patch Changes
- Updated dependencies [90fb95a]
- Updated dependencies [e6dfef4]
- Updated dependencies [6636db6]
- @ai-sdk/provider-utils@2.0.7
- @ai-sdk/ui-utils@1.0.8
## 1.0.8
### Patch Changes
- Updated dependencies [19a2ce7]
- Updated dependencies [6337688]
- @ai-sdk/provider-utils@2.0.6
- @ai-sdk/ui-utils@1.0.7
## 1.0.7
### Patch Changes
- Updated dependencies [5ed5e45]
- @ai-sdk/provider-utils@2.0.5
- @ai-sdk/ui-utils@1.0.6
## 1.0.6
### Patch Changes
- @ai-sdk/provider-utils@2.0.4
- @ai-sdk/ui-utils@1.0.5
## 1.0.5
### Patch Changes
- Updated dependencies [0984f0b]
- @ai-sdk/provider-utils@2.0.3
- @ai-sdk/ui-utils@1.0.4
## 1.0.4
### Patch Changes
- 953469c: chore (ui): extract prepareAttachmentsForRequest
- Updated dependencies [953469c]
- Updated dependencies [a3dd2ed]
- @ai-sdk/ui-utils@1.0.3
## 1.0.3
### Patch Changes
- 630ac31: fix (ui): set tool invocation state to "result" when calling addToolResult
## 1.0.2
### Patch Changes
- Updated dependencies [88b364b]
- @ai-sdk/ui-utils@1.0.2
- @ai-sdk/provider-utils@2.0.2
## 1.0.1
### Patch Changes
- Updated dependencies [c3ab5de]
- @ai-sdk/provider-utils@2.0.1
- @ai-sdk/ui-utils@1.0.1
## 1.0.0
### Major Changes
- e117b54: chore (ui): remove deprecated useChat roundtrip options
- 8bf5756: chore: remove legacy function/tool calling
- d3ae4f6: chore (ui/react): remove useObject setInput helper
- 68d30e9: chore (ui/react): remove experimental_addToolResult
- 7814c4b: chore (ui): remove streamMode setting from useChat & useCompletion
- ca3e586: chore (ui): remove experimental_useAssistant export
- fe4f109: chore (ui): set default value of useChat keepLastMessageOnError to true
- 84edae5: chore (release): bump ui package versions for 4.0 release
### Patch Changes
- 79c6dd9: fix (ui): remove unnecessary calls to mutateStreamData in useChat
- 04d3747: chore (ui-utils): restructure processAssistantMessage
- Updated dependencies [8bf5756]
- Updated dependencies [b469a7e]
- Updated dependencies [9f81e66]
- Updated dependencies [70f28f6]
- Updated dependencies [dce4158]
- Updated dependencies [7814c4b]
- Updated dependencies [fe4f109]
- Updated dependencies [b1da952]
- Updated dependencies [04d3747]
- Updated dependencies [dce4158]
- Updated dependencies [7e89ccb]
- Updated dependencies [8426f55]
- Updated dependencies [db46ce5]
- Updated dependencies [b053413]
- @ai-sdk/ui-utils@1.0.0
- @ai-sdk/provider-utils@2.0.0
## 1.0.0-canary.9
### Patch Changes
- 79c6dd9: fix (ui): remove unnecessary calls to mutateStreamData in useChat
- 04d3747: chore (ui-utils): restructure processAssistantMessage
- Updated dependencies [04d3747]
- @ai-sdk/ui-utils@1.0.0-canary.9
## 1.0.0-canary.8
### Patch Changes
- Updated dependencies [b053413]
- @ai-sdk/ui-utils@1.0.0-canary.8
## 1.0.0-canary.7
### Major Changes
- fe4f109: chore (ui): set default value of useChat keepLastMessageOnError to true
### Patch Changes
- Updated dependencies [fe4f109]
- @ai-sdk/ui-utils@1.0.0-canary.7
## 1.0.0-canary.6
### Patch Changes
- Updated dependencies [70f28f6]
- @ai-sdk/ui-utils@1.0.0-canary.6
## 1.0.0-canary.5
### Major Changes
- d3ae4f6: chore (ui/react): remove useObject setInput helper
### Patch Changes
- Updated dependencies [9f81e66]
- Updated dependencies [8426f55]
- @ai-sdk/ui-utils@1.0.0-canary.5
- @ai-sdk/provider-utils@2.0.0-canary.3
## 1.0.0-canary.4
### Major Changes
- ca3e586: chore (ui): remove experimental_useAssistant export
### Patch Changes
- Updated dependencies [dce4158]
- Updated dependencies [dce4158]
- @ai-sdk/provider-utils@2.0.0-canary.2
- @ai-sdk/ui-utils@1.0.0-canary.4
## 1.0.0-canary.3
### Major Changes
- 68d30e9: chore (ui/react): remove experimental_addToolResult
### Patch Changes
- Updated dependencies [b1da952]
- @ai-sdk/provider-utils@2.0.0-canary.1
- @ai-sdk/ui-utils@1.0.0-canary.3
## 1.0.0-canary.2
### Major Changes
- e117b54: chore (ui): remove deprecated useChat roundtrip options
- 7814c4b: chore (ui): remove streamMode setting from useChat & useCompletion
### Patch Changes
- Updated dependencies [b469a7e]
- Updated dependencies [7814c4b]
- Updated dependencies [db46ce5]
- @ai-sdk/provider-utils@2.0.0-canary.0
- @ai-sdk/ui-utils@1.0.0-canary.2
## 1.0.0-canary.1
### Major Changes
- 8bf5756: chore: remove legacy function/tool calling
### Patch Changes
- Updated dependencies [8bf5756]
- @ai-sdk/ui-utils@1.0.0-canary.1
## 1.0.0-canary.0
### Major Changes
- 84edae5: chore (release): bump ui package versions for 4.0 release
### Patch Changes
- Updated dependencies [7e89ccb]
- @ai-sdk/ui-utils@1.0.0-canary.0
## 0.0.70
### Patch Changes
- 2dfb93e: feat (ui/react): introduce experimental_throttle in useChat, useCompletion
## 0.0.69
### Patch Changes
- Updated dependencies [a85c965]
- @ai-sdk/ui-utils@0.0.50
## 0.0.68
### Patch Changes
- 8301e41: fix (ai/react): update React peer dependency version to allow rc releases.
## 0.0.67
### Patch Changes
- Updated dependencies [3bf8da0]
- @ai-sdk/ui-utils@0.0.49
## 0.0.66
### Patch Changes
- aa98cdb: chore: more flexible dependency versioning
- Updated dependencies [aa98cdb]
- Updated dependencies [7b937c5]
- Updated dependencies [811a317]
- @ai-sdk/provider-utils@1.0.22
- @ai-sdk/ui-utils@0.0.48
## 0.0.65
### Patch Changes
- @ai-sdk/provider-utils@1.0.21
- @ai-sdk/ui-utils@0.0.47
## 0.0.64
### Patch Changes
- 98a3b08: fix (ui/react): fix callback dependency
## 0.0.63
### Patch Changes
- caedcda: feat (ai/ui): add setData helper to useChat
## 0.0.62
### Patch Changes
- @ai-sdk/provider-utils@1.0.20
- @ai-sdk/ui-utils@0.0.46
## 0.0.61
### Patch Changes
- Updated dependencies [cd77c5d]
- @ai-sdk/ui-utils@0.0.45
## 0.0.60
### Patch Changes
- 7e7104f: feat (ai/react): add headers option to useObject
## 0.0.59
### Patch Changes
- Updated dependencies [273f696]
- @ai-sdk/provider-utils@1.0.19
- @ai-sdk/ui-utils@0.0.44
## 0.0.58
### Patch Changes
- 54862e4: fix (react): restore sending annotations with during submission
- Updated dependencies [1f590ef]
- @ai-sdk/ui-utils@0.0.43
## 0.0.57
### Patch Changes
- Updated dependencies [14210d5]
- @ai-sdk/ui-utils@0.0.42
## 0.0.56
### Patch Changes
- a0403d6: feat (react): support sending attachments using append
## 0.0.55
### Patch Changes
- Updated dependencies [03313cd]
- @ai-sdk/provider-utils@1.0.18
- @ai-sdk/ui-utils@0.0.41
## 0.0.54
### Patch Changes
- 4ab883f: fix (ai/react): useObject error handling
## 0.0.53
### Patch Changes
- Updated dependencies [aa2dc58]
- @ai-sdk/ui-utils@0.0.40
## 0.0.52
### Patch Changes
- @ai-sdk/provider-utils@1.0.17
- @ai-sdk/ui-utils@0.0.39
## 0.0.51
### Patch Changes
- Updated dependencies [d151349]
- @ai-sdk/ui-utils@0.0.38
## 0.0.50
### Patch Changes
- Updated dependencies [09f895f]
- @ai-sdk/provider-utils@1.0.16
- @ai-sdk/ui-utils@0.0.37
## 0.0.49
### Patch Changes
- Updated dependencies [b5a82b7]
- @ai-sdk/ui-utils@0.0.36
## 0.0.48
### Patch Changes
- Updated dependencies [d67fa9c]
- @ai-sdk/provider-utils@1.0.15
- @ai-sdk/ui-utils@0.0.35
## 0.0.47
### Patch Changes
- @ai-sdk/provider-utils@1.0.14
- @ai-sdk/ui-utils@0.0.34
## 0.0.46
### Patch Changes
- b6c1dee: fix (ui/react): allow sending empty messages with attachments
## 0.0.45
### Patch Changes
- @ai-sdk/provider-utils@1.0.13
- @ai-sdk/ui-utils@0.0.33
## 0.0.44
### Patch Changes
- Updated dependencies [dd712ac]
- @ai-sdk/provider-utils@1.0.12
- @ai-sdk/ui-utils@0.0.32
## 0.0.43
### Patch Changes
- @ai-sdk/provider-utils@1.0.11
- @ai-sdk/ui-utils@0.0.31
## 0.0.42
### Patch Changes
- e9c891d: feat (ai/react): useObject supports non-Zod schemas
- Updated dependencies [e9c891d]
- Updated dependencies [4bd27a9]
- Updated dependencies [845754b]
- @ai-sdk/ui-utils@0.0.30
- @ai-sdk/provider-utils@1.0.10
## 0.0.41
### Patch Changes
- e5b58f3: fix (ai/ui): forward streaming errors in useChat
- Updated dependencies [e5b58f3]
- @ai-sdk/ui-utils@0.0.29
## 0.0.40
### Patch Changes
- @ai-sdk/provider-utils@1.0.9
- @ai-sdk/ui-utils@0.0.28
## 0.0.39
### Patch Changes
- @ai-sdk/provider-utils@1.0.8
- @ai-sdk/ui-utils@0.0.27
## 0.0.38
### Patch Changes
- @ai-sdk/provider-utils@1.0.7
- @ai-sdk/ui-utils@0.0.26
## 0.0.37
### Patch Changes
- Updated dependencies [9614584]
- Updated dependencies [0762a22]
- @ai-sdk/provider-utils@1.0.6
- @ai-sdk/ui-utils@0.0.25
## 0.0.36
### Patch Changes
- 5be25124: fix (ai/ui): useChat messages have stable ids with streamProtocol: "text"
- Updated dependencies [5be25124]
- @ai-sdk/ui-utils@0.0.24
## 0.0.35
### Patch Changes
- a147d040: feat (ai/react): useObject clears object when loading new result
## 0.0.34
### Patch Changes
- b68fae4f: feat (ai/ui): add onFinish callback to useObject
## 0.0.33
### Patch Changes
- Updated dependencies [fea7b604]
- @ai-sdk/ui-utils@0.0.23
## 0.0.32
### Patch Changes
- Updated dependencies [1d93d716]
- @ai-sdk/ui-utils@0.0.22
## 0.0.31
### Patch Changes
- c450fcf7: feat (ui): invoke useChat onFinish with finishReason and tokens
- e4a1719f: chore (ai/ui): rename streamMode to streamProtocol
- Updated dependencies [c450fcf7]
- Updated dependencies [e4a1719f]
- @ai-sdk/ui-utils@0.0.21
## 0.0.30
### Patch Changes
- b2bee4c5: fix (ai/ui): send data, body, headers in useChat().reload
## 0.0.29
### Patch Changes
- Updated dependencies [a8d1c9e9]
- @ai-sdk/provider-utils@1.0.5
- @ai-sdk/ui-utils@0.0.20
## 0.0.28
### Patch Changes
- Updated dependencies [4f88248f]
- @ai-sdk/provider-utils@1.0.4
- @ai-sdk/ui-utils@0.0.19
## 0.0.27
### Patch Changes
- @ai-sdk/provider-utils@1.0.3
- @ai-sdk/ui-utils@0.0.18
## 0.0.26
### Patch Changes
- f63829fe: feat (ai/ui): add allowEmptySubmit flag to handleSubmit
- 4b2c09d9: feat (ai/ui): add mutator function support to useChat / setMessages
- Updated dependencies [f63829fe]
- @ai-sdk/ui-utils@0.0.17
## 0.0.25
### Patch Changes
- 5b7b3bbe: fix (ai/ui): tool call streaming
- Updated dependencies [5b7b3bbe]
- @ai-sdk/ui-utils@0.0.16
## 0.0.24
### Patch Changes
- 19c3d50f: fix (ai/ui): add missing createdAt
## 0.0.23
### Patch Changes
- Updated dependencies [1f67fe49]
- @ai-sdk/ui-utils@0.0.15
## 0.0.22
### Patch Changes
- 99ddbb74: feat (ai/react): add experimental support for managing attachments to useChat
- Updated dependencies [99ddbb74]
- @ai-sdk/ui-utils@0.0.14
## 0.0.21
### Patch Changes
- a6cb2c8b: feat (ai/ui): add keepLastMessageOnError option to useChat
- Updated dependencies [a6cb2c8b]
- @ai-sdk/ui-utils@0.0.13
## 0.0.20
### Patch Changes
- 56bbc2a7: feat (ai/ui): set body and headers directly on options for handleSubmit and append
- Updated dependencies [56bbc2a7]
- @ai-sdk/ui-utils@0.0.12
## 0.0.19
### Patch Changes
- @ai-sdk/provider-utils@1.0.2
- @ai-sdk/ui-utils@0.0.11
## 0.0.18
### Patch Changes
- 70d18003: add setThreadId helper to switch between threads for useAssistant
## 0.0.17
### Patch Changes
- 6a11cfaa: feat (ai/ui): add onError handler to useObject
- 3db90c3d: allow empty handleSubmit submissions for useChat
- Updated dependencies [d481729f]
- @ai-sdk/provider-utils@1.0.1
- @ai-sdk/ui-utils@0.0.10
## 0.0.16
### Patch Changes
- 3f756a6b: fix (ai/react): include fetch parameter as part of useChat
## 0.0.15
### Patch Changes
- 6c99581e: fix (ai/react): stop() on useObject does not throw error and clears isLoading
## 0.0.14
### Patch Changes
- 9b50003d: fix (ai/react): useObject stop & isLoading reset at end of stream
- 1894f811: feat (ai/ui): allow JSONValue as data in useChat handleSubmit
- Updated dependencies [1894f811]
- @ai-sdk/ui-utils@0.0.9
## 0.0.13
### Patch Changes
- d3100b9c: feat (ai/ui): support custom fetch function in useChat, useCompletion, useAssistant, useObject
- Updated dependencies [d3100b9c]
- @ai-sdk/ui-utils@0.0.8
## 0.0.12
### Patch Changes
- Updated dependencies [5edc6110]
- Updated dependencies [5edc6110]
- @ai-sdk/provider-utils@1.0.0
- @ai-sdk/ui-utils@0.0.7
## 0.0.11
### Patch Changes
- 827ef450: feat (ai/ui): improve error handling in useAssistant
## 0.0.10
### Patch Changes
- 5b04204b: chore (ai/react): rename useChat setInput to submit
- 8f482903: feat (ai/react): add stop() helper to useObject
## 0.0.9
### Patch Changes
- 321a7d0e: feat (ai/react): add isLoading to useObject
## 0.0.8
### Patch Changes
- 54bf4083: feat (ai/react): control request body in useChat
- Updated dependencies [54bf4083]
- @ai-sdk/ui-utils@0.0.6
## 0.0.7
### Patch Changes
- d42b8907: feat (ui): make event in handleSubmit optional
## 0.0.6
### Patch Changes
- 3cb103bc: fix (ai/react): prevent infinite tool call loop
## 0.0.5
### Patch Changes
- Updated dependencies [02f6a088]
- @ai-sdk/provider-utils@0.0.16
- @ai-sdk/ui-utils@0.0.5
## 0.0.4
### Patch Changes
- 008725ec: feat (@ai-sdk/react): add experimental_useObject to @ai-sdk/react
- Updated dependencies [008725ec]
- @ai-sdk/ui-utils@0.0.4
## 0.0.3
### Patch Changes
- Updated dependencies [85712895]
- Updated dependencies [85712895]
- @ai-sdk/provider-utils@0.0.15
- @ai-sdk/ui-utils@0.0.3
## 0.0.2
### Patch Changes
- Updated dependencies [7910ae84]
- @ai-sdk/provider-utils@0.0.14
- @ai-sdk/ui-utils@0.0.2
## 0.0.1
### Patch Changes
- 85f209a4: chore: extracted ui library support into separate modules
- Updated dependencies [85f209a4]
- @ai-sdk/ui-utils@0.0.1