Merge branch 'main' of https://github.com/neo4j/neo4j-genai-python

Author: stellasia

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

@@ -13,6 +13,8 @@ concurrency:
 jobs:
   e2e-tests:
     runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 1
     strategy:
       matrix:
         python-version: ['3.8', '3.12']

CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## Next
 
+## 0.4.0
+
+### Added
+- Add optional custom_prompt arg to the Text2CypherRetriever class.
+- Introduced support for Component/Pipeline flexible architecture.
+- Added new components for knowledge graph construction, including text splitters, schema builders, entity-relation extractors, and Neo4j writers.
+- Implemented end-to-end tests for the new knowledge graph builder pipeline.
+
+### Changed
+- `GraphRAG.search` method first parameter has been renamed `query_text` (was `query`) for consistency with the retrievers interface.
+- Made `GraphRAG.search` method backwards compatible with the query parameter, raising warnings to encourage using query_text instead.
+
 ## 0.3.1
 
 ### Fixed

README.md

@@ -68,7 +68,7 @@ Assumption: Neo4j running with a defined vector index
 
 ```python
 from neo4j import GraphDatabase
-from neo4j_genai.indexes import upsert_query
+from neo4j_genai.indexes import upsert_vector
 
 URI = "neo4j://localhost:7687"
 AUTH = ("neo4j", "password")
@@ -78,7 +78,7 @@ driver = GraphDatabase.driver(URI, auth=AUTH)
 
 # Upsert the vector
 vector = ...
-upsert_query(
+upsert_vector(
     driver,
     node_id=1,
     embedding_property="vectorProperty",

docs/source/api.rst

@@ -3,14 +3,75 @@
 API Documentation
 #################
 
+.. _components-section:
+
+**********
+Components
+**********
+
+KGWriter
+========
+
+.. autoclass:: neo4j_genai.experimental.components.kg_writer.KGWriter
+    :members: run
+
+Neo4jWriter
+===========
+
+.. autoclass:: neo4j_genai.experimental.components.kg_writer.Neo4jWriter
+    :members: run
+
+TextSplitter
+============
+
+.. autoclass:: neo4j_genai.experimental.components.text_splitters.base.TextSplitter
+    :members: run
+
+LangChainTextSplitterAdapter
+============================
+
+.. autoclass:: neo4j_genai.experimental.components.text_splitters.langchain.LangChainTextSplitterAdapter
+    :members: run
+
+LlamaIndexTextSplitterAdapter
+=============================
+
+.. autoclass:: neo4j_genai.experimental.components.text_splitters.llamaindex.LlamaIndexTextSplitterAdapter
+    :members: run
+
+TextChunkEmbedder
+=================
+
+.. autoclass:: neo4j_genai.experimental.components.embedder.TextChunkEmbedder
+    :members: run
+
+SchemaBuilder
+=============
+
+.. autoclass:: neo4j_genai.experimental.components.schema.SchemaBuilder
+    :members: run
+
+EntityRelationExtractor
+=======================
+
+.. autoclass:: neo4j_genai.experimental.components.entity_relation_extractor.EntityRelationExtractor
+    :members:
+    :undoc-members: component_inputs, component_outputs
+
+LLMEntityRelationExtractor
+==========================
+
+.. autoclass:: neo4j_genai.experimental.components.entity_relation_extractor.LLMEntityRelationExtractor
+    :members: run
+
 .. _retrievers-section:
 
 **********
 Retrievers
 **********
 
 RetrieverInterface
-===================
+==================
 
 .. autoclass:: neo4j_genai.retrievers.base.Retriever
     :members:
@@ -70,43 +131,57 @@ PineconeNeo4jRetriever
     :members: search
 
 
-**********
+********
 Embedder
-**********
+********
 
 .. autoclass:: neo4j_genai.embedder.Embedder
     :members:
 
 SentenceTransformerEmbeddings
-================================
+=============================
 
-.. autoclass:: neo4j_genai.embeddings.SentenceTransformerEmbeddings
+.. autoclass:: neo4j_genai.embeddings.sentence_transformers.SentenceTransformerEmbeddings
     :members:
 
 **********
 Generation
 **********
 
 LLMInterface
-======================
+============
 
 .. autoclass:: neo4j_genai.llm.LLMInterface
     :members:
 
 
 OpenAILLM
-======================
+=========
 
 .. autoclass:: neo4j_genai.llm.OpenAILLM
     :members:
 
 
 PromptTemplate
-======================
+==============
 
 .. autoclass:: neo4j_genai.generation.prompts.PromptTemplate
     :members:
 
+
+RagTemplate
+-----------
+
+.. autoclass:: neo4j_genai.generation.prompts.RagTemplate
+    :members:
+
+ERExtractionTemplate
+--------------------
+
+.. autoclass:: neo4j_genai.generation.prompts.ERExtractionTemplate
+    :members:
+
+
 .. _database-interaction-section:
 
 ********************
@@ -125,6 +200,8 @@ Database Interaction
 
 .. autofunction:: neo4j_genai.indexes.upsert_vector
 
+.. autofunction:: neo4j_genai.indexes.upsert_vector_on_relationship
+
 
 ******
 Errors
@@ -157,6 +234,12 @@ Errors
 
   * :class:`neo4j_genai.exceptions.LLMGenerationError`
 
+  * :class:`neo4j_genai.experimental.pipeline.exceptions.PipelineDefinitionError`
+
+  * :class:`neo4j_genai.experimental.pipeline.exceptions.PipelineMissingDependencyError`
+
+  * :class:`neo4j_genai.experimental.pipeline.exceptions.PipelineStatusUpdateError`
+
 
 Neo4jGenAiError
 ===============
@@ -222,7 +305,7 @@ Neo4jVersionError
 
 
 Text2CypherRetrievalError
-==========================
+=========================
 
 .. autoclass:: neo4j_genai.exceptions.Text2CypherRetrievalError
    :show-inheritance:
@@ -236,21 +319,42 @@ SchemaFetchError
 
 
 RagInitializationError
-==========================
+======================
 
 .. autoclass:: neo4j_genai.exceptions.RagInitializationError
    :show-inheritance:
 
 
 PromptMissingInputError
-==========================
+=======================
 
 .. autoclass:: neo4j_genai.exceptions.PromptMissingInputError
    :show-inheritance:
 
 
 LLMGenerationError
-==========================
+==================
 
 .. autoclass:: neo4j_genai.exceptions.LLMGenerationError
    :show-inheritance:
+
+
+PipelineDefinitionError
+=======================
+
+.. autoclass:: neo4j_genai.experimental.pipeline.exceptions.PipelineDefinitionError
+   :show-inheritance:
+
+
+PipelineMissingDependencyError
+==============================
+
+.. autoclass:: neo4j_genai.experimental.pipeline.exceptions.PipelineMissingDependencyError
+   :show-inheritance:
+
+
+PipelineStatusUpdateError
+=========================
+
+.. autoclass:: neo4j_genai.experimental.pipeline.exceptions.PipelineStatusUpdateError
+   :show-inheritance:

docs/source/images/kg_builder_pipeline.png

@@ -30,7 +30,9 @@ Python versions supported:
 Topics
 ******
 
-+ :ref:`user-guide`
++ :ref:`user-guide-rag`
++ :ref:`user-guide-kg-builder`
++ :ref:`user-guide-pipeline`
 + :ref:`api-documentation`
 + :ref:`types-documentation`
 
@@ -39,7 +41,9 @@ Topics
     :caption: Contents:
     :hidden:
 
-    user_guide.rst
+    user_guide_rag.rst
+    user_guide_kg_builder.rst
+    user_guide_pipeline.rst
     api.rst
     types.rst
 
@@ -113,7 +117,7 @@ Note that the below example is not the only way you can upsert data into your Ne
 .. code:: python
 
     from neo4j import GraphDatabase
-    from neo4j_genai.indexes import upsert_query
+    from neo4j_genai.indexes import upsert_vector
 
     URI = "neo4j://localhost:7687"
     AUTH = ("neo4j", "password")
@@ -123,7 +127,7 @@ Note that the below example is not the only way you can upsert data into your Ne
 
     # Upsert the vector
     vector = ...
-    upsert_query(
+    upsert_vector(
         driver,
         node_id=1,
         embedding_property="vectorProperty",

docs/source/index.rst

@@ -5,30 +5,80 @@ Types
 *****
 
 RawSearchResult
-==================
+===============
 
 .. autoclass:: neo4j_genai.types.RawSearchResult
 
 
 RetrieverResult
-==================
+===============
 
 .. autoclass:: neo4j_genai.types.RetrieverResult
 
 
 RetrieverResultItem
-====================
+===================
 
 .. autoclass:: neo4j_genai.types.RetrieverResultItem
 
 
 LLMResponse
-====================
+===========
 
 .. autoclass:: neo4j_genai.llm.types.LLMResponse
 
 
 RagResultModel
-====================
+==============
 
 .. autoclass:: neo4j_genai.generation.types.RagResultModel
+
+TextChunk
+=========
+
+.. autoclass:: neo4j_genai.experimental.components.types.TextChunk
+
+TextChunks
+==========
+
+.. autoclass:: neo4j_genai.experimental.components.types.TextChunks
+
+Neo4jNode
+=========
+
+.. autoclass:: neo4j_genai.experimental.components.types.Neo4jNode
+
+Neo4jRelationship
+=================
+
+.. autoclass:: neo4j_genai.experimental.components.types.Neo4jRelationship
+
+Neo4jGraph
+==========
+
+.. autoclass:: neo4j_genai.experimental.components.types.Neo4jGraph
+
+KGWriterModel
+=============
+
+.. autoclass:: neo4j_genai.experimental.components.kg_writer.KGWriterModel
+
+SchemaProperty
+==============
+
+.. autoclass:: neo4j_genai.experimental.components.schema.SchemaProperty
+
+SchemaEntity
+============
+
+.. autoclass:: neo4j_genai.experimental.components.schema.SchemaEntity
+
+SchemaRelation
+==============
+
+.. autoclass:: neo4j_genai.experimental.components.schema.SchemaEntity
+
+SchemaConfig
+============
+
+.. autoclass:: neo4j_genai.experimental.components.schema.SchemaConfig