Sign up (with export icon)

AIGatewayApplyOptions

Api-typedef icontypedef

Properties

  • Chevron-right icon

    aiSource : AIOperationSource | undefined

    AI source identifier stamped on every operation produced for this run.

    Defaults to 'api'.

    Note that when applyMethod is 'suggest', every created suggestion also receives the @ai attribute with the same identifier. The track changes plugin uses this attribute to display the suggestion as AI-generated.

  • Chevron-right icon

    How AI run changes are applied to the editor content.

    With 'insert' the changes are written directly into the editor content. With 'suggest' they are wrapped as track-changes suggestions — this requires the TrackChanges plugin to be loaded on the editor.

  • Chevron-right icon

    roots : Array<AIEditorRoot> | undefined

    Restrict the apply to a subset of the result's per-root entries. Each entry's channelId and rootName must match a per-root sub-result in the passed AIRunResult. When omitted, every entry in result.results is applied.

Value

object