File tree Expand file tree Collapse file tree 1 file changed +21
-3
lines changed Expand file tree Collapse file tree 1 file changed +21
-3
lines changed Original file line number Diff line number Diff line change @@ -21,16 +21,34 @@ pip install langchain-docling
2121
2222## Usage
2323
24- Basic usage looks as follows:
24+ ### Basic usage
25+
26+ Basic usage of ` DoclingLoader ` looks as follows:
2527
2628``` python
2729from langchain_docling import DoclingLoader
2830
2931FILE_PATH = [" https://arxiv.org/pdf/2408.09869" ] # Docling Technical Report
3032
3133loader = DoclingLoader(file_path = FILE_PATH )
32-
3334docs = loader.load()
3435```
3536
36- For end-to-end usage samples check out the [ examples] ( examples/ ) .
37+ ### Advanced usage
38+
39+ When initializing a ` DoclingLoader ` , you can use the following parameters:
40+
41+ - ` file_path ` : source as single str (URL or local file) or iterable thereof
42+ - ` converter ` (optional): any specific Docling converter instance to use
43+ - ` convert_kwargs ` (optional): any specific kwargs for conversion execution
44+ - ` export_type ` (optional): export mode to use: ` ExportType.DOC_CHUNKS ` (default) or
45+ ` ExportType.MARKDOWN `
46+ - ` md_export_kwargs ` (optional): any specific Markdown export kwargs (for Markdown mode)
47+ - ` chunker ` (optional): any specific Docling chunker instance to use (for doc-chunk
48+ mode)
49+ - ` meta_extractor ` (optional): any specific metadata extractor to use
50+
51+ ### Example
52+
53+ For an end-to-end usage example, check out
54+ [ this notebook] ( https://ds4sd.github.io/docling/examples/rag_langchain/ ) .
You can’t perform that action at this time.
0 commit comments