Metadata-Version: 2.4
Name: llama-index-retrievers-you
Version: 1.1.0
Summary: llama-index retrievers you integration
Author-email: akhil@you.com
License-Expression: MIT
License-File: LICENSE
Requires-Python: <4.0,>=3.10
Requires-Dist: httpx>=0.27.0
Requires-Dist: llama-index-core<0.15,>=0.13.0
Description-Content-Type: text/markdown

# LlamaIndex Retrievers Integration: You Retriever

Retriever for You.com's Search API, providing unified web and news search results.

## Installation

```bash
pip install llama-index-retrievers-you
```

## Usage

```python
from llama_index.retrievers.you import YouRetriever

# Initialize with API key
retriever = YouRetriever(api_key="your-api-key")

# Or set YDC_API_KEY environment variable
# retriever = YouRetriever()

# Retrieve search results synchronously
results = retriever.retrieve("your search query")

# Retrieve search results asynchronously
results = await retriever.aretrieve("your search query")
```

## Features

- Unified web and news search
- Customizable search parameters (country, language, freshness, etc.)
- Optional livecrawl for full-page content in html or markdown format
- Seamless integration with LlamaIndex query engines and agents

## API Reference

See the [You.com API documentation](https://docs.you.com/api-reference/search/v1-search) for details on available parameters.

## Development

### Setup

```bash
# Install package with dev dependencies
pip install -e ".[dev]"

# Or using uv
uv pip install -e ".[dev]"
```

### Running Tests

```bash
pytest tests/
```
