| Name | llama-index-readers-chroma JSON |
| Version |
0.1.4
JSON |
| download |
| home_page | None |
| Summary | llama-index readers chroma integration |
| upload_time | 2024-05-02 17:04:39 |
| maintainer | atroyn |
| docs_url | None |
| author | Your Name |
| requires_python | <4.0,>=3.8.1 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# LlamaIndex Readers Integration: Chroma
## Overview
Chroma Reader is a tool designed to retrieve documents from existing persisted Chroma collections. Chroma is a framework for managing document collections and their associated embeddings efficiently.
### Installation
You can install Chroma Reader via pip:
```bash
pip install llama-index-readers-chroma
```
## Usage
```python
from llama_index.core.schema import Document
from llama_index.readers.chroma import ChromaReader
# Initialize ChromaReader with the collection name and optional parameters
reader = ChromaReader(
collection_name="<Your Collection Name>",
persist_directory="<Directory Path>", # Optional: Directory where the collection is persisted
chroma_api_impl="rest", # Optional: Chroma API implementation (default: "rest")
chroma_db_impl=None, # Optional: Chroma DB implementation (default: None)
host="localhost", # Optional: Host for Chroma DB (default: "localhost")
port=8000, # Optional: Port for Chroma DB (default: 8000)
)
# Load data from Chroma collection
documents = reader.load_data(
query_embedding=None, # Provide query embedding if searching by embeddings
limit=10, # Number of results to retrieve
where=None, # Filter condition for metadata
where_document=None, # Filter condition for document
query=["search term"], # Provide query text if searching by text
)
```
This loader is designed to be used as a way to load data into
[LlamaIndex](https://github.com/run-llama/llama_index/tree/main/llama_index) and/or subsequently
used as a Tool in a [LangChain](https://github.com/hwchase17/langchain) Agent.
Raw data
{
"_id": null,
"home_page": null,
"name": "llama-index-readers-chroma",
"maintainer": "atroyn",
"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/9c/0b/6b8e1f275f46190470a04703ca77b8ff096260788635dcb3d6e75d87ac09/llama_index_readers_chroma-0.1.4.tar.gz",
"platform": null,
"description": "# LlamaIndex Readers Integration: Chroma\n\n## Overview\n\nChroma Reader is a tool designed to retrieve documents from existing persisted Chroma collections. Chroma is a framework for managing document collections and their associated embeddings efficiently.\n\n### Installation\n\nYou can install Chroma Reader via pip:\n\n```bash\npip install llama-index-readers-chroma\n```\n\n## Usage\n\n```python\nfrom llama_index.core.schema import Document\nfrom llama_index.readers.chroma import ChromaReader\n\n# Initialize ChromaReader with the collection name and optional parameters\nreader = ChromaReader(\n collection_name=\"<Your Collection Name>\",\n persist_directory=\"<Directory Path>\", # Optional: Directory where the collection is persisted\n chroma_api_impl=\"rest\", # Optional: Chroma API implementation (default: \"rest\")\n chroma_db_impl=None, # Optional: Chroma DB implementation (default: None)\n host=\"localhost\", # Optional: Host for Chroma DB (default: \"localhost\")\n port=8000, # Optional: Port for Chroma DB (default: 8000)\n)\n\n# Load data from Chroma collection\ndocuments = reader.load_data(\n query_embedding=None, # Provide query embedding if searching by embeddings\n limit=10, # Number of results to retrieve\n where=None, # Filter condition for metadata\n where_document=None, # Filter condition for document\n query=[\"search term\"], # Provide query text if searching by text\n)\n```\n\nThis loader is designed to be used as a way to load data into\n[LlamaIndex](https://github.com/run-llama/llama_index/tree/main/llama_index) and/or subsequently\nused as a Tool in a [LangChain](https://github.com/hwchase17/langchain) Agent.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index readers chroma integration",
"version": "0.1.4",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b6a23dc6f8b50aea888afe30655599793e2fda55088e35da6dbecbf372d878e5",
"md5": "df1fc19c4d39595fe289f74ff9b57cb0",
"sha256": "e9a2f27fdba48635da69afac9c13a8e93e11e23ab1fa469353871dff75263827"
},
"downloads": -1,
"filename": "llama_index_readers_chroma-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "df1fc19c4d39595fe289f74ff9b57cb0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8.1",
"size": 3388,
"upload_time": "2024-05-02T17:04:37",
"upload_time_iso_8601": "2024-05-02T17:04:37.510074Z",
"url": "https://files.pythonhosted.org/packages/b6/a2/3dc6f8b50aea888afe30655599793e2fda55088e35da6dbecbf372d878e5/llama_index_readers_chroma-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9c0b6b8e1f275f46190470a04703ca77b8ff096260788635dcb3d6e75d87ac09",
"md5": "db0bab98f68db148869a13b4cb1dfb39",
"sha256": "509b6ade3c0f4c402bd4c060597bf538fc583280a0a7da88ab743e48f3001632"
},
"downloads": -1,
"filename": "llama_index_readers_chroma-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "db0bab98f68db148869a13b4cb1dfb39",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8.1",
"size": 3007,
"upload_time": "2024-05-02T17:04:39",
"upload_time_iso_8601": "2024-05-02T17:04:39.541987Z",
"url": "https://files.pythonhosted.org/packages/9c/0b/6b8e1f275f46190470a04703ca77b8ff096260788635dcb3d6e75d87ac09/llama_index_readers_chroma-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-02 17:04:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-readers-chroma"
}
