Skip to main content
本指南提供 JSON 文档加载器的快速入门概览。关于 JSONLoader 所有功能和配置的详细文档，请参阅 API 参考。
  • TODO: 添加其他相关链接，例如底层 API 信息等。

​
概览

​
集成详情

类包本地可序列化JS 支持
JSONLoaderlangchain-community✅❌✅

​
加载器特性

来源文档懒加载原生异步支持
JSONLoader✅❌

​
设置

要使用 JSON 文档加载器，需要安装 langchain-community 集成包以及 jq Python 包。

​
凭证

使用 JSONLoader 类无需任何凭证。 要启用模型调用的自动追踪，请设置您的 LangSmith API 密钥： 
os.environ["LANGSMITH_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")
os.environ["LANGSMITH_TRACING"] = "true"

​
安装

安装 langchain-community 和 jq： 
pip install -qU langchain-community jq

​
初始化

现在可以实例化模型对象并加载文档：
  • TODO: 根据相关参数更新模型实例化代码。
from langchain_community.document_loaders import JSONLoader

loader = JSONLoader(
    file_path="./example_data/facebook_chat.json",
    jq_schema=".messages[].content",
    text_content=False,
)

​
加载

docs = loader.load()
docs[0]

Document(metadata={'source': '/Users/isaachershenson/Documents/langchain/docs/docs/integrations/document_loaders/example_data/facebook_chat.json', 'seq_num': 1}, page_content='Bye!')

print(docs[0].metadata)

{'source': '/Users/isaachershenson/Documents/langchain/docs/docs/integrations/document_loaders/example_data/facebook_chat.json', 'seq_num': 1}

​
懒加载

pages = []
for doc in loader.lazy_load():
    pages.append(doc)
    if len(pages) >= 10:
        # do some paged operation, e.g.
        # index.upsert(pages)

        pages = []

​
从 JSON Lines 文件读取

如需从 JSON Lines 文件加载文档，传入 json_lines=True 并指定 jq_schema 以从单个 JSON 对象中提取 page_content。 
loader = JSONLoader(
    file_path="./example_data/facebook_chat_messages.jsonl",
    jq_schema=".content",
    text_content=False,
    json_lines=True,
)

docs = loader.load()
print(docs[0])

page_content='Bye!' metadata={'source': '/Users/isaachershenson/Documents/langchain/docs/docs/integrations/document_loaders/example_data/facebook_chat_messages.jsonl', 'seq_num': 1}

​
读取特定内容键

另一种方式是设置 jq_schema='.' 并提供 content_key，以只加载特定内容： 
loader = JSONLoader(
    file_path="./example_data/facebook_chat_messages.jsonl",
    jq_schema=".",
    content_key="sender_name",
    json_lines=True,
)

docs = loader.load()
print(docs[0])

page_content='User 2' metadata={'source': '/Users/isaachershenson/Documents/langchain/docs/docs/integrations/document_loaders/example_data/facebook_chat_messages.jsonl', 'seq_num': 1}

​
在 jq schema 中使用 content_key 的 JSON 文件

若要在 jq schema 中使用 content_key 从 JSON 文件加载文档，请设置 is_content_key_jq_parsable=True。请确保 content_key 与 jq schema 兼容且可被解析。 
loader = JSONLoader(
    file_path="./example_data/facebook_chat.json",
    jq_schema=".messages[]",
    content_key=".content",
    is_content_key_jq_parsable=True,
)

docs = loader.load()
print(docs[0])

page_content='Bye!' metadata={'source': '/Users/isaachershenson/Documents/langchain/docs/docs/integrations/document_loaders/example_data/facebook_chat.json', 'seq_num': 1}

​
提取元数据

通常，我们希望将 JSON 文件中的元数据包含在从内容创建的文档中。 以下示例演示如何使用 JSONLoader 提取元数据。 需要注意几个关键变化。在之前未收集元数据的示例中，我们可以直接在 schema 中指定 page_content 的提取位置。 在此示例中，我们需要告诉加载器遍历 messages 字段中的记录，因此 jq_schema 应为 .messages[]。 这样就可以将记录（字典）传入需要实现的 metadata_func。metadata_func 负责确定记录中哪些信息应包含在最终 Document 对象的元数据中。 此外，我们现在还需要通过 content_key 参数在加载器中明确指定从记录的哪个键提取 page_content 的值。 
# Define the metadata extraction function.
def metadata_func(record: dict, metadata: dict) -> dict:
    metadata["sender_name"] = record.get("sender_name")
    metadata["timestamp_ms"] = record.get("timestamp_ms")

    return metadata


loader = JSONLoader(
    file_path="./example_data/facebook_chat.json",
    jq_schema=".messages[]",
    content_key="content",
    metadata_func=metadata_func,
)

docs = loader.load()
print(docs[0].metadata)

{'source': '/Users/isaachershenson/Documents/langchain/docs/docs/integrations/document_loaders/example_data/facebook_chat.json', 'seq_num': 1, 'sender_name': 'User 2', 'timestamp_ms': 1675597571851}

​
API 参考

关于 JSONLoader 所有功能和配置的详细文档，请参阅 API 参考：python.langchain.com/api_reference/community/document_loaders/langchain_community.document_loaders.json_loader.JSONLoader.html
在 GitHub 上编辑此页面 或 提交问题。
将这些文档连接 到 Claude、VSCode 等，通过 MCP 获取实时答案。