ToolPreferences
API reference and demos for ToolPreferences.
Import
Section titled “Import”import { ToolPreferences } from "@flanksource/clicky-ui/ai";The props table documents the component-specific surface. Standard DOM attributes inherited from React, such as className, event handlers, and accessibility attributes, may also be accepted when the component’s prop type extends a native element.
| Prop | Type | Default | Description |
|---|---|---|---|
budget |
ChatBudgetConfig |
— | — |
catalogError |
string | null |
— | — |
catalogLoading |
boolean |
— | — |
className |
string |
— | — |
costsApi |
string |
— | Base sessions endpoint for the Costs tab, e.g. `/api/chat/sessions`. |
model |
string |
— | — |
models |
ChatModel[] |
— | — |
onBudgetChange |
(…) => … |
— | — |
onCatalogRetry |
(…) => … |
— | — |
onModelChange |
(…) => … |
— | — |
onPermissionModeChange |
(…) => … |
— | — |
onReasoningEffortChange |
(…) => … |
— | — |
onRule* |
(…) => void |
— | — |
onRulesChange |
(…) => … |
— | — |
onRuntimeChange |
(…) => … |
— | — |
permissionMode |
enum |
— | — |
reasoningEffort |
string |
— | — |
reasoningEfforts |
string[] |
— | — |
rules |
PermissionPolicy |
— | The user's saved rules, edited by the Permissions tab's strategy editor. |
runtime |
ChatModelRuntime |
— | — |
runtimeFamilies |
SpecRuntimeFamily[] |
— | — |
runtimeLocked |
boolean |
— | — |
threadId |
string |
— | Thread whose costs the Costs tab reports. |
tools* |
ToolMeta[] |
— | — |
toolsError |
string | null |
— | — |
toolsLoading |
boolean |
— | — |
value* |
Record<string, ToolPolicy> |
— | — |