-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Michele Dolfi <[email protected]>
- Loading branch information
1 parent
6a5aa98
commit 407d827
Showing
2 changed files
with
5 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,6 @@ | |
|
||
Running [Docling](https://github.com/DS4SD/docling) as an API service. | ||
|
||
|
||
## Usage | ||
|
||
The API provides two endpoints: one for urls, one for files. This is necessary to send files directly in binary format instead of base64-encoded strings. | ||
|
@@ -92,6 +91,7 @@ curl -X 'POST' \ | |
"input_sources": "https://arxiv.org/pdf/2206.01062" | ||
}' | ||
``` | ||
|
||
</details> | ||
|
||
<details> | ||
Check failure on line 97 in README.md
|
||
|
@@ -121,6 +121,7 @@ response = await async_client_client.post(url, json=payload) | |
|
||
data = response.json() | ||
``` | ||
|
||
</details> | ||
|
||
### File endpoint | ||
|
@@ -148,6 +149,7 @@ curl -X 'POST' \ | |
-F 'return_as_file=false' \ | ||
-F 'do_ocr=true' | ||
``` | ||
|
||
</details> | ||
|
||
<details> | ||
Check failure on line 155 in README.md
|
||
|
@@ -184,8 +186,8 @@ assert response.status_code == 200, "Response should be 200 OK" | |
|
||
data = response.json() | ||
``` | ||
</details> | ||
|
||
</details> | ||
|
||
### Response format | ||
|
||
|
@@ -271,7 +273,6 @@ The following variables are available: | |
`RELOAD`: If `True`, this will enable auto-reload when you modify files, useful for development. | ||
`WITH_UI`: If `True`, The Gradio UI will be available at `/ui`. | ||
|
||
|
||
## Get help and support | ||
|
||
Please feel free to connect with us using the [discussion section](https://github.com/DS4SD/docling/discussions). | ||
|