Skip to content

Commit c5ded61

Browse files
committed
Update doc
1 parent c5b3767 commit c5ded61

File tree

2 files changed

+31
-1
lines changed

2 files changed

+31
-1
lines changed

docs/source/api.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,14 @@ Neo4jWriter
102102
.. autoclass:: neo4j_graphrag.experimental.components.kg_writer.Neo4jWriter
103103
:members: run
104104

105+
106+
EntityResolver
107+
==============
108+
109+
.. autoclass:: neo4j_graphrag.experimental.components.resolver.EntityResolver
110+
:members: run
111+
112+
105113
SinglePropertyExactMatchResolver
106114
================================
107115

docs/source/user_guide_kg_builder.rst

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,9 +178,13 @@ For advanced customization or when using a custom implementation, you can pass
178178
instances of specific components to the `SimpleKGPipeline`. The components that can
179179
customized at the moment are:
180180

181-
- `text_splitter`: must be an instance of :ref:`TextSplitter`
182181
- `pdf_loader`: must be an instance of :ref:`PdfLoader`
182+
- `schema_builder`: must be an instance of :ref:`SchemaBuilder`
183+
- `text_splitter`: must be an instance of :ref:`TextSplitter`
184+
- `chunk_embedder`: must be an instance of :ref:`TextChunkEmbedder`
185+
- `extractor`: must be an instance of :ref:`EntityRelationExtractor`
183186
- `kg_writer`: must be an instance of :ref:`KGWriter`
187+
- `resolver`: must be an instance of :ref:`EntityResolver`
184188

185189
For instance, the following code can be used to customize the chunk size and
186190
chunk overlap in the text splitter component:
@@ -200,6 +204,24 @@ chunk overlap in the text splitter component:
200204
)
201205
202206
207+
.. warning::
208+
209+
When providing a custom component, all other related parameters in the SimpleKGPipeline constructor are ignored. For instance, in the following example:
210+
211+
.. code:: python
212+
213+
kg_builder = SimpleKGPipeline(
214+
# ...
215+
writer=Neo4jKGWriter(neo4j_database="db_1"),
216+
neo4j_database="db_2",
217+
# ...
218+
)
219+
220+
221+
The graph will be saved to the **db_1** database.
222+
223+
224+
203225
Using a Config file
204226
===================
205227

0 commit comments

Comments
 (0)