该 langchain-box 包提供了两种从 Box 索引文件的方法： BoxLoader 和 BoxBlobLoader. BoxLoader 允许你提取 Box 中具有文本表示的文件的文本内容。该 BoxBlobLoader 允许你下载任何文档或图片文件的 blob，以便使用你选择的 blob 解析器进行处理。

本笔记本详细介绍了如何开始使用这两者。

概述

该 BoxLoader 类帮助你以 LangChain 的 Document 格式从 Box 获取非结构化内容。你可以使用包含 Box 文件 ID 的 List[str] ，或使用包含 Box 文件夹 ID 的 str 。

该 BoxBlobLoader 类帮助你以 LangChain 的 Blob 格式从 Box 获取非结构化内容。你可以使用包含 Box 文件 ID 的 List[str] 、包含 Box 文件夹 ID 的 str 、搜索查询或 BoxMetadataQuery.

如果要从具有文件夹 ID 的文件夹中获取文件，你还可以设置 Bool 来指示加载器获取该文件夹中的所有子文件夹。

该 BoxLoader 会跳过没有文本表示的文件，而该 BoxBlobLoader 会返回所有文档和图片文件的 blob。

集成详情

加载器功能

设置

要使用 Box 包，你需要准备以下内容：

• * Box 账户 — 如果你不是 Box 的现有客户或想在生产 Box 实例之外进行测试，你可以使用 免费开发者账户.
• * Box 应用 — 这在 开发者控制台中配置，对于 Box AI，必须启用 Manage AI 作用域。你也可以在此选择身份验证方法
• * 该应用必须由 管理员启用。对于免费开发者账户，这是注册该账户的人。

凭据

在这些示例中，我们将使用 令牌身份验证。这可以与任何 身份验证方法一起使用。只需使用任何方法获取令牌。如果你想了解如何将其他身份验证类型与 langchain-box一起使用，请访问 Box 提供商 document.

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 在实例化时。

这需要 1 条信息：

• * **box_文件_ID** (List[str]) - Box 文件 ID 列表。

BoxLoader

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_文件夹_id** (str) - 包含 Box 文件夹 ID 的字符串。

BoxLoader

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) - 包含要执行的搜索查询的字符串。

您还可以提供 BoxSearchOptions 对象来缩小搜索范围

• * **box_搜索_选项** (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) - 包含要执行的搜索查询的字符串。

您还可以提供 BoxSearchOptions 对象来缩小搜索范围

• * **box_搜索_选项** (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)

加载

BoxLoader

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 对象中其他字段的功能 FileFull 对象以返回自定义 LangChain 元数据。每个对象接受一个可选的 List[str] 名为 extra_fields 包含返回对象中的 json 键，例如 extra_fields=["shared_link"].

连接器会将此字段添加到集成功能所需的字段列表中，然后将这些结果添加到 @[ 中返回的元数据中Document] or Blob，例如 "metadata" : { "source" : "source, "shared_link" : "shared_link" }。如果该字段对该文件不可用，它将返回空字符串，例如 "shared_link" : "".

帮助

如果您有问题，可以查看我们的 开发者文档 或通过我们的 开发者社区.