Interface: UseBaleybotOptions

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

Configuration options for useBaleybot hook

Properties

analysisGoal

analysisGoal: string

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

Analysis goal / system prompt

---

autoProcess?

optional autoProcess?: boolean

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

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:43

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

---

debounceMs?

optional debounceMs?: number

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

Debounce window for auto processing (default 350ms).

---

dependsOn?

optional dependsOn?: unknown[]

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

Additional dependencies to trigger auto processing

---

goal?

optional goal?: string

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

Optional alias for analysisGoal

---

instanceKey?

optional instanceKey?: string

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

Optional key to explicitly recreate the underlying bot when it changes

---

isStreaming?

optional isStreaming?: boolean

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

Is the UI currently streaming? Used with skipWhileStreaming.

---

maxValidationRetries?

optional maxValidationRetries?: number

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

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

---

model?

optional model?: string | ModelConfig

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

Model to use (default: gpt-5.6-luna) - can be string or ModelConfig

---

name

name: string

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

Name of the baleybot

---

onError?

optional onError?: (error) => void

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

Error callback

Parameters

error

Error

Returns

void

---

outputSchema?

optional outputSchema?: unknown

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

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:30

Process items in parallel (default: true)

---

proxyUrl?

optional proxyUrl?: string

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

Proxy URL for API requests (optional)

---

skipWhileStreaming?

optional skipWhileStreaming?: boolean

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

Skip auto processing while UI is streaming assistant output.

---

streamField?

optional streamField?: string

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

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