Interface: UseBaleybotReturn<TOutput>
Defined in: react/src/hooks/useBaleybot.ts:57
Type Parameters
TOutput
TOutput
Properties
bot
bot:
Baleybot<unknown,Tools> |null
Defined in: react/src/hooks/useBaleybot.ts:75
The underlying baleybot instance (stable across prop changes unless reconfigured)
cancel
cancel: () =>
void
Defined in: react/src/hooks/useBaleybot.ts:73
Cancel ongoing batch processing
Returns
void
error
error:
Error|null
Defined in: react/src/hooks/useBaleybot.ts:70
isProcessing
isProcessing:
boolean
Defined in: react/src/hooks/useBaleybot.ts:69
Whether any processing is in progress
process
process:
ProcessFunction<TOutput>
Defined in: react/src/hooks/useBaleybot.ts:59
Process data - accepts single items, arrays, iterables, or async iterables
reconfigure
reconfigure: (
next?) =>void
Defined in: react/src/hooks/useBaleybot.ts:77
Recreate the underlying bot with new options (merging with current options)
Parameters
next?
Partial<UseBaleybotOptions>
Returns
void
reset
reset: () =>
void
Defined in: react/src/hooks/useBaleybot.ts:71
Returns
void
result
result:
TOutput|null
Defined in: react/src/hooks/useBaleybot.ts:63
Last result produced (useful in managed mode); null if none yet
results
results:
TOutput[]
Defined in: react/src/hooks/useBaleybot.ts:61
All results from batch processing (empty array for single item processing)
streamingResult
streamingResult:
Partial<TOutput> |null
Defined in: react/src/hooks/useBaleybot.ts:67
Partially parsed structured output from the stream (available when outputSchema is set)
streamingText
streamingText:
string
Defined in: react/src/hooks/useBaleybot.ts:65
Streaming text for the current item being processed