Skip to content

Commit ec4bfa0

Browse files
committed
docs: document sendExtraMessageFields
1 parent 44265c3 commit ec4bfa0

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

docs/pages/docs/api-reference/use-chat.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,11 @@ Options passed to `useChat`:
105105
'credentials',
106106
'"omit" | "same-origin" | "include"',
107107
'An optional literal that sets the mode of credentials to be used on the request. Defaults to "same-origin".'
108+
],
109+
[
110+
'sendExtraMessageFields',
111+
'boolean',
112+
'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.'
108113
]
109114
]}
110115
/>

docs/pages/docs/api-reference/use-completion.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,11 @@ export default function Completion() {
147147
'credentials',
148148
'"omit" | "same-origin" | "include"',
149149
'An optional literal that sets the mode of credentials to be used on the request. Defaults to "same-origin".'
150+
],
151+
[
152+
'sendExtraMessageFields',
153+
'boolean',
154+
"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."
150155
]
151156
]}
152157
/>

0 commit comments

Comments
 (0)