跳到主要内容
Outline 是一个开源的协作知识库平台，专为团队信息共享而设计。
本笔记本展示了如何从您的 Outline 集合中获取 LangChain 文档。

​
概览

Outline 文档加载器可用于将 Outline 集合作为 LangChain 文档加载，以集成到检索增强生成 (RAG) 工作流中。 本示例演示：
  • 设置文档加载器以从 Outline 实例加载所有文档。

​
设置

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

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：您的 API 密钥，用于向您的 Outline 实例进行身份验证（否则将从环境变量中获取）。
  • 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()

​
延迟加载

lazy_load 方法允许您从 Outline 集合中迭代加载文档，并在每次获取时生成每个文档。 
loader.lazy_load()

​
API 参考

有关所有 Outline 功能和配置的详细文档，请参阅 API 参考：www.getoutline.com/developers
在 GitHub 上编辑此页面源文件。
以编程方式连接这些文档到 Claude、VSCode 等，通过 MCP 获取实时答案。
© . This site is unofficial and not affiliated with LangChain, Inc.