For AI agents: the complete documentation index is available at /next/llms.txt, the full documentation bundle is available at /next/llms-full.txt, and this page is available as Markdown at /next/api/genui/openui/core/interfaces/PromptOptions.md.
Lynx
  • English

      • Interface: PromptOptions

      Properties

      additionalRules?

      optional additionalRules?: string[]

      bindings?

      optional bindings?: boolean

      Enable $variables, @Set, @Reset, interactive filters. Default: true if toolCalls.

      editMode?

      optional editMode?: boolean

      Enable edit-mode instructions in the prompt.

      examples?

      optional examples?: string[]

      Examples shown when no tools are present (static/layout patterns).

      inlineMode?

      optional inlineMode?: boolean

      Enable inline mode — LLM can respond with text + optional openui-lang fenced code.

      preamble?

      optional preamble?: string

      toolCalls?

      optional toolCalls?: boolean

      Enable Query(), Mutation(), @Run, tool workflow. Default: true if tools provided.

      toolExamples?

      optional toolExamples?: string[]

      Examples shown when tools ARE present (Query/Mutation patterns). Takes priority over examples.

      tools?

      optional tools?: ToolDescriptor[]

      Available tools for Query() — string names or rich ToolSpec descriptors injected into the prompt.

      Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.