For AI agents: the complete documentation index is available at /next/zh/llms.txt, the full documentation bundle is available at /next/zh/llms-full.txt, and this page is available as Markdown at /next/zh/api/genui/openui/core/interfaces/UseOpenUIStateOptions.md.
Lynx
  • 简体中文
  • 接口: UseOpenUIStateOptions

    用于解析 OpenUI 文本并构建渲染器状态的输入。

    属性

    initialQueryResults?

    optional initialQueryResults?: Readonly<Record<string, unknown>>

    预取的 Query 结果,以 Query 赋值名称(statement ID)为键。它们在首次渲染时即可使用,并在可选的 tool provider 于 commit 后重新校验期间作为兜底值。


    initialState?

    optional initialState?: Record<string, unknown>


    isStreaming

    isStreaming: boolean


    library

    library: Library


    onAction?

    optional onAction?: (event: ActionEvent) => void

    参数

    参数类型
    eventActionEvent

    返回

    void


    onError?

    optional onError?: (errors: OpenUIError[]) => void

    结构化、便于 LLM 理解的错误回调。参见 OpenUIError 类型。

    参数

    参数类型
    errorsOpenUIError[]

    返回

    void


    onStateUpdate?

    optional onStateUpdate?: (state: Record<string, unknown>) => void

    参数

    参数类型
    stateRecord<string, unknown>

    返回

    void


    response

    response: string | null


    toolProvider?

    optional toolProvider?: ToolProvider | null

    用于 Query 数据获取的 ToolProvider——MCP、REST、GraphQL 或任意后端。

    除非另有说明,本项目采用知识共享署名 4.0 国际许可协议进行许可,代码示例采用 Apache License 2.0 许可协议进行许可。