Skip to main content

EphemeralDocumentProps

Agent Runtimes

Agent Runtimes / chat/document/EphemeralDocument / EphemeralDocumentProps

Interface: EphemeralDocumentProps

Defined in: src/chat/document/EphemeralDocument.tsx:103

Properties​

content?​

optional content?: string

Defined in: src/chat/document/EphemeralDocument.tsx:112

Optional persisted Lexical editor state (JSON string) to restore.

documentId​

documentId: string

Defined in: src/chat/document/EphemeralDocument.tsx:108

Document identifier. Must match the id passed to useLexicalTools so the agent's lexical frontend tools operate on this document instance.

onContentChange?​

optional onContentChange?: (content) => void

Defined in: src/chat/document/EphemeralDocument.tsx:114

Callback fired when the document's editor state changes.

Parameters​

content​

string

Returns​

void

onToolsReady?​

optional onToolsReady?: (tools) => void

Defined in: src/chat/document/EphemeralDocument.tsx:116

Reports the lexical frontend tools so the parent can pass them to the agent.

Parameters​

tools​

FrontendToolDefinition<Record<string, unknown>, unknown>[]

Returns​

void

runtimePodName?​

optional runtimePodName?: string

Defined in: src/chat/document/EphemeralDocument.tsx:110

Preferred runtime pod name to bind the document kernel to.