LLM/docling-serve
1
0
Fork 0
mirror of https://github.com/docling-project/docling-serve.git synced 2025-11-29 00:23:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Readme additions for running

Browse Source 
Readme additions for a quickstart running of docling-serve

Signed-off-by: Brent Salisbury <bsalisbu@redhat.com>
This commit is contained in:
Brent Salisbury
2025-02-25 16:26:14 -05:00
committed by Anil Vishnoi
parent c430d9b1a1
commit 343b985287
1 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -276,6 +276,17 @@ The response can be a JSON Document or a File.
- If you set the parameter `return_as_file` to True, the response will be a zip file.
- If multiple files are generated (multiple inputs, or one input but multiple outputs with `return_as_file` True), the response will be a zip file.
## Run docling-serve
Clone the repository and run the following from within the cloned directory root.
```bash
python -m venv venv
source venv/bin/activate
pip install "docling-serve[ui]"
docling-serve run --enable-ui
```
## Helpers
- A full Swagger UI is available at the `/docs` endpoint.
@@ -323,7 +334,7 @@ uv sync --extra ui --extra rapidocr
uv sync --extra tesserocr
```
See `[project.optional-dependencies]` section in `pyproject.toml` for full list of options.
See `[project.optional-dependencies]` section in `pyproject.toml` for full list of options and runtime options with `uv run docling-serve --help`.
### Run the server