Skip to content

Commit 8fa64ef

Browse files
committed
docs: Update docs for installing and enableing Docling
Branch: DoclingIntegration Signed-off-by: Gabe Goodhart <[email protected]>
1 parent 72bbacc commit 8fa64ef

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

docs/docs/gpt-researcher/gptr/config.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ Below is a list of current supported options:
4444
- **`EMBEDDING_KWARGS`**: Json formatted dict of additional keyword args to be passed to the embedding provider class when instantiating it.
4545
- **`USER_AGENT`**: Custom User-Agent string for web crawling and web requests.
4646
- **`MEMORY_BACKEND`**: Backend used for memory operations, such as local storage of temporary data. Defaults to `local`.
47+
- **`CONVERT_WITH_DOCLING`**: Use [docling](https://docling-project.github.io/docling/) for document conversion (NOTE: This requires installing the `docling` extra e.g. `pip install gpt-researcher[docling]`).
48+
- **`DOCLING_VLM`**: If `CONVERT_WITH_DOCLING` is set, this will enable docling's pipeline for using a Visual Language Model (VLM) to parse images.
4749

4850
To change the default configurations, you can simply add env variables to your `.env` file as named above or export manually in your local project directory.
4951

docs/docs/gpt-researcher/gptr/pip-package.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ Follow these easy steps to get started:
1515
pip install gpt-researcher
1616
```
1717

18+
To install optional dependencies, use the following syntax:
19+
20+
```bash
21+
pip install gpt-researcher[docling]
22+
```
23+
1824
2. **Environment Variables:** Create a .env file with your OpenAI API key or simply export it
1925

2026
```bash

0 commit comments

Comments
 (0)