# Multi-Tenancy RAG Pack
Create a Multi-Tenancy RAG using VectorStoreIndex.
## CLI Usage
You can download llamapacks directly using `llamaindex-cli`, which comes installed with the `llama-index` python package:
```bash
llamaindex-cli download-llamapack MultiTenancyRAGPack --download-dir ./multitenancy_rag_pack
```
You can then inspect the files at `./multitenancy_rag_pack` and use them as a template for your own project.
## Code Usage
You can download the pack to a the `./multitenancy_rag_pack` directory:
```python
from llama_index.core.llama_pack import download_llama_pack
# download and install dependencies
MultiTenancyRAGPack = download_llama_pack(
"MultiTenancyRAGPack", "./multitenancy_rag_pack"
)
# You can use any llama-hub loader to get documents and add them to index for a user!
multitenancy_rag_pack = MultiTenancyRAGPack()
multitenancy_rag_pack.add(documents, "<user>")
```
From here, you can use the pack, or inspect and modify the pack in `./multitenancy_rag_pack`.
The `run()` function is a light wrapper around `index.as_query_engine().query()`.
```python
response = multitenancy_rag_pack.run(
"<user query>", user="<user>", similarity_top_k=2
)
```
You can also use modules individually.
```python
# Use the index directly
index = multitenancy_rag_pack.index
query_engine = index.as_query_engine(
filters=MetadataFilters(
filters=[
ExactMatchFilter(
key="user",
value="<user>",
)
]
)
)
retriever = index.as_retriever(
filters=MetadataFilters(
filters=[
ExactMatchFilter(
key="user",
value="<user>",
)
]
)
)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "llama-index-packs-multi-tenancy-rag",
"maintainer": "ravi03071991",
"docs_url": null,
"requires_python": "<4.0,>=3.8.1",
"maintainer_email": null,
"keywords": "multi, multi-tenancy, rag, tenancy",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/1f/2f/b9d3e2121cc41282ed9cc210e02ffc8a6456bb336f5998c11dd1167dfe4b/llama_index_packs_multi_tenancy_rag-0.3.0.tar.gz",
"platform": null,
"description": "# Multi-Tenancy RAG Pack\n\nCreate a Multi-Tenancy RAG using VectorStoreIndex.\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 MultiTenancyRAGPack --download-dir ./multitenancy_rag_pack\n```\n\nYou can then inspect the files at `./multitenancy_rag_pack` and use them as a template for your own project.\n\n## Code Usage\n\nYou can download the pack to a the `./multitenancy_rag_pack` directory:\n\n```python\nfrom llama_index.core.llama_pack import download_llama_pack\n\n# download and install dependencies\nMultiTenancyRAGPack = download_llama_pack(\n \"MultiTenancyRAGPack\", \"./multitenancy_rag_pack\"\n)\n\n# You can use any llama-hub loader to get documents and add them to index for a user!\nmultitenancy_rag_pack = MultiTenancyRAGPack()\nmultitenancy_rag_pack.add(documents, \"<user>\")\n```\n\nFrom here, you can use the pack, or inspect and modify the pack in `./multitenancy_rag_pack`.\n\nThe `run()` function is a light wrapper around `index.as_query_engine().query()`.\n\n```python\nresponse = multitenancy_rag_pack.run(\n \"<user query>\", user=\"<user>\", similarity_top_k=2\n)\n```\n\nYou can also use modules individually.\n\n```python\n# Use the index directly\nindex = multitenancy_rag_pack.index\nquery_engine = index.as_query_engine(\n filters=MetadataFilters(\n filters=[\n ExactMatchFilter(\n key=\"user\",\n value=\"<user>\",\n )\n ]\n )\n)\nretriever = index.as_retriever(\n filters=MetadataFilters(\n filters=[\n ExactMatchFilter(\n key=\"user\",\n value=\"<user>\",\n )\n ]\n )\n)\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index packs multi_tenancy_rag integration",
"version": "0.3.0",
"project_urls": null,
"split_keywords": [
"multi",
" multi-tenancy",
" rag",
" tenancy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "99860b0145b12f8c45c02d09ff7ee90673f6e3298fc1d626502f0df87fec7d6d",
"md5": "18113a21cc842af3e58d6cb0d75e7245",
"sha256": "be7a2fe698ec3372f5582010272f540bf3b34970899223131dedc9c2d750ecf8"
},
"downloads": -1,
"filename": "llama_index_packs_multi_tenancy_rag-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "18113a21cc842af3e58d6cb0d75e7245",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8.1",
"size": 3202,
"upload_time": "2024-08-22T17:38:51",
"upload_time_iso_8601": "2024-08-22T17:38:51.081546Z",
"url": "https://files.pythonhosted.org/packages/99/86/0b0145b12f8c45c02d09ff7ee90673f6e3298fc1d626502f0df87fec7d6d/llama_index_packs_multi_tenancy_rag-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1f2fb9d3e2121cc41282ed9cc210e02ffc8a6456bb336f5998c11dd1167dfe4b",
"md5": "b2c740d23a2520d908bfb48757e24974",
"sha256": "2e2822c84820a157293bc0a9e721141dae41317d7bc7364b378b61019cc8b52b"
},
"downloads": -1,
"filename": "llama_index_packs_multi_tenancy_rag-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "b2c740d23a2520d908bfb48757e24974",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8.1",
"size": 2877,
"upload_time": "2024-08-22T17:38:52",
"upload_time_iso_8601": "2024-08-22T17:38:52.531397Z",
"url": "https://files.pythonhosted.org/packages/1f/2f/b9d3e2121cc41282ed9cc210e02ffc8a6456bb336f5998c11dd1167dfe4b/llama_index_packs_multi_tenancy_rag-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-22 17:38:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-packs-multi-tenancy-rag"
}
JSON