Sign up (with export icon)

AIRunSingleRootResult

Api-class iconclass

The result of an AI run.

Properties

  • Chevron-right icon

    channelId : string | undefined
    readonly

    Collaboration channel id captured at the start of the run.

  • Chevron-right icon

    contentNew : string
    readonly

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

  • Chevron-right icon

    contentOld : string
    readonly

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

  • Chevron-right icon

    contentRawNew : string | undefined

    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
  • Chevron-right icon

    contentRawOld : string | undefined

    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
  • Chevron-right icon

    documentVersion : number | undefined

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

    Parameters

    value : number
  • Chevron-right icon

    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
  • Chevron-right icon

    editor : Editor
    readonly

    The editor the AI run was performed against.

  • Chevron-right icon

    error : Error | undefined

    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
  • Chevron-right icon

    rootName : string
    readonly

    Name of the editor root the AI run targeted.

  • Chevron-right icon

    sessionId : string
    readonly

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

  • Chevron-right icon

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

Methods

  • Chevron-right icon

    constructor( data )

  • Chevron-right icon

    abort() → void

    Marks the run as aborted. Reflected via status.

    Returns

    void