# Chroma AutoRetrieval Pack
This LlamaPack inserts your data into chroma and insantiates an auto-retriever, which will use the LLM at runtime to set metadata filtering, top-k, and query string.
## CLI Usage
You can download llamapacks directly using `llamaindex-cli`, which comes installed with the `llama-index` python package:
```bash
llamaindex-cli download-llamapack ChromaAutoretrievalPack --download-dir ./chroma_pack
```
You can then inspect the files at `./chroma_pack` and use them as a template for your own project!
## Code Usage
You can download the pack to a the `./chroma_pack` directory:
```python
from llama_index.core.llama_pack import download_llama_pack
# download and install dependencies
ChromaAutoretrievalPack = download_llama_pack(
"ChromaAutoretrievalPack", "./chroma_pack"
)
```
From here, you can use the pack, or inspect and modify the pack in `./chroma_pack`.
Then, you can set up the pack like so:
```python
# setup pack arguments
from llama_index.core.vector_stores.types import MetadataInfo, VectorStoreInfo
vector_store_info = VectorStoreInfo(
content_info="brief biography of celebrities",
metadata_info=[
MetadataInfo(
name="category",
type="str",
description=(
"Category of the celebrity, one of [Sports Entertainment, Business, Music]"
),
),
],
)
import chromadb
client = chromadb.EphemeralClient()
nodes = [...]
# create the pack
chroma_pack = ChromaAutoretrievalPack(
collection_name="test",
vector_store_info=vector_store_index,
nodes=nodes,
client=client,
)
```
The `run()` function is a light wrapper around `query_engine.query()`.
```python
response = chroma_pack.run("Tell me a bout a Music celebritiy.")
```
You can also use modules individually.
```python
# use the retreiver
retriever = chroma_pack.retriever
nodes = retriever.retrieve("query_str")
# use the query engine
query_engine = chroma_pack.query_engine
response = query_engine.query("query_str")
```
Raw data
{
"_id": null,
"home_page": "",
"name": "llama-index-packs-chroma-autoretrieval",
"maintainer": "logan-markewich",
"docs_url": null,
"requires_python": ">=3.8.1,<3.12",
"maintainer_email": "",
"keywords": "chroma,retrieval,vector",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/72/8c/929b270d4f3bab16794cd3633a84bec3ce32511dfa63898b5fabd80df230/llama_index_packs_chroma_autoretrieval-0.1.2.tar.gz",
"platform": null,
"description": "# Chroma AutoRetrieval Pack\n\nThis LlamaPack inserts your data into chroma and insantiates an auto-retriever, which will use the LLM at runtime to set metadata filtering, top-k, and query string.\n\n## CLI Usage\n\nYou can download llamapacks directly using `llamaindex-cli`, which comes installed with the `llama-index` python package:\n\n```bash\nllamaindex-cli download-llamapack ChromaAutoretrievalPack --download-dir ./chroma_pack\n```\n\nYou can then inspect the files at `./chroma_pack` and use them as a template for your own project!\n\n## Code Usage\n\nYou can download the pack to a the `./chroma_pack` directory:\n\n```python\nfrom llama_index.core.llama_pack import download_llama_pack\n\n# download and install dependencies\nChromaAutoretrievalPack = download_llama_pack(\n \"ChromaAutoretrievalPack\", \"./chroma_pack\"\n)\n```\n\nFrom here, you can use the pack, or inspect and modify the pack in `./chroma_pack`.\n\nThen, you can set up the pack like so:\n\n```python\n# setup pack arguments\nfrom llama_index.core.vector_stores.types import MetadataInfo, VectorStoreInfo\n\nvector_store_info = VectorStoreInfo(\n content_info=\"brief biography of celebrities\",\n metadata_info=[\n MetadataInfo(\n name=\"category\",\n type=\"str\",\n description=(\n \"Category of the celebrity, one of [Sports Entertainment, Business, Music]\"\n ),\n ),\n ],\n)\n\nimport chromadb\n\nclient = chromadb.EphemeralClient()\n\nnodes = [...]\n\n# create the pack\nchroma_pack = ChromaAutoretrievalPack(\n collection_name=\"test\",\n vector_store_info=vector_store_index,\n nodes=nodes,\n client=client,\n)\n```\n\nThe `run()` function is a light wrapper around `query_engine.query()`.\n\n```python\nresponse = chroma_pack.run(\"Tell me a bout a Music celebritiy.\")\n```\n\nYou can also use modules individually.\n\n```python\n# use the retreiver\nretriever = chroma_pack.retriever\nnodes = retriever.retrieve(\"query_str\")\n\n# use the query engine\nquery_engine = chroma_pack.query_engine\nresponse = query_engine.query(\"query_str\")\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index packs chroma_autoretrieval integration",
"version": "0.1.2",
"project_urls": null,
"split_keywords": [
"chroma",
"retrieval",
"vector"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bc63a6fa00fcbee37f94ad84df1c6d9ec4410c8ea49db296620fa33da511f3b4",
"md5": "2581f2ccc384109ea9f6537e4216a705",
"sha256": "4bb8d7ab87ce267087f7ea0a08fd940a96ada918f6bc27646c3400dd094870d1"
},
"downloads": -1,
"filename": "llama_index_packs_chroma_autoretrieval-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2581f2ccc384109ea9f6537e4216a705",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<3.12",
"size": 3541,
"upload_time": "2024-02-13T22:54:41",
"upload_time_iso_8601": "2024-02-13T22:54:41.338859Z",
"url": "https://files.pythonhosted.org/packages/bc/63/a6fa00fcbee37f94ad84df1c6d9ec4410c8ea49db296620fa33da511f3b4/llama_index_packs_chroma_autoretrieval-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "728c929b270d4f3bab16794cd3633a84bec3ce32511dfa63898b5fabd80df230",
"md5": "13a8331e91f7f0f44f4a366c73998184",
"sha256": "90942105fbd162290e69ba2dd54c80b53f77f40f2cfaa0bbdfd0c2814f59b77e"
},
"downloads": -1,
"filename": "llama_index_packs_chroma_autoretrieval-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "13a8331e91f7f0f44f4a366c73998184",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<3.12",
"size": 2978,
"upload_time": "2024-02-13T22:54:42",
"upload_time_iso_8601": "2024-02-13T22:54:42.308916Z",
"url": "https://files.pythonhosted.org/packages/72/8c/929b270d4f3bab16794cd3633a84bec3ce32511dfa63898b5fabd80df230/llama_index_packs_chroma_autoretrieval-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-13 22:54:42",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-packs-chroma-autoretrieval"
}
JSON