Skip to content

Commit 5cb596e

Browse files
authored
Rename neo4j-genai references to neo4j-graphrag (#130)
* Sunset neo4j-genai package * Rename references to neo4j-genai to neo4j-graphrag * Readded suffixes to neo4j-graphrag-python * Update pyproject * Update neo4j_genai in documentation to neo4j_graphrag * Removed warning in neo4j_graphrag's init * Ruff formatting + rename neo4j-genai in User Guide * Poetry lock * Revert test_orchestrator * Update CHANGELOG
1 parent c60844f commit 5cb596e

File tree

128 files changed

+684
-657
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

128 files changed

+684
-657
lines changed

.github/workflows/minor-release.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jobs:
3939
sed -i.bak -e 's/## Next/## Next\n\n## ${{ steps.get-version.outputs.version }}/' CHANGELOG.md && rm CHANGELOG.md.bak
4040
- uses: EndBug/add-and-commit@v9
4141
with:
42-
author_name: 'Neo4j-GenAI GitHub Action'
42+
author_name: 'Neo4j-GraphRAG GitHub Action'
4343
author_email: 'team-gen-ai@neo4j.com'
4444
message: 'Bump version to ${{ steps.get-version.outputs.version }}'
4545
add: "['pyproject.toml', 'CHANGELOG.md']"

.github/workflows/patch-release.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jobs:
3939
sed -i.bak -e 's/## Next/## Next\n\n## ${{ steps.get-version.outputs.version }}/' CHANGELOG.md && rm CHANGELOG.md.bak
4040
- uses: EndBug/add-and-commit@v9
4141
with:
42-
author_name: 'Neo4j-GenAI GitHub Action'
42+
author_name: 'Neo4j-GraphRAG GitHub Action'
4343
author_email: 'team-gen-ai@neo4j.com'
4444
message: 'Bump version to ${{ steps.get-version.outputs.version }}'
4545
add: "['pyproject.toml', 'CHANGELOG.md']"

.github/workflows/pr-e2e-tests.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: 'Neo4j-GenAI PR E2E Tests'
1+
name: 'Neo4j-GraphRAG PR E2E Tests'
22

33
on:
44
pull_request:

.github/workflows/pr.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: neo4j_genai PR
1+
name: neo4j_graphrag PR
22
on: pull_request
33

44
jobs:

.github/workflows/scheduled-e2e-tests.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: 'Neo4j-GenAI Scheduled E2E Tests'
1+
name: 'Neo4j-GraphRAG Scheduled E2E Tests'
22

33
on:
44
schedule:

CHANGELOG.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1-
# @neo4j/neo4j-genai-python
1+
# @neo4j/neo4j-graphrag-python
22

33
## Next
44

5+
### Changed
6+
- Officially renamed neo4j-genai to neo4j-graphrag. For the final release version of neo4j-genai, please visit https://pypi.org/project/neo4j-genai/.
7+
58
## 0.6.0
69

710
### IMPORTANT NOTICE
@@ -51,7 +54,7 @@
5154
- Stopped embeddings from being returned when searching with `VectorRetriever`. Added `nodeLabels` and `id` to the metadata of `VectorRetriever` results.
5255
- Added `upsert_vector` utility function for attaching vectors to node properties.
5356
- Introduced `Neo4jInsertionError` for handling insertion failures in Neo4j.
54-
- Included Pinecone and Weaviate retrievers in neo4j_genai.retrievers.
57+
- Included Pinecone and Weaviate retrievers in neo4j_graphrag.retrievers.
5558
- Introduced the GraphRAG object, enabling a full RAG (Retrieval-Augmented Generation) pipeline with context retrieval, prompt formatting, and answer generation.
5659
- Added PromptTemplate and RagTemplate for customizable prompt generation.
5760
- Added LLMInterface with implementation for OpenAI LLM.
@@ -62,7 +65,7 @@
6265
- Introduced result_formatter argument to all retrievers, allowing custom formatting of retriever results.
6366

6467
### Changed
65-
- Refactored import paths for retrievers to neo4j_genai.retrievers.
68+
- Refactored import paths for retrievers to neo4j_graphrag.retrievers.
6669
- Implemented exception chaining for all re-raised exceptions to improve stack trace readability.
6770
- Made error messages in `index.py` more consistent.
6871
- Renamed `Retriever._get_search_results` to `Retriever.get_search_results`

README.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
1-
# ⚠️ Deprecation Warning ⚠️
2-
3-
This package `neo4j-genai` is deprecated and will no longer be maintained. Please switch to our new package `neo4j-graphrag`, which is available at [neo4j-graphrag on GitHub](https://github.com/neo4j/neo4j-graphrag-python) and [neo4j-graphrag on PyPI](https://pypi.org/project/neo4j-graphrag/).
4-
5-
`neo4j-graphrag` is a renamed continuation of this package. We encourage all users to migrate to the new package to continue receiving updates and support.
6-
7-
# Neo4j GenAI package for Python
1+
# Neo4j GraphRAG package for Python
82

93
This repository contains the official Neo4j GenAI features for Python.
104

@@ -31,7 +25,7 @@ This package requires Python (>=3.8.1).
3125
To install the latest stable version, use:
3226

3327
```shell
34-
pip install neo4j-genai
28+
pip install neo4j-graphrag
3529
```
3630

3731
## Examples
@@ -44,7 +38,7 @@ Assumption: Neo4j running
4438

4539
```python
4640
from neo4j import GraphDatabase
47-
from neo4j_genai.indexes import create_vector_index
41+
from neo4j_graphrag.indexes import create_vector_index
4842

4943
URI = "neo4j://localhost:7687"
5044
AUTH = ("neo4j", "password")
@@ -74,7 +68,7 @@ Assumption: Neo4j running with a defined vector index
7468

7569
```python
7670
from neo4j import GraphDatabase
77-
from neo4j_genai.indexes import upsert_vector
71+
from neo4j_graphrag.indexes import upsert_vector
7872

7973
URI = "neo4j://localhost:7687"
8074
AUTH = ("neo4j", "password")
@@ -106,10 +100,10 @@ in Neo4j.
106100

107101
```python
108102
from neo4j import GraphDatabase
109-
from neo4j_genai.retrievers import VectorRetriever
110-
from neo4j_genai.llm import OpenAILLM
111-
from neo4j_genai.generation import GraphRAG
112-
from neo4j_genai.embeddings.openai import OpenAIEmbeddings
103+
from neo4j_graphrag.retrievers import VectorRetriever
104+
from neo4j_graphrag.llm import OpenAILLM
105+
from neo4j_graphrag.generation import GraphRAG
106+
from neo4j_graphrag.embeddings.openai import OpenAIEmbeddings
113107

114108
URI = "neo4j://localhost:7687"
115109
AUTH = ("neo4j", "password")

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
# You can set these variables from the command line.
55
VERSION = SNAPSHOT
6-
PRODUCT = neo4j-genai-python
6+
PRODUCT = neo4j-graphrag-python
77
SPHINXOPTS =
88
SPHINXBUILD = poetry run sphinx-build
99
PAPER =

0 commit comments

Comments
 (0)