mirror of
https://github.com/hwchase17/langchain
synced 2024-11-06 03:20:49 +00:00
b01cf0dd54
This PR refactors the ArxivAPIWrapper class making `doc_content_chars_max` parameter optional. Additionally, tests have been added to ensure the functionality of the doc_content_chars_max parameter. Fixes #6027 (issue)
130 lines
4.0 KiB
Python
130 lines
4.0 KiB
Python
"""Integration test for Arxiv API Wrapper."""
|
|
from typing import Any, List
|
|
|
|
import pytest
|
|
|
|
from langchain.agents.load_tools import load_tools
|
|
from langchain.schema import Document
|
|
from langchain.tools.base import BaseTool
|
|
from langchain.utilities import ArxivAPIWrapper
|
|
|
|
|
|
@pytest.fixture
|
|
def api_client() -> ArxivAPIWrapper:
|
|
return ArxivAPIWrapper()
|
|
|
|
|
|
def test_run_success(api_client: ArxivAPIWrapper) -> None:
|
|
"""Test that returns the correct answer"""
|
|
|
|
output = api_client.run("1605.08386")
|
|
assert "Heat-bath random walks with Markov bases" in output
|
|
|
|
|
|
def test_run_returns_several_docs(api_client: ArxivAPIWrapper) -> None:
|
|
"""Test that returns several docs"""
|
|
|
|
output = api_client.run("Caprice Stanley")
|
|
assert "On Mixing Behavior of a Family of Random Walks" in output
|
|
|
|
|
|
def test_run_returns_no_result(api_client: ArxivAPIWrapper) -> None:
|
|
"""Test that gives no result."""
|
|
|
|
output = api_client.run("1605.08386WWW")
|
|
assert "No good Arxiv Result was found" == output
|
|
|
|
|
|
def assert_docs(docs: List[Document]) -> None:
|
|
for doc in docs:
|
|
assert doc.page_content
|
|
assert doc.metadata
|
|
assert set(doc.metadata) == {"Published", "Title", "Authors", "Summary"}
|
|
|
|
|
|
def test_load_success(api_client: ArxivAPIWrapper) -> None:
|
|
"""Test that returns one document"""
|
|
|
|
docs = api_client.load("1605.08386")
|
|
assert len(docs) == 1
|
|
assert_docs(docs)
|
|
|
|
|
|
def test_load_returns_no_result(api_client: ArxivAPIWrapper) -> None:
|
|
"""Test that returns no docs"""
|
|
|
|
docs = api_client.load("1605.08386WWW")
|
|
assert len(docs) == 0
|
|
|
|
|
|
def test_load_returns_limited_docs() -> None:
|
|
"""Test that returns several docs"""
|
|
expected_docs = 2
|
|
api_client = ArxivAPIWrapper(load_max_docs=expected_docs)
|
|
docs = api_client.load("ChatGPT")
|
|
assert len(docs) == expected_docs
|
|
assert_docs(docs)
|
|
|
|
|
|
def test_load_returns_limited_doc_content_chars() -> None:
|
|
"""Test that returns limited doc_content_chars_max"""
|
|
|
|
doc_content_chars_max = 100
|
|
api_client = ArxivAPIWrapper(doc_content_chars_max=doc_content_chars_max)
|
|
docs = api_client.load("1605.08386")
|
|
assert len(docs[0].page_content) == doc_content_chars_max
|
|
|
|
|
|
def test_load_returns_unlimited_doc_content_chars() -> None:
|
|
"""Test that returns unlimited doc_content_chars_max"""
|
|
|
|
doc_content_chars_max = None
|
|
api_client = ArxivAPIWrapper(doc_content_chars_max=doc_content_chars_max)
|
|
docs = api_client.load("1605.08386")
|
|
assert len(docs[0].page_content) == 54337
|
|
|
|
|
|
def test_load_returns_full_set_of_metadata() -> None:
|
|
"""Test that returns several docs"""
|
|
api_client = ArxivAPIWrapper(load_max_docs=1, load_all_available_meta=True)
|
|
docs = api_client.load("ChatGPT")
|
|
assert len(docs) == 1
|
|
for doc in docs:
|
|
assert doc.page_content
|
|
assert doc.metadata
|
|
assert set(doc.metadata).issuperset(
|
|
{"Published", "Title", "Authors", "Summary"}
|
|
)
|
|
print(doc.metadata)
|
|
assert len(set(doc.metadata)) > 4
|
|
|
|
|
|
def _load_arxiv_from_universal_entry(**kwargs: Any) -> BaseTool:
|
|
tools = load_tools(["arxiv"], **kwargs)
|
|
assert len(tools) == 1, "loaded more than 1 tool"
|
|
return tools[0]
|
|
|
|
|
|
def test_load_arxiv_from_universal_entry() -> None:
|
|
arxiv_tool = _load_arxiv_from_universal_entry()
|
|
output = arxiv_tool("Caprice Stanley")
|
|
assert (
|
|
"On Mixing Behavior of a Family of Random Walks" in output
|
|
), "failed to fetch a valid result"
|
|
|
|
|
|
def test_load_arxiv_from_universal_entry_with_params() -> None:
|
|
params = {
|
|
"top_k_results": 1,
|
|
"load_max_docs": 10,
|
|
"load_all_available_meta": True,
|
|
}
|
|
arxiv_tool = _load_arxiv_from_universal_entry(**params)
|
|
assert isinstance(arxiv_tool, ArxivAPIWrapper)
|
|
wp = arxiv_tool.api_wrapper
|
|
assert wp.top_k_results == 1, "failed to assert top_k_results"
|
|
assert wp.load_max_docs == 10, "failed to assert load_max_docs"
|
|
assert (
|
|
wp.load_all_available_meta is True
|
|
), "failed to assert load_all_available_meta"
|