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/PromptSpec.md.
Lynx
  • English
  • Interface: PromptSpec

    Extends

    • BaseSpec

    Properties

    additionalRules?

    optional additionalRules?: string[]


    bindings?

    optional bindings?: boolean

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


    componentGroups?

    optional componentGroups?: ComponentGroup$1[]

    Inherited from

    BaseSpec.componentGroups


    components

    components: Record<string, ComponentPromptSpec>

    Inherited from

    BaseSpec.components


    editMode?

    optional editMode?: boolean


    examples?

    optional examples?: string[]

    General examples (static/layout patterns). Both examples and toolExamples are included when present.


    id?

    optional id?: string

    Inherited from

    BaseSpec.id


    inlineMode?

    optional inlineMode?: boolean


    preamble?

    optional preamble?: string


    root?

    optional root?: string

    Inherited from

    BaseSpec.root


    toolCalls?

    optional toolCalls?: boolean

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


    toolExamples?

    optional toolExamples?: string[]

    Tool-specific examples (Query/Mutation patterns). Both examples and toolExamples are included when present.


    tools?

    optional tools?: (string | ToolSpec)[]

    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.