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

    Options used to customize the generated OpenUI system prompt.

    Extends

    Properties

    appendix?

    optional appendix?: string


    componentGroups?

    optional componentGroups?: ComponentGroup[]

    Replace or extend the built-in component groups.

    Inherited from

    CreateOpenUiPromptLibraryOptions.componentGroups


    componentNames?

    optional componentNames?: readonly string[]

    Limit built-ins to these names. Custom components are still appended.

    Inherited from

    CreateOpenUiPromptLibraryOptions.componentNames


    components?

    optional components?: OpenUiPromptComponent[]

    Replace or extend the built-in component set.

    Inherited from

    CreateOpenUiPromptLibraryOptions.components


    promptOptions?

    optional promptOptions?: PromptOptions


    root?

    optional root?: string

    Override the root component name. Defaults to 'Stack'.

    Inherited from

    CreateOpenUiPromptLibraryOptions.root

    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.