这将帮助您开始使用 Box 检索器。有关所有 BoxRetriever 功能和配置的详细文档，请参阅 API 参考。
BoxRetriever 类可帮助您以 LangChain 的 Document 格式从 Box 获取非结构化内容。您可以通过对文件进行全文搜索，或使用 Box AI 检索包含针对文件进行 AI 查询结果的 Document 来实现此目的。这需要包含一个包含 Box 文件 ID 的 List[str]，即 ["12345","67890"]
Box AI 需要 Enterprise Plus 许可证
集成详情
1: 自带数据（即，索引和搜索自定义文档语料库）
| 检索器 | 自托管 | 云服务 | 包 |
|---|
| BoxRetriever | ❌ | ✅ | langchain-box |
- 一个 Box 帐户 — 如果您不是当前的 Box 客户或想在生产 Box 实例之外进行测试，您可以使用一个免费开发者帐户。
- 一个 Box 应用 — 这在开发者控制台中配置，对于 Box AI，必须启用
管理 AI范围。在这里您还将选择您的身份验证方法
- 该应用必须由管理员启用。对于免费开发者帐户，管理员就是注册该帐户的人。
对于这些示例，我们将使用令牌身份验证。这可以与任何身份验证方法一起使用。只需通过任何方法获取令牌即可。如果您想了解如何将其他身份验证类型与langchain-box一起使用，请访问Box 提供商文档。
import getpass
import os
box_developer_token = getpass.getpass("Enter your Box Developer Token: ")
os.environ["LANGSMITH_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")
os.environ["LANGSMITH_TRACING"] = "true"
langchain-box 包中
pip install -qU langchain-box
Note: you may need to restart the kernel to use updated packages.
实例化
现在我们可以实例化我们的检索器
from langchain_box import BoxRetriever
retriever = BoxRetriever(box_developer_token=box_developer_token)
langchain_box.utilities.SearchOptions 结合使用 langchain_box.utilities.SearchTypeFilter 和 langchain_box.utilities.DocumentFiles 枚举，以过滤创建日期、文件搜索部分，甚至将搜索范围限制到特定文件夹。 有关更多信息，请查阅 API 参考。from langchain_box.utilities import BoxSearchOptions, DocumentFiles, SearchTypeFilter
box_folder_id = "260931903795"
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,"],
k=200,
size_range=[1, 1000000],
updated_data_range=None,
)
retriever = BoxRetriever(
box_developer_token=box_developer_token, box_search_options=box_search_options
)
retriever.invoke("AstroTech Solutions")
[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')]
Box AI
from langchain_box import BoxRetriever
box_file_ids = ["1514555423624", "1514553902288"]
retriever = BoxRetriever(
box_developer_token=box_developer_token, box_file_ids=box_file_ids
)
query = "What was the most expensive item purchased"
retriever.invoke(query)
[Document(metadata={'source': 'Box AI', 'title': 'Box AI What was the most expensive item purchased'}, page_content='The most expensive item purchased is the **Gravitational Wave Detector Kit** from AstroTech Solutions, which costs **$800**.')]
BoxRetriever，您可以返回对提示的回答、Box 用于获取该回答的引用，或两者兼而有之。无论您选择如何使用 Box AI，检索器都会返回一个 List[Document] 对象。我们通过两个布尔参数 answer 和 citations 提供这种灵活性。answer 默认为 True，citations 默认为 False，因此如果您只想要回答，可以省略两者。如果您想要两者，只需包含 citations=True；如果您只想要引用，则应包含 answer=False 和 citations=True。
两者兼得
retriever = BoxRetriever(
box_developer_token=box_developer_token, box_file_ids=box_file_ids, citations=True
)
retriever.invoke(query)
[Document(metadata={'source': 'Box AI', 'title': 'Box AI What was the most expensive item purchased'}, page_content='The most expensive item purchased is the **Gravitational Wave Detector Kit** from AstroTech Solutions, which costs **$800**.'),
Document(metadata={'source': 'Box AI What was the most expensive item purchased', 'file_name': 'Invoice-A5555.txt', 'file_id': '1514555423624', 'file_type': 'file'}, page_content='Vendor: AstroTech Solutions\nInvoice Number: A5555\n\nLine Items:\n - Gravitational Wave Detector Kit: $800\n - Exoplanet Terrarium: $120\nTotal: $920')]
仅引用
retriever = BoxRetriever(
box_developer_token=box_developer_token,
box_file_ids=box_file_ids,
answer=False,
citations=True,
)
retriever.invoke(query)
[Document(metadata={'source': 'Box AI What was the most expensive item purchased', 'file_name': 'Invoice-A5555.txt', 'file_id': '1514555423624', 'file_type': 'file'}, page_content='Vendor: AstroTech Solutions\nInvoice Number: A5555\n\nLine Items:\n - Gravitational Wave Detector Kit: $800\n - Exoplanet Terrarium: $120\nTotal: $920')]
from langchain_classic import hub
from langchain.agents import AgentExecutor, create_openai_tools_agent
from langchain.tools.retriever import create_retriever_tool
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,"],
k=200,
size_range=[1, 1000000],
updated_data_range=None,
)
retriever = BoxRetriever(
box_developer_token=box_developer_token, box_search_options=box_search_options
)
box_search_tool = create_retriever_tool(
retriever,
"box_search_tool",
"This tool is used to search Box and retrieve documents that match the search criteria",
)
tools = [box_search_tool]
prompt = hub.pull("hwchase17/openai-tools-agent")
prompt.messages
llm = ChatOpenAI(temperature=0, openai_api_key=openai_key)
agent = create_openai_tools_agent(llm, tools, prompt)
agent_executor = AgentExecutor(agent=agent, tools=tools)
/Users/shurrey/local/langchain/.venv/lib/python3.11/site-packages/langsmith/client.py:312: LangSmithMissingAPIKeyWarning: API key must be provided when using hosted LangSmith API
warnings.warn(
result = agent_executor.invoke(
{
"input": "list the items I purchased from AstroTech Solutions from most expensive to least expensive"
}
)
print(f"result {result['output']}")
result The items you purchased from AstroTech Solutions from most expensive to least expensive are:
1. Gravitational Wave Detector Kit: $800
2. Exoplanet Terrarium: $120
Total: $920
FileFull 对象中选择额外字段作为自定义 LangChain 元数据返回的功能。每个对象都接受一个可选的 List[str]，称为 extra_fields，其中包含返回对象中的 json 键，例如 extra_fields=["shared_link"]。 连接器会将此字段添加到集成所需的功能字段列表中，然后将结果添加到在 Document 或 Blob 中返回的元数据中，例如 "metadata" : { "source" : "source, "shared_link" : "shared_link" }。如果该文件无法获取该字段，则会返回一个空字符串，例如 "shared_link" : ""。API 参考
有关 BoxRetriever 所有功能和配置的详细文档，请参阅API 参考。
如果您有任何疑问，可以查看我们的开发者文档，或在我们的开发者社区中与我们联系。
