Metadata-Version: 2.4
Name: llama-index-retrievers-duckdb-retriever
Version: 0.5.0
Summary: llama-index retrievers duckdb-retriever integration
Author-email: Your Name <you@example.com>
License-Expression: MIT
License-File: LICENSE
Requires-Python: <4.0,>=3.9
Requires-Dist: duckdb<2,>=1.1.3
Requires-Dist: llama-index-core<0.14,>=0.13.0
Description-Content-Type: text/markdown

# LlamaIndex Retrievers Integration: DuckDBRetriever

`pip install llama-index-retrievers-duckdb-retriever.`

## What is this?

This is a BM25 Retriever for DuckDB that can be used with LlamaIndex to enable full-text search.

## How to use

This was created with reference to [DuckDB Full-Text Search Extension](https://duckdb.org/docs/extensions/full_text_search), so it's mostly the same.

Please refer to that.

However, while `DuckDBVectorStore` is an VectorStore, `DuckDBRetriever` is a Retriever.

DuckDBRetriever Example:

```python
from llama_index.retrievers.duckdb_retriever import DuckDBRetriever

retriever = DuckDBRetriever(database_name="vector.db", persist_dir="duckdb")
nodes = retriever.retrieve("retrieve_query")
```
