Skip to content

Commit 4255fcd

Browse files
committed
Update doc
1 parent 43126a8 commit 4255fcd

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

docs/source/user_guide_kg_builder.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,16 @@ chunk overlap in the text splitter component:
219219
)
220220
221221
222+
Run Parameters
223+
--------------
224+
225+
SimpleKGPipeline also accepts addition runtime parameters:
226+
227+
- ``document_path`` (str): only used when ``from_pdf=False``, this is the path property of the ``Document`` node.
228+
- ``document_metadata`` (dict): each item will be saved as a property attached to the ``Document`` node.
229+
230+
231+
222232
Using a Config file
223233
===================
224234

examples/build_graph/simple_kg_builder_from_pdf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ async def define_and_run_pipeline(
5858
file_path=str(file_path),
5959
# optional, add document metadata, each item will
6060
# be saved as a property of the Document node
61-
document_metadata={"author": "J. K. Rowling"},
61+
# document_metadata={"author": "J. K. Rowling"},
6262
)
6363

6464

0 commit comments

Comments
 (0)