Fix doc

neo4j · Dec 30, 2024 · 5691312 · 5691312
1 parent 0b06bdb
commit 5691312
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 3 deletions.
diff --git a/docs/source/user_guide_kg_builder.rst b/docs/source/user_guide_kg_builder.rst
@@ -672,7 +672,7 @@ Example usage:
     from neo4j_graphrag.experimental.pipeline.components.lexical_graph_builder import LexicalGraphBuilder
     from neo4j_graphrag.experimental.pipeline.components.types import LexicalGraphConfig
 
-    lexical_graph_builder = LexicalGraphBuilder(config=LexicalGraphConfig(id_prefix="example"))
+    lexical_graph_builder = LexicalGraphBuilder(config=LexicalGraphConfig())
     graph = await lexical_graph_builder.run(
         text_chunks=TextChunks(chunks=[
             TextChunk(text="some text", index=0),
@@ -713,7 +713,6 @@ Optionally, the document and chunk node labels can be configured using a `Lexica
     # optionally, define a LexicalGraphConfig object
     # shown below with the default values
     config = LexicalGraphConfig(
-        id_prefix="",  # used to prefix the chunk and document IDs
         chunk_node_label="Chunk",
         document_node_label="Document",
         chunk_to_document_relationship_type="PART_OF_DOCUMENT",

diff --git a/src/neo4j_graphrag/experimental/components/types.py b/src/neo4j_graphrag/experimental/components/types.py
@@ -149,7 +149,7 @@ class ResolutionStats(DataModel):
 class LexicalGraphConfig(BaseModel):
     """Configure all labels and property names in the lexical graph."""
 
-    id_prefix: str = Field(deprecated=True)
+    id_prefix: str = Field(deprecated=True, default="")
     document_node_label: str = DEFAULT_DOCUMENT_NODE_LABEL
     chunk_node_label: str = DEFAULT_CHUNK_NODE_LABEL
     chunk_to_document_relationship_type: str = (