mirror of
https://github.com/hwchase17/langchain.git
synced 2025-06-21 14:18:52 +00:00
83 lines
2.4 KiB
Markdown
83 lines
2.4 KiB
Markdown
# langchain-tests
|
|
|
|
This is a testing library for LangChain integrations. It contains the base classes for
|
|
a standard set of tests.
|
|
|
|
## Installation
|
|
|
|
We encourage pinning your version to a specific version in order to avoid breaking
|
|
your CI when we publish new tests. We recommend upgrading to the latest version
|
|
periodically to make sure you have the latest tests.
|
|
|
|
Not pinning your version will ensure you always have the latest tests, but it may
|
|
also break your CI if we introduce tests that your integration doesn't pass.
|
|
|
|
Pip:
|
|
|
|
```bash
|
|
pip install -U langchain-tests
|
|
```
|
|
|
|
Poetry:
|
|
|
|
```bash
|
|
poetry add langchain-tests
|
|
```
|
|
|
|
## Usage
|
|
|
|
To add standard tests to an integration package's e.g. ChatModel, you need to create
|
|
|
|
1. A unit test class that inherits from ChatModelUnitTests
|
|
2. An integration test class that inherits from ChatModelIntegrationTests
|
|
|
|
`tests/unit_tests/test_standard.py`:
|
|
|
|
```python
|
|
"""Standard LangChain interface tests"""
|
|
|
|
from typing import Type
|
|
|
|
import pytest
|
|
from langchain_core.language_models import BaseChatModel
|
|
from langchain_tests.unit_tests import ChatModelUnitTests
|
|
|
|
from langchain_parrot_chain import ChatParrotChain
|
|
|
|
|
|
class TestParrotChainStandard(ChatModelUnitTests):
|
|
@pytest.fixture
|
|
def chat_model_class(self) -> Type[BaseChatModel]:
|
|
return ChatParrotChain
|
|
```
|
|
|
|
`tests/integration_tests/test_standard.py`:
|
|
|
|
```python
|
|
"""Standard LangChain interface tests"""
|
|
|
|
from typing import Type
|
|
|
|
import pytest
|
|
from langchain_core.language_models import BaseChatModel
|
|
from langchain_tests.integration_tests import ChatModelIntegrationTests
|
|
|
|
from langchain_parrot_chain import ChatParrotChain
|
|
|
|
|
|
class TestParrotChainStandard(ChatModelIntegrationTests):
|
|
@pytest.fixture
|
|
def chat_model_class(self) -> Type[BaseChatModel]:
|
|
return ChatParrotChain
|
|
```
|
|
|
|
## Reference
|
|
|
|
The following fixtures are configurable in the test classes. Anything not marked
|
|
as required is optional.
|
|
|
|
- `chat_model_class` (required): The class of the chat model to be tested
|
|
- `chat_model_params`: The keyword arguments to pass to the chat model constructor
|
|
- `chat_model_has_tool_calling`: Whether the chat model can call tools. By default, this is set to `hasattr(chat_model_class, 'bind_tools)`
|
|
- `chat_model_has_structured_output`: Whether the chat model can structured output. By default, this is set to `hasattr(chat_model_class, 'with_structured_output')`
|