Interface: GenieChatOptions
Options accepted by both genieChat and genieEventChat.
Properties
Section titled “Properties”agentMode?
Section titled “agentMode?”
optionalagentMode?:boolean
Use the streaming Genie Agent Mode API. Defaults to true; set false to
force the legacy start/create/get-message polling flow.
context?
Section titled “context?”
optionalcontext?:ContextLike
External cancellation. Accepts a WHATWG AbortSignal or a fully-built SDK
Context (see databricks.ContextLike). Aborting it cancels every in-flight
Agent Mode stream, SDK call, and the next inter-poll sleep.
conversationId?
Section titled “conversationId?”
optionalconversationId?:string
Continue an existing conversation. Agent Mode sends it as
conversation_id; legacy polling passes it to createMessage. Read the id
from the prior turn’s terminal GenieMessage or result event.
enableVisualization?
Section titled “enableVisualization?”
optionalenableVisualization?:boolean
Ask Agent Mode to generate visualizations when appropriate.
pollIntervalMs?
Section titled “pollIntervalMs?”
optionalpollIntervalMs?:number
Legacy fallback cadence between successive getMessage calls (default 500ms).
workspaceClient?
Section titled “workspaceClient?”
optionalworkspaceClient?:WorkspaceClient$1
Explicit WorkspaceClient. Defaults to AppKit’s per-request
execution-context client when AppKit is installed and we’re inside a
request; falls back to createWorkspaceClient() (default auth)
otherwise.