Minor fixes in README and documentation (#136)

* Minor fixes in README and documentation

* Renamed landing page to Introduction on toctree

* Rename possible_schema to potential_schema

* Changed examples/pipeline/schema.py to async

* Update CHANGELOG

Author: willtai

CHANGELOG.md

@@ -1,6 +1,12 @@
 # @neo4j/neo4j-graphrag-python
 
 ## Next
+### Changed
+- Updated documentation links in README.
+- Renamed deprecated package references in documentation.
+
+### Added
+- Introduction page to the documentation content tree.
 
 ### Added
 - Introduced a new Vertex AI embeddings class for generating text embeddings using Vertex AI.
@@ -9,6 +15,9 @@
 
 ## 0.6.2
 
+### Fixed
+- Moved pygraphviz to optional dependencies under [tool.poetry.extras] in pyproject.toml to resolve an issue where pip install neo4j-graphrag incorrectly required pygraphviz as a mandatory dependency.
+
 ## 0.6.1
 
 ### Changed

README.md

@@ -6,7 +6,7 @@ The purpose of this package is to provide a first party package to developers,
 where Neo4j can guarantee long term commitment and maintenance as well as being
 fast to ship new features and high performing patterns and methods.
 
-Documentation: https://neo4j.com/docs/neo4j-genai-python/
+Documentation: https://neo4j.com/docs/neo4j-graphrag-python/
 
 Python versions supported:
 

docs/source/index.rst

@@ -6,12 +6,16 @@
 Neo4j GraphRAG for Python
 =========================
 
-This repository contains the official Neo4j GraphRAG features for Python.
+This package contains the official Neo4j GraphRAG features for Python.
 
 The purpose of this package is to provide a first party package to developers,
 where Neo4j can guarantee long term commitment and maintenance as well as being
 fast to ship new features and high performing patterns and methods.
 
+⚠️ This package is a renamed continuation of `neo4j-genai`.
+The package `neo4j-genai` is deprecated and will no longer be maintained.
+We encourage all users to migrate to this new package to continue receiving updates and support.
+
 Neo4j versions supported:
 
 * Neo4j >=5.18.1
@@ -41,6 +45,7 @@ Topics
     :caption: Contents:
     :hidden:
 
+    Introduction <self>
     user_guide_rag.rst
     user_guide_kg_builder.rst
     user_guide_pipeline.rst

examples/pipeline/schema.py

@@ -0,0 +1,56 @@
+#  Copyright (c) "Neo4j"
+#  Neo4j Sweden AB [https://neo4j.com]
+#  #
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#  #
+#      https://www.apache.org/licenses/LICENSE-2.0
+#  #
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+from neo4j_graphrag.experimental.components.schema import (
+    SchemaBuilder,
+    SchemaEntity,
+    SchemaProperty,
+    SchemaRelation,
+)
+
+
+async def main() -> None:
+    schema_builder = SchemaBuilder()
+
+    await schema_builder.run(
+        entities=[
+            SchemaEntity(
+                label="Person",
+                properties=[
+                    SchemaProperty(name="name", type="STRING"),
+                    SchemaProperty(name="place_of_birth", type="STRING"),
+                    SchemaProperty(name="date_of_birth", type="DATE"),
+                ],
+            ),
+            SchemaEntity(
+                label="Organization",
+                properties=[
+                    SchemaProperty(name="name", type="STRING"),
+                    SchemaProperty(name="country", type="STRING"),
+                ],
+            ),
+        ],
+        relations=[
+            SchemaRelation(
+                label="WORKED_ON",
+            ),
+            SchemaRelation(
+                label="WORKED_FOR",
+            ),
+        ],
+        potential_schema=[
+            ("Person", "WORKED_ON", "Field"),
+            ("Person", "WORKED_FOR", "Organization"),
+        ],
+    )