以编程方式使用文档

>Outline 是一个开源的协作知识库平台，专为团队信息共享而设计。

本笔记本展示了如何从 Outline 集合中获取 LangChain Documents。

概述

该 Outline 文档加载器 可用于将 Outline 集合加载为 LangChain Documents，以便集成到检索增强生成 (RAG) 工作流中。

本示例演示：

  • * 设置文档加载器以从 Outline 实例加载所有文档。

设置

开始之前，请确保已设置以下环境变量：

os.environ["OUTLINE_API_KEY"] = "ol_api_xyz123"
os.environ["OUTLINE_INSTANCE_URL"] = "https://app.getoutline.com"

初始化

要初始化 OutlineLoader，需要以下参数：

  • * outline_base_url：Outline 实例的 URL（或将从环境变量中获取）。
  • * outline_api_key：用于在 Outline 实例中进行身份验证的 API 密钥（或将从环境变量中获取）。
  • * outline_collection_id_list：要检索的集合 ID 列表。如果为 None，则检索全部。
  • * page_size：因为 Outline API 使用分页结果，您可以配置每次 API 请求检索多少条结果（文档）。如果未指定，将使用默认值。

实例化

# Option 1: Using environment variables (ensure they are set)
from langchain_outline.document_loaders.outline import OutlineLoader

loader = OutlineLoader()

# Option 2: Passing parameters directly
loader = OutlineLoader(
    outline_base_url="YOUR_OUTLINE_URL", outline_api_key="YOUR_API_KEY"
)

加载

加载并返回 Outline 实例中所有可用的文档

loader.load()

延迟加载

延迟_load 方法使您能够从 Outline 集合中迭代加载文档，并在获取时返回每个文档：

loader.lazy_load()

API 参考

有关所有 Outline 功能和配置的详细文档，请参阅 API 参考： www.getoutline.com/developers