AIRunResult
The result of an AI run.
Properties
channelId : string | undefinedreadonlymodule:ai/aicore/model/airunresult~AIRunResult#channelIdCollaboration channel id captured at the start of the run.
contentNew : stringreadonlymodule:ai/aicore/model/airunresult~AIRunResult#contentNewThe
contentRawNewwithdata-idattributes stripped. Suitable for surfacing to end-users.contentOld : stringreadonlymodule:ai/aicore/model/airunresult~AIRunResult#contentOldThe
contentRawOldwithdata-idattributes stripped. Suitable for surfacing to end-users.contentRawNew : string | undefinedmodule:ai/aicore/model/airunresult~AIRunResult#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 | undefinedmodule:ai/aicore/model/airunresult~AIRunResult#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 | undefinedmodule:ai/aicore/model/airunresult~AIRunResult#documentVersionDocument version captured when the run started.
undefineduntil the run starts.Parameters
value : number
module:ai/aicore/model/airunresult~AIRunResult#editorThe editor the AI run was performed against.
error : Error | undefinedmodule:ai/aicore/model/airunresult~AIRunResult#errorrootName : stringreadonlymodule:ai/aicore/model/airunresult~AIRunResult#rootNameName of the editor root the AI run targeted.
sessionId : stringreadonlymodule:ai/aicore/model/airunresult~AIRunResult#sessionIdAI editing session id captured at the start of the run.
status : AIRunStatusreadonlymodule:ai/aicore/model/airunresult~AIRunResult#statusOutcome of the run. Anything other than
'completed'means the run did not finish successfully — seeerrorfor details.
Methods
constructor( data )module:ai/aicore/model/airunresult~AIRunResult#constructorParameters
data : AIRunResultInput
abort() → voidmodule:ai/aicore/model/airunresult~AIRunResult#abort