AIDocumentProcessingRunResult
The result of an AI document processing run.
Properties
channelId : string | undefinedreadonlyinheritedmodule:ai/aidocumentprocessing/model/aidocumentprocessingrunresult~AIDocumentProcessingRunResult#channelIdCollaboration channel id captured at the start of the run.
contentNew : stringreadonlyinheritedmodule:ai/aidocumentprocessing/model/aidocumentprocessingrunresult~AIDocumentProcessingRunResult#contentNewThe
contentRawNewwithdata-idattributes stripped. Suitable for surfacing to end-users.contentOld : stringreadonlyinheritedmodule:ai/aidocumentprocessing/model/aidocumentprocessingrunresult~AIDocumentProcessingRunResult#contentOldThe
contentRawOldwithdata-idattributes stripped. Suitable for surfacing to end-users.contentRawNew : string | undefinedinheritedmodule:ai/aidocumentprocessing/model/aidocumentprocessingrunresult~AIDocumentProcessingRunResult#contentRawNewThe post-run document snapshot with all returned suggestions merged in, with
data-idattributes preserved. EqualscontentRawOldwhen the run produced no suggestions.undefineduntil the run completes.Parameters
value : string
contentRawOld : string | undefinedinheritedmodule:ai/aidocumentprocessing/model/aidocumentprocessingrunresult~AIDocumentProcessingRunResult#contentRawOldThe pre-run document snapshot as captured at the time the run started, with
data-idattributes preserved.undefineduntil the run starts.Parameters
value : string
documentVersion : number | undefinedinheritedmodule:ai/aidocumentprocessing/model/aidocumentprocessingrunresult~AIDocumentProcessingRunResult#documentVersionDocument version captured when the run started.
undefineduntil the run starts.Parameters
value : number
module:ai/aidocumentprocessing/model/aidocumentprocessingrunresult~AIDocumentProcessingRunResult#editorThe editor the AI run was performed against.
error : Error | undefinedinheritedmodule:ai/aidocumentprocessing/model/aidocumentprocessingrunresult~AIDocumentProcessingRunResult#errorrootName : stringreadonlyinheritedmodule:ai/aidocumentprocessing/model/aidocumentprocessingrunresult~AIDocumentProcessingRunResult#rootNameName of the editor root the AI run targeted.
sessionId : stringreadonlyinheritedmodule:ai/aidocumentprocessing/model/aidocumentprocessingrunresult~AIDocumentProcessingRunResult#sessionIdAI editing session id captured at the start of the run.
status : AIRunStatusreadonlyinheritedmodule:ai/aidocumentprocessing/model/aidocumentprocessingrunresult~AIDocumentProcessingRunResult#statusOutcome of the run. Anything other than
'completed'means the run did not finish successfully — seeerrorfor details.summary : stringmodule:ai/aidocumentprocessing/model/aidocumentprocessingrunresult~AIDocumentProcessingRunResult#summaryThe summary of changes produced by the run.
Parameters
value : string
Methods
constructor( data )inheritedmodule:ai/aidocumentprocessing/model/aidocumentprocessingrunresult~AIDocumentProcessingRunResult#constructorParameters
data : AIRunResultInput
abort() → voidinheritedmodule:ai/aidocumentprocessing/model/aidocumentprocessingrunresult~AIDocumentProcessingRunResult#abort