【Gradio】Interface State 界面状态

到目前为止，我们假设您的演示是无状态的，即它们不保留单个函数调用之外的信息。如果您想根据演示的前一次交互修改演示的行为，有两种方法可以在 Gradio 中实现：全局状态和会话状态。

全局状态 

如果状态是所有函数调用和所有用户都可以访问的，您可以在函数调用外创建一个变量，并在函数内部访问它。例如，您可以在函数外加载一个大型模型，并在函数内部使用它，以便每个函数调用不需要重新加载模型。

import gradio as gr  # 导入gradio库来创建UI界面


# 定义一个全局列表scores，用来存储所有的分数
scores = []


# 定义一个函数track_score，用于跟踪分数
def track_score(score):
    scores.append(score)  # 将新的分数添加到scores列表中
    top_scores = sorted(scores, reverse=True)[:3]  # 将scores列表降序排列，并取前三个最高分
    return top_scores  # 返回前三个最高的分数


# 创建Gradio界面
demo = gr.Interface(
    track_score,  # 指定track_score函数为界面的后端处理函数
    gr.Number(label="Score"),  # 创建一个数字输入控件，并设置标签为"Score"，用于用户输入分数
    gr.JSON(label="Top Scores")  # 创建一个JSON显示控件，并设置标签为"Top Scores"，用于显示前三个最高分
)
demo.launch()  # 启动Gradio应用

该代码段创建了一个Gradio界面，允许用户输入分数，并在输入新分数后，显示当前最高的三个分数。分数通过全局列表scores进行跟踪，并在每次用户输入后更新。界面包含一个数字输入框供用户输入分数，当分数提交后，函数track_score会被调用，它将分数加入scores列表，并返回排序后的前三个最高分数。这些分数会以JSON格式展示在界面上。通过调用demo.launch()，这个界面会启动并准备好供用户进行操作。

在上面的代码中， scores 数组在所有用户之间共享。如果多个用户访问这个演示，他们的分数都会添加到同一个列表中，并且返回的前三个分数将从这个共享的引用中收集。

会话状态

Gradio 还支持另一种类型的数据持久性，即会话状态，其中数据在页面会话中的多次提交之间持久存在。但是，数据不会在您的模型的不同用户之间共享。要在会话状态中存储数据，您需要做三件事：

1. 将额外的参数传递给您的函数，该参数表示界面状态。

2. 在函数结束时，将状态的更新值作为额外的返回值返回。

3. 添加 'state' 输入和 'state' 输出组件时创建您的 Interface

这是一个简单的应用程序，用于说明会话状态 - 此应用程序只是存储用户的以前提交并将其显示给用户：

import gradio as gr  # 导入gradio库，用于快速构建界面


# 定义一个函数，用于存储消息并展示历史消息
def store_message(message: str, history: list[str]):
    # 构造一个输出字典，包括当前消息和历史消息列表（历史消息列表反序以显示最近的消息在最前）
    output = {
        "Current messages": message,  # 当前消息
        "Previous messages": history[::-1]  # 历史消息，列表反序
    }
    history.append(message)  # 将当前消息添加到历史消息列表末尾
    return output, history  # 返回输出字典和更新后的历史消息列表


# 创建Gradio界面
demo = gr.Interface(
    fn=store_message,  # 指定界面调用的函数为store_message
    inputs=[
        "textbox",  # 第一个输入控件，用于用户输入新消息
        gr.State(value=[])  # 第二个输入控件，用于存储历史消息列表的状态
    ],
    outputs=[
        "json",  # 第一个输出控件，用于显示当前和历史消息的JSON格式信息
        gr.State()  # 第二个输出控件，更新历史消息列表的状态
    ]
)


demo.launch()  # 启动Gradio界面

这段代码定义了一个简单的Gradio应用，用于存储和展示用户输入的消息以及之前的历史消息。当用户输入一条新消息后，该消息将被添加到历史消息列表中，同时界面将展示当前消息和以倒序排列的历史消息列表（即最新的消息显示在最上方）。通过使用gr.State控件，应用能够跟踪和更新历史消息的状态，即使在用户提交新消息后页面也不会丢失之前的消息。这使得用户可以在一个session内持续追踪消息的流程。

请注意状态是如何在每个页面内的提交过程中持续存在的，但如果您在另一个标签页中加载此演示（或刷新页面），演示将不会共享聊天历史记录。在这里，我们不能将提交历史记录存储在全局变量中，否则不同用户之间的提交历史记录就会混乱。

State 的初始值默认为 None 。如果向 gr.State() 的 value 参数传递一个参数，该参数将被用作状态的默认值。

注意： Interface 类只支持单个会话状态变量（尽管它可以是一个包含多个元素的列表）。对于更复杂的用例，您可以使用支持多个 State 变量的 Blocks。另外，如果您正在构建一个能维护用户状态的聊天机器人，可以考虑使用 ChatInterface 抽象，它能自动管理状态。