| Name | llama-index-readers-dashvector JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | None |
| Summary | llama-index readers dashvector integration |
| upload_time | 2024-09-16 16:32:02 |
| maintainer | None |
| 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: Dashvector
## Overview
DashVector Reader is a tool designed to retrieve documents from DashVector clusters efficiently.
### Installation
You can install DashVector Reader via pip:
```bash
pip install llama-index-readers-dashvector
```
To use DashVector, you must have an API key. Here are the [installation instructions](https://help.aliyun.com/document_detail/2510223.html)
## Usage
```python
from llama_index.core.schema import Document
from llama_index.readers.dashvector import DashVectorReader
# Initialize DashVectorReader with the API key and cluster endpoint
reader = DashVectorReader(
api_key="<Your API Key>", endpoint="<Cluster Endpoint>"
)
# Load data from DashVector
documents = reader.load_data(
collection_name="<Collection Name>",
vector=[0.1, 0.2, 0.3], # Query vector
topk=10, # Number of results to return
separate_documents=True, # Whether to return separate documents
filter=None, # Optional: Filter conditions
include_vector=True, # Whether to include the embedding in the response
output_fields=None, # Optional: Fields Filter
)
```
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-dashvector",
"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/ea/8c/eef4ecf71dc99d4ab6afc5cf050b3aea03a9d7c47c8f77c1d1f9c83bf8f7/llama_index_readers_dashvector-0.3.0.tar.gz",
"platform": null,
"description": "# LlamaIndex Readers Integration: Dashvector\n\n## Overview\n\nDashVector Reader is a tool designed to retrieve documents from DashVector clusters efficiently.\n\n### Installation\n\nYou can install DashVector Reader via pip:\n\n```bash\npip install llama-index-readers-dashvector\n```\n\nTo use DashVector, you must have an API key. Here are the [installation instructions](https://help.aliyun.com/document_detail/2510223.html)\n\n## Usage\n\n```python\nfrom llama_index.core.schema import Document\nfrom llama_index.readers.dashvector import DashVectorReader\n\n# Initialize DashVectorReader with the API key and cluster endpoint\nreader = DashVectorReader(\n api_key=\"<Your API Key>\", endpoint=\"<Cluster Endpoint>\"\n)\n\n# Load data from DashVector\ndocuments = reader.load_data(\n collection_name=\"<Collection Name>\",\n vector=[0.1, 0.2, 0.3], # Query vector\n topk=10, # Number of results to return\n separate_documents=True, # Whether to return separate documents\n filter=None, # Optional: Filter conditions\n include_vector=True, # Whether to include the embedding in the response\n output_fields=None, # Optional: Fields Filter\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 dashvector integration",
"version": "0.3.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1a7e8dabef94ee5e36b9114b0bcfc27f0b5b842a1ee7d6b2983f0df3052d4bc2",
"md5": "4053db720511911d158020ad41b8afc5",
"sha256": "b49aa59c3c0c1c2b1d76fb980370414ea7212131bc749704b495f4226a1c5b7c"
},
"downloads": -1,
"filename": "llama_index_readers_dashvector-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4053db720511911d158020ad41b8afc5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8.1",
"size": 3334,
"upload_time": "2024-09-16T16:32:01",
"upload_time_iso_8601": "2024-09-16T16:32:01.190658Z",
"url": "https://files.pythonhosted.org/packages/1a/7e/8dabef94ee5e36b9114b0bcfc27f0b5b842a1ee7d6b2983f0df3052d4bc2/llama_index_readers_dashvector-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ea8ceef4ecf71dc99d4ab6afc5cf050b3aea03a9d7c47c8f77c1d1f9c83bf8f7",
"md5": "48a364916720a94b07b8e57c434662f6",
"sha256": "bce6be4f2b397dde2830ace5b3cdaafc860d9ce12a2b8f2193950b3005478b99"
},
"downloads": -1,
"filename": "llama_index_readers_dashvector-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "48a364916720a94b07b8e57c434662f6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8.1",
"size": 2883,
"upload_time": "2024-09-16T16:32:02",
"upload_time_iso_8601": "2024-09-16T16:32:02.377819Z",
"url": "https://files.pythonhosted.org/packages/ea/8c/eef4ecf71dc99d4ab6afc5cf050b3aea03a9d7c47c8f77c1d1f9c83bf8f7/llama_index_readers_dashvector-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-16 16:32:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-readers-dashvector"
}
