UseChatReturn
Defined in: types.ts:191
Chat hook return value.
Properties
Section titled “Properties”append()
Section titled “append()”append: (
message,options?) =>Promise<string|null|undefined>
Defined in: types.ts:203
Submit message programmatically
Parameters
Section titled “Parameters”message
Section titled “message”string | Message
options?
Section titled “options?”Returns
Section titled “Returns”Promise<string | null | undefined>
optionaldata:unknown[]
Defined in: types.ts:218
Data from API
error:
Error|undefined
Defined in: types.ts:216
Error if any
handleInputChange()
Section titled “handleInputChange()”handleInputChange: (
e) =>void
Defined in: types.ts:199
Handle input change
Parameters
Section titled “Parameters”ChangeEvent<HTMLInputElement | HTMLTextAreaElement>
Returns
Section titled “Returns”void
handleSubmit()
Section titled “handleSubmit()”handleSubmit: (
e?,options?) =>void
Defined in: types.ts:201
Handle form submit
Parameters
Section titled “Parameters”FormEvent<HTMLFormElement>
options?
Section titled “options?”Returns
Section titled “Returns”void
input:
string
Defined in: types.ts:195
Current input value
isLoading
Section titled “isLoading”isLoading:
boolean
Defined in: types.ts:214
Whether currently loading
messages
Section titled “messages”messages:
Message[]
Defined in: types.ts:193
Chat messages
reload()
Section titled “reload()”reload: (
options?) =>Promise<string|null|undefined>
Defined in: types.ts:208
Reload last message
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<string | null | undefined>
setInput()
Section titled “setInput()”setInput: (
input) =>void
Defined in: types.ts:197
Set input value
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
setMessages()
Section titled “setMessages()”setMessages: (
messages) =>void
Defined in: types.ts:212
Set messages
Parameters
Section titled “Parameters”messages
Section titled “messages”Message[] | (messages) => Message[]
Returns
Section titled “Returns”void
stop()
Section titled “stop()”stop: () =>
void
Defined in: types.ts:210
Stop streaming
Returns
Section titled “Returns”void