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