Skip to content

Fix doc about custom data loader #436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 16, 2025
Merged

Fix doc about custom data loader #436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb4f5fc
Remove tests on rate limit for SentenceTransformer embedder
stellasia Oct 16, 2025
9288d9a
Not in this branch
stellasia Oct 16, 2025
dbeaa8a
Merge branch 'main' into doc/data-loader-update
stellasia Oct 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions docs/source/user_guide_kg_builder.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -602,9 +602,15 @@ To implement your own loader, use the `DataLoader` interface:
from neo4j_graphrag.experimental.components.pdf_loader import DataLoader, PdfDocument

class MyDataLoader(DataLoader):
async def run(self, path: Path) -> PdfDocument:
# process file in `path`
return PdfDocument(text="text")
async def run(self, filepath: Path, metadata: Optional[Dict[str, str]] = None) -> PdfDocument:
# process file in `filepath`
return PdfDocument(
text="text",
document_info=DocumentInfo(
path=str(filepath),
metadata=metadata,
)
)



Expand Down
3 changes: 1 addition & 2 deletions examples/customize/build_graph/components/loaders/custom_loader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ async def run(
text="<extracted text>",
document_info=DocumentInfo(
path=str(filepath),
# optionally, add some metadata as a dict
metadata=None,
metadata=metadata,
),
)