llama-index-readers-arango-db


Namellama-index-readers-arango-db JSON
Version 0.2.0 PyPI version JSON
download
home_pageNone
Summaryllama-index readers arango db integration
upload_time2024-08-22 05:45:56
maintainermmaatouk
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 Readers Integration: ArangoDB

```bash
pip install llama-index-readers-arango-db
```

This loader loads documents from [ArangoDB](https://github.com/arangodb/arangodb?tab=readme-ov-file#arangodb). The user specifies an ArangoDB instance to
initialize the reader. They then specify the collection name and query parameters to
fetch the relevant docs.

## Usage

Here's an example usage of the SimpleArangoDBReader.

```python
import os

from llama_index.readers.arango_db import SimpleArangoDBReader

host = "<host>"
db_name = "<db_name>"
collection_name = "<collection_name>"
# query_dict is passed into db.collection.find()
query_dict = {}
# Attribute of interests to load, by default ["text"]
field_names = ["title", "description"]
reader = SimpleArangoDBReader(host)  # or pass ArangoClient
documents = reader.load_data(
    username,
    password,
    db_name,
    collection_name,
    query_dict=query_dict,
    field_names=field_names,
)
```

A demo notebook is available [here](https://colab.research.google.com/github/arangodb/interactive_tutorials/blob/master/notebooks/example_output/Langchain_Full_output.ipynb).

This loader is designed to be used as a way to load data into [LlamaIndex](https://github.com/run-llama/llama_index/).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "llama-index-readers-arango-db",
    "maintainer": "mmaatouk",
    "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/b2/76/d9d1303f1755dc0a49efea5e9c8d24ffeb5e389b0006e0baad4e75fee094/llama_index_readers_arango_db-0.2.0.tar.gz",
    "platform": null,
    "description": "# LlamaIndex Readers Integration: ArangoDB\n\n```bash\npip install llama-index-readers-arango-db\n```\n\nThis loader loads documents from [ArangoDB](https://github.com/arangodb/arangodb?tab=readme-ov-file#arangodb). The user specifies an ArangoDB instance to\ninitialize the reader. They then specify the collection name and query parameters to\nfetch the relevant docs.\n\n## Usage\n\nHere's an example usage of the SimpleArangoDBReader.\n\n```python\nimport os\n\nfrom llama_index.readers.arango_db import SimpleArangoDBReader\n\nhost = \"<host>\"\ndb_name = \"<db_name>\"\ncollection_name = \"<collection_name>\"\n# query_dict is passed into db.collection.find()\nquery_dict = {}\n# Attribute of interests to load, by default [\"text\"]\nfield_names = [\"title\", \"description\"]\nreader = SimpleArangoDBReader(host)  # or pass ArangoClient\ndocuments = reader.load_data(\n    username,\n    password,\n    db_name,\n    collection_name,\n    query_dict=query_dict,\n    field_names=field_names,\n)\n```\n\nA demo notebook is available [here](https://colab.research.google.com/github/arangodb/interactive_tutorials/blob/master/notebooks/example_output/Langchain_Full_output.ipynb).\n\nThis loader is designed to be used as a way to load data into [LlamaIndex](https://github.com/run-llama/llama_index/).\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "llama-index readers arango db integration",
    "version": "0.2.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f92199e16ff5bd2e54b37c73606830f99fb917f48cce9cf04c545d6238e56005",
                "md5": "401d178529e52ac8ab956293f6694d9e",
                "sha256": "fee009cb55f1fc523a2986c51699c2f8c8534c2b96967ba10334f0101ea3f2b9"
            },
            "downloads": -1,
            "filename": "llama_index_readers_arango_db-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "401d178529e52ac8ab956293f6694d9e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8.1",
            "size": 3564,
            "upload_time": "2024-08-22T05:45:55",
            "upload_time_iso_8601": "2024-08-22T05:45:55.442802Z",
            "url": "https://files.pythonhosted.org/packages/f9/21/99e16ff5bd2e54b37c73606830f99fb917f48cce9cf04c545d6238e56005/llama_index_readers_arango_db-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b276d9d1303f1755dc0a49efea5e9c8d24ffeb5e389b0006e0baad4e75fee094",
                "md5": "d261be7bd56c7c167f7ffbf95f118588",
                "sha256": "7708c3b39925438be17161d5d37f3c4a28d3ce33f82c3d2354ccc28aca7d0c9d"
            },
            "downloads": -1,
            "filename": "llama_index_readers_arango_db-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d261be7bd56c7c167f7ffbf95f118588",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8.1",
            "size": 3242,
            "upload_time": "2024-08-22T05:45:56",
            "upload_time_iso_8601": "2024-08-22T05:45:56.395463Z",
            "url": "https://files.pythonhosted.org/packages/b2/76/d9d1303f1755dc0a49efea5e9c8d24ffeb5e389b0006e0baad4e75fee094/llama_index_readers_arango_db-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-22 05:45:56",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "llama-index-readers-arango-db"
}
        
Elapsed time: 0.57910s