mirror of
https://github.com/hwchase17/langchain.git
synced 2025-09-24 20:09:01 +00:00
box: Add searchoptions for BoxRetriever, documentation for BoxRetriever as agent tool (#26181)
Thank you for contributing to LangChain! - [x] **PR title**: "package: description" - Where "package" is whichever of langchain, community, core, experimental, etc. is being modified. Use "docs: ..." for purely docs changes, "templates: ..." for template changes, "infra: ..." for CI changes. - Example: "community: add foobar LLM" Added search options for BoxRetriever and added documentation to demonstrate how to use BoxRetriever as an agent tool - @BoxPlatform - [x] **Add tests and docs**: If you're adding a new integration, please include 1. a test for the integration, preferably unit tests that do not rely on network access, 2. an example notebook showing its use. It lives in `docs/docs/integrations` directory. - [x] **Lint and test**: Run `make format`, `make lint` and `make test` from the root of the package(s) you've modified. See contribution guidelines for more: https://python.langchain.com/docs/contributing/ Additional guidelines: - Make sure optional dependencies are imported within a function. - Please do not add dependencies to pyproject.toml files (even optional ones) unless they are required for unit tests. - Most PRs should not touch more than one package. - Changes should be backwards compatible. - If you are adding something to community, do not re-import it in langchain. If no one reviews your PR within a few days, please @-mention one of baskaryan, efriis, eyurtsev, ccurme, vbarda, hwchase17.
This commit is contained in:
@@ -3,7 +3,13 @@ from langchain_core.documents import Document
|
||||
from pytest_mock import MockerFixture
|
||||
|
||||
from langchain_box.retrievers import BoxRetriever
|
||||
from langchain_box.utilities import BoxAuth, BoxAuthType
|
||||
from langchain_box.utilities import (
|
||||
BoxAuth,
|
||||
BoxAuthType,
|
||||
BoxSearchOptions,
|
||||
DocumentFiles,
|
||||
SearchTypeFilter,
|
||||
)
|
||||
|
||||
|
||||
# Test auth types
|
||||
@@ -62,6 +68,44 @@ def test_search(mocker: MockerFixture) -> None:
|
||||
]
|
||||
|
||||
|
||||
# test search options
|
||||
def test_search_options(mocker: MockerFixture) -> None:
|
||||
mocker.patch(
|
||||
"langchain_box.utilities._BoxAPIWrapper.search_box",
|
||||
return_value=(
|
||||
[
|
||||
Document(
|
||||
page_content="Test file mode\ndocument contents",
|
||||
metadata={"title": "Testing Files"},
|
||||
)
|
||||
]
|
||||
),
|
||||
)
|
||||
|
||||
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_date_range=None,
|
||||
)
|
||||
|
||||
retriever = BoxRetriever( # type: ignore[call-arg]
|
||||
box_developer_token="box_developer_token", box_search_options=box_search_options
|
||||
)
|
||||
|
||||
documents = retriever.invoke("query")
|
||||
|
||||
assert documents == [
|
||||
Document(
|
||||
page_content="Test file mode\ndocument contents",
|
||||
metadata={"title": "Testing Files"},
|
||||
)
|
||||
]
|
||||
|
||||
|
||||
# test ai retrieval
|
||||
def test_ai(mocker: MockerFixture) -> None:
|
||||
mocker.patch(
|
||||
|
@@ -5,6 +5,9 @@ EXPECTED_ALL = [
|
||||
"BoxRetriever",
|
||||
"BoxAuth",
|
||||
"BoxAuthType",
|
||||
"BoxSearchOptions",
|
||||
"DocumentFiles",
|
||||
"SearchTypeFilter",
|
||||
"_BoxAPIWrapper",
|
||||
"__version__",
|
||||
]
|
||||
|
Reference in New Issue
Block a user