llama-index-retrievers-duckdb-retriever


Namellama-index-retrievers-duckdb-retriever JSON
Version 0.2.0 PyPI version JSON
download
home_pageNone
Summaryllama-index retrievers duckdb-retriever integration
upload_time2024-08-22 07:16:47
maintainerNone
docs_urlNone
authorYour Name
requires_python<4.0,>=3.8.1
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # 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")
```

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "llama-index-retrievers-duckdb-retriever",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8.1",
    "maintainer_email": null,
    "keywords": null,
    "author": "Your Name",
    "author_email": "you@example.com",
    "download_url": "https://files.pythonhosted.org/packages/7e/55/84d1637bfcac11016775f915ffe18b489b634a2e0aacf475e4ac7ed28811/llama_index_retrievers_duckdb_retriever-0.2.0.tar.gz",
    "platform": null,
    "description": "# LlamaIndex Retrievers Integration: DuckDBRetriever\n\n`pip install llama-index-retrievers-duckdb-retriever.`\n\n## What is this?\n\nThis is a BM25 Retriever for DuckDB that can be used with LlamaIndex to enable full-text search.\n\n## How to use\n\nThis was created with reference to [DuckDB Full-Text Search Extension](https://duckdb.org/docs/extensions/full_text_search), so it's mostly the same.\n\nPlease refer to that.\n\nHowever, while `DuckDBVectorStore` is an VectorStore, `DuckDBRetriever` is a Retriever.\n\nDuckDBRetriever Example:\n\n```python\nfrom llama_index.retrievers.duckdb_retriever import DuckDBRetriever\n\nretriever = DuckDBRetriever(database_name=\"vector.db\", persist_dir=\"duckdb\")\nnodes = retriever.retrieve(\"retrieve_query\")\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "llama-index retrievers duckdb-retriever integration",
    "version": "0.2.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1bb745227cedabfec4779b62dbc219ea3100616aecb7c4ac5e62a1d37d564bc3",
                "md5": "76af89fd267f1bebfc2e71b95fb0e243",
                "sha256": "4b4d2a1b66799e3743e555a105e4cc0f2a709806d5ac39fc39193a9dffe80ee6"
            },
            "downloads": -1,
            "filename": "llama_index_retrievers_duckdb_retriever-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "76af89fd267f1bebfc2e71b95fb0e243",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8.1",
            "size": 3581,
            "upload_time": "2024-08-22T07:16:46",
            "upload_time_iso_8601": "2024-08-22T07:16:46.654968Z",
            "url": "https://files.pythonhosted.org/packages/1b/b7/45227cedabfec4779b62dbc219ea3100616aecb7c4ac5e62a1d37d564bc3/llama_index_retrievers_duckdb_retriever-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7e5584d1637bfcac11016775f915ffe18b489b634a2e0aacf475e4ac7ed28811",
                "md5": "025b6fc8ba15ff5f316b151e7dd97dca",
                "sha256": "275cd786568a3a19778d3a2ae8eb2a8f9ba47e28a6cec4c1aaca1d7f658f2443"
            },
            "downloads": -1,
            "filename": "llama_index_retrievers_duckdb_retriever-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "025b6fc8ba15ff5f316b151e7dd97dca",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8.1",
            "size": 3210,
            "upload_time": "2024-08-22T07:16:47",
            "upload_time_iso_8601": "2024-08-22T07:16:47.698429Z",
            "url": "https://files.pythonhosted.org/packages/7e/55/84d1637bfcac11016775f915ffe18b489b634a2e0aacf475e4ac7ed28811/llama_index_retrievers_duckdb_retriever-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-22 07:16:47",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "llama-index-retrievers-duckdb-retriever"
}
Your Name
Elapsed time: 0.30159s