JSONLoader

此笔记本提供了 JSON 文档加载程序入门的快速概述。有关所有 JSONLoader 功能和配置的详细文档，请参阅 API 参考。

TODO：添加任何其他相关链接，例如有关底层 API 的信息等。

概述

集成详细信息

类	包	本地化	序列化	JS 支持
JSONLoader	langchain_community	✅	❌	✅

Loader 功能

源	文档延迟加载	原生异步支持
JSONLoader	✅	❌

设置

要访问 JSON 文档加载器，您需要安装langchain-community集成包以及jqpython 软件包。

凭据

使用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提取page_content从单个 JSON 对象。

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`

要使用content_key在 JQ 架构中，将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[]

这允许我们将记录（dict）传递到metadata_func这必须得到实施。这metadata_func负责确定记录中的哪些信息应包含在存储在最终Document对象。

此外，我们现在必须在 loader 中通过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

Document loader 概念指南
Document loader 操作指南

概述