BoxRetriever

这将帮助您开始使用 Box 检索器。有关所有 BoxRetriever 功能和配置的详细文档，请访问 API 参考。

概述

BoxRetriever 类帮助您以 Langchain 的 Document 格式从 Box 获取非结构化内容。您可以通过基于全文搜索查找文件，或使用 Box AI 检索包含针对文件进行 AI 查询结果的 Document 来实现此目的。这需要包含一个 List[str]，其中包含 Box 文件 ID，即 ["12345","67890"]

信息

Box AI 需要 Enterprise Plus 许可证

没有文本表示形式的文件将被跳过。

集成详细信息

1：自带数据（即，索引和搜索文档的自定义语料库）

检索器	自托管	云产品	包
BoxRetriever	❌	✅	langchain-box

设置

为了使用 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: ")

如果您想从各个查询中获取自动跟踪，您还可以通过取消注释下方内容来设置您的 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

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**.')]

引用

通过 Box AI 和 BoxRetriever，您可以返回对提示的答案、返回 Box 用来获得该答案的引用，或者两者都返回。无论您选择如何使用 Box AI，检索器都会返回一个 List[Document] 对象。我们通过两个 bool 参数 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')]

在链中使用

与其他检索器一样，BoxRetriever 可以通过 链 整合到 LLM 应用程序中。

我们将需要一个 LLM 或聊天模型

选择聊天模型

OpenAI

Anthropic

Azure

Google Vertex

AWS

Groq

Cohere

NVIDIA

Fireworks AI

Mistral AI

Together AI

IBM watsonx

Databricks

xAI

pip install -qU "langchain[openai]"

import getpass
import os

if not os.environ.get("OPENAI_API_KEY"):
  os.environ["OPENAI_API_KEY"] = getpass.getpass("Enter API key for OpenAI: ")

from langchain.chat_models import init_chat_model

llm = init_chat_model("gpt-4o-mini", model_provider="openai")

openai_key = getpass.getpass("Enter your OpenAI key: ")

Enter your OpenAI key:  ········

from langchain_core.output_parsers import StrOutputParser
from langchain_core.prompts import ChatPromptTemplate
from langchain_core.runnables import RunnablePassthrough

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
)

context = "You are a finance professional that handles invoices and purchase orders."
question = "Show me all the items purchased from AstroTech Solutions"

prompt = ChatPromptTemplate.from_template(
    """Answer the question based only on the context provided.

    Context: {context}

    Question: {question}"""
)


def format_docs(docs):
    return "\n\n".join(doc.page_content for doc in docs)


chain = (
    {"context": retriever | format_docs, "question": RunnablePassthrough()}
    | prompt
    | llm
    | StrOutputParser()
)

API 参考：StrOutputParser | ChatPromptTemplate | RunnablePassthrough

chain.invoke(question)

'- Gravitational Wave Detector Kit: $800\n- Exoplanet Terrarium: $120'

用作 Agent 工具

与其他检索器一样，BoxRetriever 也可以作为工具添加到 LangGraph Agent 中。

pip install -U langsmith

from langchain import hub
from langchain.agents import AgentExecutor, create_openai_tools_agent
from langchain.tools.retriever import create_retriever_tool

API 参考：hub | AgentExecutor | create_openai_tools_agent | 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

额外字段

所有 Box 连接器都允许您从 Box 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 参考。

帮助

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

相关内容

• 检索器概念指南
• 检索器操作指南