Skip to main content

Module query_engine

Module query_engine 

Source
Expand description

QueryEngine - translates QueryEngine.ts from TypeScript Owns the query lifecycle and session state for a conversation.

One QueryEngine per conversation. Each submitMessage() call starts a new turn within the same conversation. State (messages, file cache, usage, etc.) persists across turns.

Structs§

AbortController
Abort controller
AgentDefinitions
AlwaysAllowRules
AppState
App state for SDK
AskConfig
Configuration for ask function
ElicitationRequest
Elicitation request
ElicitationResponse
Elicitation response
FileStateCache
File state cache
McpClient
McpState
NonNullableUsage
Token usage (non-nullable)
OrphanedPermission
Orphaned permission
QueryEngine
QueryEngine - owns the query lifecycle and session state
QueryEngineConfig
Query engine configuration (matches TypeScript QueryEngineConfig)
QueryTracking
Query tracking for analytics
SDKPermissionDenial
SDK permission denial
SDKStatus
SDK status
SnipResult
Snip result from compaction
SubmitOptions
Options for submit_message
TaskBudget
Task budget configuration
ThinkingConfig
Thinking configuration
ToolPermissionContext
ToolUseContext
Tool use context
ToolUseContextOptions

Enums§

PermissionDecision
Permission decision
PermissionMode
Permission mode enum
ThinkingType

Functions§

ask
Main ask function - convenience wrapper around QueryEngine Returns a future that resolves to a vector of SDK messages

Type Aliases§

CanUseToolFn
CanUseTool function type
HandleElicitationFn
Handle elicitation function type (boxed)
SDKMessage
Async generator result type - yields SDK messages
SetSdkStatusFn
Set SDK status function type (boxed)
SnipReplayFn
Snip replay function type (boxed)