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

.github/workflows/minor-release.yaml

@@ -39,7 +39,7 @@ jobs:
           sed -i.bak -e 's/## Next/## Next\n\n## ${{ steps.get-version.outputs.version }}/' CHANGELOG.md && rm CHANGELOG.md.bak
       - uses: EndBug/add-and-commit@v9
         with:
-          author_name: 'Neo4j-GenAI GitHub Action'
+          author_name: 'Neo4j-GraphRAG GitHub Action'
           author_email: '[email protected]'
           message: 'Bump version to ${{ steps.get-version.outputs.version }}'
           add: "['pyproject.toml', 'CHANGELOG.md']"

.github/workflows/patch-release.yaml

@@ -39,7 +39,7 @@ jobs:
           sed -i.bak -e 's/## Next/## Next\n\n## ${{ steps.get-version.outputs.version }}/' CHANGELOG.md && rm CHANGELOG.md.bak
       - uses: EndBug/add-and-commit@v9
         with:
-          author_name: 'Neo4j-GenAI GitHub Action'
+          author_name: 'Neo4j-GraphRAG GitHub Action'
           author_email: '[email protected]'
           message: 'Bump version to ${{ steps.get-version.outputs.version }}'
           add: "['pyproject.toml', 'CHANGELOG.md']"

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

@@ -1,4 +1,4 @@
-name: 'Neo4j-GenAI PR E2E Tests'
+name: 'Neo4j-GraphRAG PR E2E Tests'
 
 on:
   pull_request:

.github/workflows/pr.yaml

@@ -1,4 +1,4 @@
-name: neo4j_genai PR
+name: neo4j_graphrag PR
 on: pull_request
 
 jobs:

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

@@ -1,4 +1,4 @@
-name: 'Neo4j-GenAI Scheduled E2E Tests'
+name: 'Neo4j-GraphRAG Scheduled E2E Tests'
 
 on:
   schedule:

CHANGELOG.md

@@ -1,7 +1,10 @@
-# @neo4j/neo4j-genai-python
+# @neo4j/neo4j-graphrag-python
 
 ## Next
 
+### Changed
+- Officially renamed neo4j-genai to neo4j-graphrag. For the final release version of neo4j-genai, please visit https://pypi.org/project/neo4j-genai/.
+
 ## 0.6.0
 
 ### IMPORTANT NOTICE
@@ -51,7 +54,7 @@
 -   Stopped embeddings from being returned when searching with `VectorRetriever`. Added `nodeLabels` and `id` to the metadata of `VectorRetriever` results.
 -   Added `upsert_vector` utility function for attaching vectors to node properties.
 -   Introduced `Neo4jInsertionError` for handling insertion failures in Neo4j.
--   Included Pinecone and Weaviate retrievers in neo4j_genai.retrievers.
+-   Included Pinecone and Weaviate retrievers in neo4j_graphrag.retrievers.
 -   Introduced the GraphRAG object, enabling a full RAG (Retrieval-Augmented Generation) pipeline with context retrieval, prompt formatting, and answer generation.
 -   Added PromptTemplate and RagTemplate for customizable prompt generation.
 -   Added LLMInterface with implementation for OpenAI LLM.
@@ -62,7 +65,7 @@
 -   Introduced result_formatter argument to all retrievers, allowing custom formatting of retriever results.
 
 ### Changed
--   Refactored import paths for retrievers to neo4j_genai.retrievers.
+-   Refactored import paths for retrievers to neo4j_graphrag.retrievers.
 -   Implemented exception chaining for all re-raised exceptions to improve stack trace readability.
 -   Made error messages in `index.py` more consistent.
 -   Renamed `Retriever._get_search_results` to `Retriever.get_search_results`

README.md

@@ -1,10 +1,4 @@
-# ⚠️ Deprecation Warning ⚠️
-
-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/).
-
-`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.
-
-# Neo4j GenAI package for Python
+# Neo4j GraphRAG package for Python
 
 This repository contains the official Neo4j GenAI features for Python.
 
@@ -31,7 +25,7 @@ This package requires Python (>=3.8.1).
 To install the latest stable version, use:
 
 ```shell
-pip install neo4j-genai
+pip install neo4j-graphrag
 ```
 
 ## Examples
@@ -44,7 +38,7 @@ Assumption: Neo4j running
 
 ```python
 from neo4j import GraphDatabase
-from neo4j_genai.indexes import create_vector_index
+from neo4j_graphrag.indexes import create_vector_index
 
 URI = "neo4j://localhost:7687"
 AUTH = ("neo4j", "password")
@@ -74,7 +68,7 @@ Assumption: Neo4j running with a defined vector index
 
 ```python
 from neo4j import GraphDatabase
-from neo4j_genai.indexes import upsert_vector
+from neo4j_graphrag.indexes import upsert_vector
 
 URI = "neo4j://localhost:7687"
 AUTH = ("neo4j", "password")
@@ -106,10 +100,10 @@ in Neo4j.
 
 ```python
 from neo4j import GraphDatabase
-from neo4j_genai.retrievers import VectorRetriever
-from neo4j_genai.llm import OpenAILLM
-from neo4j_genai.generation import GraphRAG
-from neo4j_genai.embeddings.openai import OpenAIEmbeddings
+from neo4j_graphrag.retrievers import VectorRetriever
+from neo4j_graphrag.llm import OpenAILLM
+from neo4j_graphrag.generation import GraphRAG
+from neo4j_graphrag.embeddings.openai import OpenAIEmbeddings
 
 URI = "neo4j://localhost:7687"
 AUTH = ("neo4j", "password")

docs/Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line.
 VERSION       = SNAPSHOT
-PRODUCT       = neo4j-genai-python
+PRODUCT       = neo4j-graphrag-python
 SPHINXOPTS    =
 SPHINXBUILD   = poetry run sphinx-build
 PAPER         =