Sign up (with export icon)

AIDocumentProcessingRunOptions

Api-typedef icontypedef

Properties

  • Chevron-right icon

    Per-call AI capability directives. webSearch toggles web search; reasoning toggles reasoning and optionally selects a level (see AIReasoningLevel). Omitting the option or leaving all flags falsy disables both capabilities for this call.

  • Chevron-right icon

    model : string

    The model that will be used to run the document processing request. The IDs of an AI models can be acquired via getAvailableModels call.

  • Chevron-right icon

    roots : Array<AIEditorRoot> | undefined

    The roots to process. When omitted, every non-$graveyard root across every editor in the current Context is processed. When provided, only the listed roots are processed; the order of entries in roots is treated as a set-membership filter and does not affect the payload order.

    Each entry's channelId must match the collaboration.channelId config of the target editor instance. rootName must match an existing, non-$graveyard root within that editor.

Value

AIRunBaseOptions & object