Lynx
  • English

      • genui / a2ui-prompt

      a2ui-prompt

      Index

      Interfaces

      InterfaceDescription
      A2UICatalogPrompt-ready A2UI catalog including components, rules, examples, and optional client functions.
      A2UIComponentPropPrompt-facing description of a single A2UI component prop.
      A2UIComponentSpecPrompt-facing component specification derived from a catalog manifest.
      A2UIExampleValidated user request and message sequence included as an in-context A2UI example.
      A2UIFunctionSpecPrompt-facing schema for a client-side function the agent may call.
      BuildSystemPromptOptionsOptions used to customize the generated A2UI system prompt.
      JsonSchemaJSON Schema subset used in prompt-facing catalog descriptions.
      ReadA2UICatalogDirectoryOptionsOptions for loading generated A2UI catalog artifacts from a directory.

      Variables

      VariableDescription
      A2UI_PROTOCOL_VERSION-
      A2UI_SYSTEM_PROMPT-
      BASIC_CATALOG-
      BASIC_CATALOG_EXAMPLES-
      BASIC_CATALOG_ID-

      Functions

      FunctionDescription
      buildA2UISystemPromptBuild the full A2UI system prompt for the supplied catalog.
      createA2UICatalogFromManifestsConvert generated component manifests into a prompt-ready A2UI catalog.
      readA2UICatalogFromDirectoryRead generated component and function manifests and convert them into a prompt-ready A2UI catalog.
      renderCatalogReferenceRender an A2UI catalog into the Markdown reference embedded in prompts.
      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.