BoxLoader
本笔记本概述了 Box 文档加载器的入门知识。有关所有 BoxLoader 功能和配置的详细文档，请访问API 参考。
概述
BoxLoader 类可帮助你从 Box 中获取非结构化内容，并将其转换为 Langchain 的 Document 格式。你可以使用包含 Box 文件 ID 的 List[str]，或包含 Box 文件夹 ID 的 str 来完成此操作。
你必须提供包含 Box 文件 ID 的 List[str]，或包含文件夹 ID 的 str。如果要从具有文件夹 ID 的文件夹中获取文件，你还可以设置一个 Bool 值，告知加载器获取该文件夹中的所有子文件夹。
一个 Box 实例可能包含 PB 级的文件，文件夹可能包含数百万个文件。在选择要索引的文件夹时请谨慎。我们建议永远不要递归地获取文件夹 0 中的所有文件。文件夹 ID 0 是你的根文件夹。
不具有文本表示形式的文件将被跳过。
集成详细信息
| 类 | 包 | 本地 | 可序列化 | JS 支持 |
|---|---|---|---|---|
| BoxLoader | langchain_box | ✅ | ❌ | ❌ |
加载器功能
| 源 | 文档延迟加载 | 异步支持 |
|---|---|---|
| BoxLoader | ✅ | ❌ |
设置
要使用 Box 包，你需要以下几项：
- 一个 Box 帐户 — 如果你不是当前的 Box 客户，或者想在生产 Box 实例之外进行测试，你可以使用免费的开发者帐户。
- 一个 Box 应用程序— 这在开发者控制台中配置，对于 Box AI，必须启用
Manage AI范围。你还可以在此处选择身份验证方法。 - 该应用程序必须由管理员启用。对于免费开发者帐户，则由注册该帐户的人员启用。
凭据
在这些示例中，我们将使用令牌身份验证。这可以与任何身份验证方法一起使用。只需使用任何方法获取令牌即可。如果你想了解更多关于如何将其他身份验证类型与 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
初始化
加载文件
如果你希望加载文件，则必须在实例化时提供文件 ID 的 List。
这需要 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
)
从文件夹加载
如果你希望从文件夹加载文件，则必须在实例化时提供包含 Box 文件夹 ID 的 str。
这需要 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
)
加载
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'}
延迟加载
page = []
for doc in loader.lazy_load():
page.append(doc)
if len(page) >= 10:
# do some paged operation, e.g.
# index.upsert(page)
page = []
API 参考
有关所有 BoxLoader 功能和配置的详细文档，请访问API 参考
帮助
如果您有任何疑问，可以查看我们的开发者文档，或在我们的开发者社区中与我们联系。