迁移到 streamEvents v2

危险

本迁移指南正在开发中，尚未完成。

我们已在 streamEvents API 的 PR 中添加了 streamEvents API 的 v2 版本，该版本在 0.2.0 版本中发布。

v2 版本是对 v1 版本的重写，应该更加高效，并为事件提供更一致的输出。v1 版本的 API 将被弃用，转而使用 v2 版本，并将从 0.4.0 版本中删除。

以下是 API 的 v1 版本和 v2 版本之间更改的列表。

on_chat_model_end 的输出

在 v1 中，与 on_chat_model_end 关联的输出根据聊天模型是作为根级别可运行对象运行还是作为链的一部分运行而有所不同。

作为根级别可运行对象，输出为

{
  data: {
    output: AIMessageChunk((content = "hello world!"), (id = "some id"));
  }
}

作为链的一部分，输出为

{
  data: {
    output: {
      generations: [
        [
          {
            generation_info: None,
            message: AIMessageChunk(
                content="hello world!", id="some id"
            ),
            text: "hello world!",
          }
        ]
      ],
    }
  },
}

从 v2 开始，输出将始终是更简单的表示形式

{
  data: {
    output: AIMessageChunk((content = "hello world!"), (id = "some id"));
  }
}

注意

非聊天模型（即普通 LLM）目前将始终与更详细的格式相关联。

on_retriever_end 的输出

on_retriever_end 输出将始终返回一个 Documents 列表。

这是 v1 中的输出

{
  data: {
    output: {
      documents: [
        Document(...),
        Document(...),
        ...
      ]
    }
  }
}

这是 v2 的新输出

{
  data: {
    output: [
      Document(...),
      Document(...),
      ...
    ]
  }
}

删除了 on_retriever_stream

on_retriever_stream 事件是实现的产物，已删除。

与该事件相关的完整信息已在 on_retriever_end 事件中提供。

请改用 on_retriever_end。

删除了 on_tool_stream

on_tool_stream 事件是实现的产物，已删除。

与该事件相关的完整信息已在 on_tool_end 事件中提供。

请改用 on_tool_end。

传播名称

可运行对象的名称已更新，以保持一致。

如果您按事件名称进行过滤，请检查是否需要更新您的过滤器。