JSONLoader

本笔记本提供了快速入门 JSON 文档加载器 的概览。如需了解所有 JSONLoader 功能和配置的详细文档，请访问 API 参考。

• 待办事项：添加任何其他相关链接，例如关于底层 API 的信息等。

概览

集成详情

类	包	本地	可序列化的	JS 支持
JSONLoader	langchain_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,
)

API 参考：JSONLoader

加载

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 模式的 JSON 文件 content_key

要使用 jq 架构中的 content_key 从 JSON 文件加载文档，请设置 is_content_key_jq_parsable=True。确保 content_key 兼容且可以使用 jq 架构进行解析。

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 提取元数据。

有一些重要的更改需要注意。在之前没有收集元数据的示例中，我们能够直接在模式中指定 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 参考：https://python.langchain.com/api_reference/community/document_loaders/langchain_community.document_loaders.json_loader.JSONLoader.html

相关

• 文档加载器 概念指南
• 文档加载器 操操作指南