BoxLoader 和 BoxBlobLoader

这langchain-boxpackage 提供了两种方法来从 Box 索引您的文件：BoxLoader和BoxBlobLoader.BoxLoader允许您收录在 Box 中具有文本表示的文件的文本表示形式。这BoxBlobLoader允许您下载任何文档或图像文件的 blob，以便使用您选择的 blob 解析器进行处理。

此笔记本详细介绍了这两项的入门。有关所有 BoxLoader 功能和配置的详细文档，请前往 BoxLoader 和 BoxBlobLoader 的 API 参考页面。

概述

这BoxLoader类帮助你从 Langchain 的Document格式。您可以使用List[str]包含 Box 文件 ID，或者带有str包含 Box 文件夹 ID。

这BoxBlobLoader类帮助你从 Langchain 的Blob格式。您可以使用List[str]包含 Box 文件 ID，则str包含 Box 文件夹 ID、搜索查询或BoxMetadataQuery.

如果从具有文件夹 ID 的文件夹中获取文件，您还可以将Bool告诉 loader 也获取该文件夹中的所有子文件夹。

信息

一个 Box 实例可以包含 PB 级文件，而文件夹可以包含数百万个文件。在选择要编制索引的文件夹时要有意识。我们建议永远不要以递归方式从文件夹 0 获取所有文件。文件夹 ID 0 是您的根文件夹。

这BoxLoader将跳过没有文本表示形式的文件，而BoxBlobLoader将返回所有文档和图像文件的 blob。

集成详细信息

类	包	本地化	序列 化	JS 支持
BoxLoader	langchain_box	✅	❌	❌
BoxBlobLoader	langchain_box	✅	❌	❌

Loader 功能

源	文档延迟加载	异步支持
BoxLoader	✅	❌
BoxBlobLoader	✅	❌

设置

为了使用 Box 包，您需要一些东西：

• Box 账户 – 如果您不是当前的 Box 客户，或者想在生产 Box 实例之外进行测试，则可以使用免费的开发人员账户。
• Box 应用程序 — 这是在开发人员控制台中配置的，对于 Box AI，必须具有Manage AI启用范围。在这里，您还将选择您的身份验证方法
• 该应用程序必须由管理员启用。对于免费开发者账户，这是注册该账户的人。

凭据

对于这些示例，我们将使用 Token Authentication。这可以与任何身份验证方法一起使用。只需使用任何方法获取令牌即可。如果您想详细了解如何将其他身份验证类型与langchain-box，请访问 Box 提供程序文档。

import getpass
import os

box_developer_token = getpass.getpass("Enter your Box Developer Token: ")

Enter your Box Developer Token:  ········

要启用模型调用的自动跟踪，请设置您的 LangSmith API 密钥：

# os.environ["LANGSMITH_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")
# os.environ["LANGSMITH_TRACING"] = "true"

安装

安装 langchain_box。

%pip install -qU langchain_box

初始化

加载文件

如果要加载文件，则必须提供List实例化时的文件 ID 的 ID 中。

这需要 1 条信息：

• box_file_ids (List[str]）- Box 文件 ID 的列表。

箱式装载机

from langchain_box.document_loaders import BoxLoader

box_file_ids = ["1514555423624", "1514553902288"]

loader = BoxLoader(
    box_developer_token=box_developer_token,
    box_file_ids=box_file_ids,
    character_limit=10000,  # Optional. Defaults to no limit
)

BoxBlobLoader

from langchain_box.blob_loaders import BoxBlobLoader

box_file_ids = ["1514555423624", "1514553902288"]

loader = BoxBlobLoader(
    box_developer_token=box_developer_token, box_file_ids=box_file_ids
)

从文件夹加载

如果您希望从文件夹加载文件，则必须提供str替换为 Box 文件夹 ID。

这需要 1 条信息：

• box_folder_id (str）- 包含 Box 文件夹 ID 的字符串。

箱式装载机

from langchain_box.document_loaders import BoxLoader

box_folder_id = "260932470532"

loader = BoxLoader(
    box_folder_id=box_folder_id,
    recursive=False,  # Optional. return entire tree, defaults to False
    character_limit=10000,  # Optional. Defaults to no limit
)

BoxBlobLoader

from langchain_box.blob_loaders import BoxBlobLoader

box_folder_id = "260932470532"

loader = BoxBlobLoader(
    box_folder_id=box_folder_id,
    recursive=False,  # Optional. return entire tree, defaults to False
)

使用 BoxBlobLoader 搜索文件

如果您需要搜索文件，请使用BoxBlobLoader提供两种方法。首先，您可以使用可选的搜索选项执行全文搜索，以缩小搜索范围。

这需要 1 条信息：

• 查询 (str）- 包含要执行的搜索查询的字符串。

您还可以提供BoxSearchOptionsobject 缩小搜索范围

• box_search_options (BoxSearchOptions)

BoxBlobLoader 搜索

from langchain_box.blob_loaders import BoxBlobLoader
from langchain_box.utilities import BoxSearchOptions, DocumentFiles, SearchTypeFilter

box_folder_id = "260932470532"

box_search_options = BoxSearchOptions(
    ancestor_folder_ids=[box_folder_id],
    search_type_filter=[SearchTypeFilter.FILE_CONTENT],
    created_date_range=["2023-01-01T00:00:00-07:00", "2024-08-01T00:00:00-07:00,"],
    file_extensions=[DocumentFiles.DOCX, DocumentFiles.PDF],
    k=200,
    size_range=[1, 1000000],
    updated_data_range=None,
)

loader = BoxBlobLoader(
    box_developer_token=box_developer_token,
    query="Victor",
    box_search_options=box_search_options,
)

您还可以根据 Box 元数据搜索内容。如果您的 Box 实例使用元数据，您可以搜索附加了特定元数据模板且满足特定条件的任何文档，例如返回上个季度创建的总金额大于或等于 500 美元的任何发票。

这需要 1 条信息：

• 查询 (str）- 包含要执行的搜索查询的字符串。

您还可以提供BoxSearchOptionsobject 缩小搜索范围

• box_search_options (BoxSearchOptions)

BoxBlobLoader 元数据查询

from langchain_box.blob_loaders import BoxBlobLoader
from langchain_box.utilities import BoxMetadataQuery

query = BoxMetadataQuery(
    template_key="enterprise_1234.myTemplate",
    query="total >= :value",
    query_params={"value": 100},
    ancestor_folder_id="260932470532",
)

loader = BoxBlobLoader(box_metadata_query=query)

负荷

箱式装载机

docs = loader.load()
docs[0]

Document(metadata={'source': 'https://dl.boxcloud.com/api/2.0/internal_files/1514555423624/versions/1663171610024/representations/extracted_text/content/', 'title': 'Invoice-A5555_txt'}, page_content='Vendor: AstroTech Solutions\nInvoice Number: A5555\n\nLine Items:\n    - Gravitational Wave Detector Kit: $800\n    - Exoplanet Terrarium: $120\nTotal: $920')

print(docs[0].metadata)

{'source': 'https://dl.boxcloud.com/api/2.0/internal_files/1514555423624/versions/1663171610024/representations/extracted_text/content/', 'title': 'Invoice-A5555_txt'}

BoxBlobLoader

for blob in loader.yield_blobs():
    print(f"Blob({blob})")

Blob(id='1514555423624' metadata={'source': 'https://app.box.com/0/260935730128/260931903795/Invoice-A5555.txt', 'name': 'Invoice-A5555.txt', 'file_size': 150} data="b'Vendor: AstroTech Solutions\\nInvoice Number: A5555\\n\\nLine Items:\\n    - Gravitational Wave Detector Kit: $800\\n    - Exoplanet Terrarium: $120\\nTotal: $920'" mimetype='text/plain' path='https://app.box.com/0/260935730128/260931903795/Invoice-A5555.txt')
Blob(id='1514553902288' metadata={'source': 'https://app.box.com/0/260935730128/260931903795/Invoice-B1234.txt', 'name': 'Invoice-B1234.txt', 'file_size': 168} data="b'Vendor: Galactic Gizmos Inc.\\nInvoice Number: B1234\\nPurchase Order Number: 001\\nLine Items:\\n    - Quantum Flux Capacitor: $500\\n    - Anti-Gravity Pen Set: $75\\nTotal: $575'" mimetype='text/plain' path='https://app.box.com/0/260935730128/260931903795/Invoice-B1234.txt')

延迟加载

仅限 BoxLoader

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

        page = []

额外字段

所有 Box 连接器都提供从 Box 中选择其他字段的功能FileFullobject 作为自定义 LangChain 元数据返回。每个对象都接受一个可选的List[str]叫extra_fields包含来自 return 对象的 JSON 键，例如extra_fields=["shared_link"].

连接器会将此字段添加到集成运行所需的字段列表中，然后将结果添加到返回的元数据中Document或Blob喜欢"metadata" : { "source" : "source, "shared_link" : "shared_link" }.如果该字段对该文件不可用，它将作为空字符串返回，例如"shared_link" : "".

API 参考

有关所有 BoxLoader 功能和配置的详细文档，请参阅 API 参考

帮助

如果您有任何疑问，可以查看我们的开发人员文档或在我们的开发人员社区中联系使用。

相关

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