Skip to content
KortexyaKortexyaReasoning Layer SDK

Interface: UIActionResponse

@kortexya/reasoninglayer

@kortexya/reasoninglayer / UIActionResponse

Interface: UIActionResponse

Section titled “Interface: UIActionResponse”

Defined in: src/types/ui.ts:432

Response from executing a UI action.

Properties

Section titled “Properties”

affectedPreview?

Section titled “affectedPreview?”

optional affectedPreview?: AffectedPreviewDto | null

Defined in: src/types/ui.ts:438

What the program would do. Present on every successful dry run — a read or an additive write included. A dry run whose preview cannot be built at all (a deadline, a compile error) answers success: false with error.

bindings?

Section titled “bindings?”

optional bindings?: unknown[] | null

Defined in: src/types/ui.ts:443

Read-back rows for run_osfql reads (goals, global gets, hierarchy, aggregates). A binding that holds a list (e.g. HIERARCHY ANCESTORS OF x INTO ?A) is a JSON array.

diagnostics?

Section titled “diagnostics?”

optional diagnostics?: string[]

Defined in: src/types/ui.ts:444

dryRun?

Section titled “dryRun?”

optional dryRun?: boolean

Defined in: src/types/ui.ts:446

Echo: true means this was a dry-run preview and nothing was mutated.

error?

Section titled “error?”

optional error?: string | null

Defined in: src/types/ui.ts:452

Why the action failed, when UIActionResponse.success is false. A failure of a program that had started ends with (the program was rolled back: …): nothing the program wrote is kept.

pendingReviewId?

Section titled “pendingReviewId?”

optional pendingReviewId?: string | null

Defined in: src/types/ui.ts:454

Pending review id to surface/approve when UIActionResponse.requiresApproval is true.

producedTermIds?

Section titled “producedTermIds?”

optional producedTermIds?: string[]

Defined in: src/types/ui.ts:455

requiresApproval?

Section titled “requiresApproval?”

optional requiresApproval?: boolean

Defined in: src/types/ui.ts:460

true means the action was enqueued for human approval and nothing was mutated. Pairs with UIActionResponse.pendingReviewId.

requiresConfirmation?

Section titled “requiresConfirmation?”

optional requiresConfirmation?: boolean

Defined in: src/types/ui.ts:465

true means a destructive tier was refused for lack of confirm: true (no mutation happened) — the caller should surface a confirmation flow.

retractedTermIds?

Section titled “retractedTermIds?”

optional retractedTermIds?: string[]

Defined in: src/types/ui.ts:471

Term ids the action removed: every term a RETRACT matched, plus the derived facts the removal invalidated. Absent when the action removed nothing.

riskTier?

Section titled “riskTier?”

optional riskTier?: RiskTier | null

Defined in: src/types/ui.ts:473

Server-classified risk tier of the final statement.

success

Section titled “success”

success: boolean

Defined in: src/types/ui.ts:480

Whether the action succeeded. Every action is atomic: on false nothing is kept, and the reason is in error. A delete_record that removes nothing answers false, and so does a "sort_ref" value that names no term, or a term the caller cannot see (… names no term …).