Skip to main content

Interface: UseBaleybotOptions

Defined in: react/src/hooks/useBaleybot.ts:5

Properties​

analysisGoal​

analysisGoal: string

Defined in: react/src/hooks/useBaleybot.ts:8

Analysis goal / system prompt


autoProcess?​

optional autoProcess?: boolean

Defined in: react/src/hooks/useBaleybot.ts:31

Managed-mode: when true, hook will automatically process when data (or dependsOn) change. Defaults to false (manual mode).


data?​

optional data?: string | string[] | Iterable<string, any, any> | AsyncIterable<string, any, any>

Defined in: react/src/hooks/useBaleybot.ts:35

Managed-mode data: single item, array, iterable, or async iterable of strings.


debounceMs?​

optional debounceMs?: number

Defined in: react/src/hooks/useBaleybot.ts:39

Debounce window for auto processing (default 350ms).


dependsOn?​

optional dependsOn?: unknown[]

Defined in: react/src/hooks/useBaleybot.ts:37

Additional dependencies to trigger auto processing


goal?​

optional goal?: string

Defined in: react/src/hooks/useBaleybot.ts:10

Optional alias for analysisGoal


instanceKey?​

optional instanceKey?: string

Defined in: react/src/hooks/useBaleybot.ts:12

Optional key to explicitly recreate the underlying bot when it changes


isStreaming?​

optional isStreaming?: boolean

Defined in: react/src/hooks/useBaleybot.ts:43

Is the UI currently streaming? Used with skipWhileStreaming.


maxValidationRetries?​

optional maxValidationRetries?: number

Defined in: react/src/hooks/useBaleybot.ts:26

Max retries when structured output fails schema validation (default: 1)


model?​

optional model?: string | ModelConfig

Defined in: react/src/hooks/useBaleybot.ts:19

Model to use (default: core's DEFAULT_MODEL). A proxyUrl goes in its config.


name​

name: string

Defined in: react/src/hooks/useBaleybot.ts:6


onError?​

optional onError?: (error) => void

Defined in: react/src/hooks/useBaleybot.ts:24

Parameters​

error​

Error

Returns​

void


outputSchema?​

optional outputSchema?: unknown

Defined in: react/src/hooks/useBaleybot.ts:17

Schema for output structure Can be a JSON Schema object or a Zod schema for type safety


parallel?​

optional parallel?: boolean

Defined in: react/src/hooks/useBaleybot.ts:23

Process items in parallel (default: true)


skipWhileStreaming?​

optional skipWhileStreaming?: boolean

Defined in: react/src/hooks/useBaleybot.ts:41

Skip auto processing while UI is streaming assistant output.


streamField?​

optional streamField?: string

Defined in: react/src/hooks/useBaleybot.ts:21

Field to stream (e.g., 'response', 'summary')