# Neo4j Query Engine Pack
This LlamaPack creates a Neo4j query engine, and executes its `query` function. This pack offers the option of creating multiple types of query engines, namely:
- Knowledge graph vector-based entity retrieval (default if no query engine type option is provided)
- Knowledge graph keyword-based entity retrieval
- Knowledge graph hybrid entity retrieval
- Raw vector index retrieval
- Custom combo query engine (vector similarity + KG entity retrieval)
- KnowledgeGraphQueryEngine
- KnowledgeGraphRAGRetriever
## CLI Usage
You can download llamapacks directly using `llamaindex-cli`, which comes installed with the `llama-index` python package:
```bash
llamaindex-cli download-llamapack Neo4jQueryEnginePack --download-dir ./neo4j_pack
```
You can then inspect the files at `./neo4j_pack` and use them as a template for your own project!
## Code Usage
You can download the pack to a `./neo4j_pack` directory:
```python
from llama_index.core.llama_pack import download_llama_pack
# download and install dependencies
Neo4jQueryEnginePack = download_llama_pack(
"Neo4jQueryEnginePack", "./neo4j_pack"
)
```
From here, you can use the pack, or inspect and modify the pack in `./neo4j_pack`.
Then, you can set up the pack like so:
```python
# Load the docs (example of Paleo diet from Wikipedia)
from llama_index import download_loader
WikipediaReader = download_loader("WikipediaReader")
loader = WikipediaReader()
docs = loader.load_data(pages=["Paleolithic diet"], auto_suggest=False)
print(f"Loaded {len(docs)} documents")
# get Neo4j credentials (assume it's stored in credentials.json)
with open("credentials.json") as f:
neo4j_connection_params = json.load(f)
username = neo4j_connection_params["username"]
password = neo4j_connection_params["password"]
url = neo4j_connection_params["url"]
database = neo4j_connection_params["database"]
# create the pack
neo4j_pack = Neo4jQueryEnginePack(
username=username, password=password, url=url, database=database, docs=docs
)
```
Optionally, you can pass in the `query_engine_type` from `Neo4jQueryEngineType` to construct `Neo4jQueryEnginePack`. If `query_engine_type` is not defined, it defaults to Knowledge Graph vector based entity retrieval.
```python
from llama_index.packs.neo4j_query_engine.base import Neo4jQueryEngineType
# create the pack
neo4j_pack = Neo4jQueryEnginePack(
username=username,
password=password,
url=url,
database=database,
docs=docs,
query_engine_type=Neo4jQueryEngineType.KG_HYBRID,
)
```
`Neo4jQueryEnginePack` is a enum defined as follows:
```python
class Neo4jQueryEngineType(str, Enum):
"""Neo4j query engine type"""
KG_KEYWORD = "keyword"
KG_HYBRID = "hybrid"
RAW_VECTOR = "vector"
RAW_VECTOR_KG_COMBO = "vector_kg"
KG_QE = "KnowledgeGraphQueryEngine"
KG_RAG_RETRIEVER = "KnowledgeGraphRAGRetriever"
```
The `run()` function is a light wrapper around `query_engine.query()`, see a sample query below.
```python
response = neo4j_pack.run("Tell me about the benefits of paleo diet.")
```
You can also use modules individually.
```python
# call the query_engine.query()
query_engine = neo4j_pack.query_engine
response = query_engine.query("query_str")
```
Raw data
{
"_id": null,
"home_page": "",
"name": "llama-index-packs-neo4j-query-engine",
"maintainer": "wenqiglantz",
"docs_url": null,
"requires_python": ">=3.8.1,<4.0",
"maintainer_email": "",
"keywords": "knowledge graph,neo4j,query engine",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/5f/d8/3dddfef71b50a2a4c81114df7c86815580b17ba04f3b167d67ed12cdefd8/llama_index_packs_neo4j_query_engine-0.1.3.tar.gz",
"platform": null,
"description": "# Neo4j Query Engine Pack\n\nThis LlamaPack creates a Neo4j query engine, and executes its `query` function. This pack offers the option of creating multiple types of query engines, namely:\n\n- Knowledge graph vector-based entity retrieval (default if no query engine type option is provided)\n- Knowledge graph keyword-based entity retrieval\n- Knowledge graph hybrid entity retrieval\n- Raw vector index retrieval\n- Custom combo query engine (vector similarity + KG entity retrieval)\n- KnowledgeGraphQueryEngine\n- KnowledgeGraphRAGRetriever\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 Neo4jQueryEnginePack --download-dir ./neo4j_pack\n```\n\nYou can then inspect the files at `./neo4j_pack` and use them as a template for your own project!\n\n## Code Usage\n\nYou can download the pack to a `./neo4j_pack` directory:\n\n```python\nfrom llama_index.core.llama_pack import download_llama_pack\n\n# download and install dependencies\nNeo4jQueryEnginePack = download_llama_pack(\n \"Neo4jQueryEnginePack\", \"./neo4j_pack\"\n)\n```\n\nFrom here, you can use the pack, or inspect and modify the pack in `./neo4j_pack`.\n\nThen, you can set up the pack like so:\n\n```python\n# Load the docs (example of Paleo diet from Wikipedia)\nfrom llama_index import download_loader\n\nWikipediaReader = download_loader(\"WikipediaReader\")\nloader = WikipediaReader()\ndocs = loader.load_data(pages=[\"Paleolithic diet\"], auto_suggest=False)\nprint(f\"Loaded {len(docs)} documents\")\n\n# get Neo4j credentials (assume it's stored in credentials.json)\nwith open(\"credentials.json\") as f:\n neo4j_connection_params = json.load(f)\n username = neo4j_connection_params[\"username\"]\n password = neo4j_connection_params[\"password\"]\n url = neo4j_connection_params[\"url\"]\n database = neo4j_connection_params[\"database\"]\n\n# create the pack\nneo4j_pack = Neo4jQueryEnginePack(\n username=username, password=password, url=url, database=database, docs=docs\n)\n```\n\nOptionally, you can pass in the `query_engine_type` from `Neo4jQueryEngineType` to construct `Neo4jQueryEnginePack`. If `query_engine_type` is not defined, it defaults to Knowledge Graph vector based entity retrieval.\n\n```python\nfrom llama_index.packs.neo4j_query_engine.base import Neo4jQueryEngineType\n\n# create the pack\nneo4j_pack = Neo4jQueryEnginePack(\n username=username,\n password=password,\n url=url,\n database=database,\n docs=docs,\n query_engine_type=Neo4jQueryEngineType.KG_HYBRID,\n)\n```\n\n`Neo4jQueryEnginePack` is a enum defined as follows:\n\n```python\nclass Neo4jQueryEngineType(str, Enum):\n \"\"\"Neo4j query engine type\"\"\"\n\n KG_KEYWORD = \"keyword\"\n KG_HYBRID = \"hybrid\"\n RAW_VECTOR = \"vector\"\n RAW_VECTOR_KG_COMBO = \"vector_kg\"\n KG_QE = \"KnowledgeGraphQueryEngine\"\n KG_RAG_RETRIEVER = \"KnowledgeGraphRAGRetriever\"\n```\n\nThe `run()` function is a light wrapper around `query_engine.query()`, see a sample query below.\n\n```python\nresponse = neo4j_pack.run(\"Tell me about the benefits of paleo diet.\")\n```\n\nYou can also use modules individually.\n\n```python\n# call the query_engine.query()\nquery_engine = neo4j_pack.query_engine\nresponse = query_engine.query(\"query_str\")\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index packs neo4j_query_engine integration",
"version": "0.1.3",
"project_urls": null,
"split_keywords": [
"knowledge graph",
"neo4j",
"query engine"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "35e23c6e7e31f053121e575cbaa193977fa3fd1e956eeebb9960c9c0ed487c4b",
"md5": "b8b6ff842719db66369fcebf191d4660",
"sha256": "1491a107cb0d48b301306a6a47fa387a04c9c08fb1db889f7fc0c1f425ef925e"
},
"downloads": -1,
"filename": "llama_index_packs_neo4j_query_engine-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b8b6ff842719db66369fcebf191d4660",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<4.0",
"size": 4830,
"upload_time": "2024-02-22T01:25:20",
"upload_time_iso_8601": "2024-02-22T01:25:20.435085Z",
"url": "https://files.pythonhosted.org/packages/35/e2/3c6e7e31f053121e575cbaa193977fa3fd1e956eeebb9960c9c0ed487c4b/llama_index_packs_neo4j_query_engine-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5fd83dddfef71b50a2a4c81114df7c86815580b17ba04f3b167d67ed12cdefd8",
"md5": "034f08270071e1b2cfff0af785775532",
"sha256": "6056439961324e4f2e7840744e492135fe7a4ee720a233f456a26222485f001d"
},
"downloads": -1,
"filename": "llama_index_packs_neo4j_query_engine-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "034f08270071e1b2cfff0af785775532",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<4.0",
"size": 4345,
"upload_time": "2024-02-22T01:25:23",
"upload_time_iso_8601": "2024-02-22T01:25:23.614360Z",
"url": "https://files.pythonhosted.org/packages/5f/d8/3dddfef71b50a2a4c81114df7c86815580b17ba04f3b167d67ed12cdefd8/llama_index_packs_neo4j_query_engine-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-22 01:25:23",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-packs-neo4j-query-engine"
}
JSON