Docs
Installation

Installation

TatryRetriever can be used either via our REST API or by installing the Python SDK. Choose the method that best suits your needs.

Using the REST API

If you want to use TatryRetriever via REST API, no installation is needed. Just make sure you have:

  • A valid API key from TatryRetriever
  • The ability to make HTTPS requests from your application

Using the Python SDK

Requirements

  • Python 3.8 or later
  • A valid API key from TatryRetriever
  • LangChain (optional, for integration features)

Installation Methods

pip install tatry
poetry add tatry
git clone https://github.com/tatryai/tatry.git
cd tatry
pip install -e .

Verifying installation

You can verify your installation by running:

from tatry import TatryRetriever
 
# This should print the version number
print(TatryRetriever.version())
curl https://api.tatry.dev/v1/version \
  -H "Authorization: Bearer your-api-key"

Optional dependencies

TatryRetriever works out of the box, but you can install optional dependencies for additional features:

# For LangChain integration
pip install tatry[langchain]
 
# For async support
pip install tatry[async]
 
# For all optional features
pip install tatry[all]
# For LangChain integration
poetry add tatry[langchain]
 
# For async support
poetry add tatry[async]
 
# For all optional features
poetry add tatry[all]

Troubleshooting

If you encounter any issues during installation:

  1. Ensure you have the latest pip version:
pip install --upgrade pip
  1. Check Python version compatibility:
python --version

What's Next?

  • Explore the Core Concepts to understand how TatryRetriever works
  • Check out our Guides for detailed tutorials
  • Review the API Reference for detailed documentation