UseAssistantReturn
Defined in: react-hooks/src/use-assistant.ts:83
Assistant hook return value.
Properties
Section titled “Properties”append()
Section titled “append()”append: (
message) =>Promise<void>
Defined in: react-hooks/src/use-assistant.ts:95
Submit message programmatically
Parameters
Section titled “Parameters”message
Section titled “message”string | Message
Returns
Section titled “Returns”Promise<void>
error:
Error|undefined
Defined in: react-hooks/src/use-assistant.ts:105
Error if any
handleInputChange()
Section titled “handleInputChange()”handleInputChange: (
e) =>void
Defined in: react-hooks/src/use-assistant.ts:91
Handle input change
Parameters
Section titled “Parameters”ChangeEvent<HTMLInputElement | HTMLTextAreaElement>
Returns
Section titled “Returns”void
handleSubmit()
Section titled “handleSubmit()”handleSubmit: (
e?) =>void
Defined in: react-hooks/src/use-assistant.ts:93
Handle form submit
Parameters
Section titled “Parameters”FormEvent<HTMLFormElement>
Returns
Section titled “Returns”void
input:
string
Defined in: react-hooks/src/use-assistant.ts:87
Current input value
messages
Section titled “messages”messages:
AssistantMessage[]
Defined in: react-hooks/src/use-assistant.ts:85
Chat messages
setInput()
Section titled “setInput()”setInput: (
input) =>void
Defined in: react-hooks/src/use-assistant.ts:89
Set input value
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
setMessages()
Section titled “setMessages()”setMessages: (
messages) =>void
Defined in: react-hooks/src/use-assistant.ts:103
Set messages
Parameters
Section titled “Parameters”messages
Section titled “messages”Returns
Section titled “Returns”void
status
Section titled “status”status:
AssistantStatus
Defined in: react-hooks/src/use-assistant.ts:99
Current status
stop()
Section titled “stop()”stop: () =>
void
Defined in: react-hooks/src/use-assistant.ts:101
Stop the current run
Returns
Section titled “Returns”void
threadId
Section titled “threadId”threadId:
string|undefined
Defined in: react-hooks/src/use-assistant.ts:97
Thread ID