@sqlrooms/documents / StartBlockScopedChatOptions

Type Alias: StartBlockScopedChatOptions

StartBlockScopedChatOptions = object

Properties

target

target: BlockAiTarget

---

prompt

prompt: string

---

revealAssistant

revealAssistant: () => void

Returns

void

---

actions

actions: StartBlockScopedChatActions

---

isValidBlockDocumentArtifact

isValidBlockDocumentArtifact: (artifact) => boolean

Returns true when the artifact can host block-scoped Ask AI. Callers supply product-specific checks (for example block-document artifacts).

Parameters

Parameter	Type
artifact	StartBlockScopedChatArtifact

Returns

boolean

---

contextItemId?

optional contextItemId?: string

Precomputed context item id. When omitted, derived via blockContextItemId.

---

artifactLabel?

optional artifactLabel?: string

Optional product noun used in toast copy. Defaults to "block document".