AICheckRunSingleRootResult

The list of top-level blocks that were affected by the run. Returns a fresh copy on every call — mutating the returned array does not affect the result's internal state.

Parameters

value : Array<AIRunChangeData>

Collaboration channel id captured at the start of the run.

The contentRawNew with data-id attributes stripped. Suitable for surfacing to end-users.

The contentRawOld with data-id attributes stripped. Suitable for surfacing to end-users.

The post-run document snapshot with all returned suggestions merged in, with data-id attributes preserved. Equals contentRawOld when the run produced no suggestions. undefined until the run completes.

Parameters

value : string

The pre-run document snapshot as captured at the time the run started, with data-id attributes preserved. undefined until the run starts.

Parameters

value : string

Document version captured when the run started. undefined until the run starts.

Parameters

value : number

Whether applying the result dropped the change because it would introduce block structure an inline root cannot accept. When true, the run completed but apply applied nothing.

Parameters

value : boolean

The editor the AI run was performed against.

The error that caused the run to fail.

When the failure originated in the AI service backend, its structured response (for example, an issues list describing which fields failed validation) is available under error.data.backendData.

Parameters

value : CKEditorError | undefined

Name of the editor root the AI run targeted.

AI editing session id captured at the start of the run.

Outcome of the run. Anything other than 'completed' means the run did not finish successfully — see error for details.

Parameters

data : AIRunSingleRootResultInput

Marks the run as aborted. Reflected via status.

Returns

void