Skip to content

Commit a9f1255

Browse files
authored
fix: Corrected endpoints in README (#81)
Corrections to endpoints in README
1 parent 6925ada commit a9f1255

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,14 +72,14 @@ run the API locally, use `make start-app-local`. You can stop the API with `make
7272
The API will run at `http:/localhost:5000`.
7373
You can then `POST` a PDF file to the API endpoint to see its layout with the command:
7474
```
75-
curl -X 'POST' 'http://localhost:5000/layout/pdf' -F 'file=@<your_pdf_file>' | jq -C . | less -R
75+
curl -X 'POST' 'http://localhost:5000/layout/default/pdf' -F 'file=@<your_pdf_file>' | jq -C . | less -R
7676
```
7777

7878
You can also choose the types of elements you want to return from the output of PDF parsing by
7979
passing a list of types to the `include_elems` parameter. For example, if you only want to return
8080
`Text` elements and `Title` elements, you can curl:
8181
```
82-
curl -X 'POST' 'http://localhost:5000/layout/pdf' \
82+
curl -X 'POST' 'http://localhost:5000/layout/default/pdf' \
8383
-F 'file=@<your_pdf_file>' \
8484
-F include_elems=Text \
8585
-F include_elems=Title \
@@ -94,8 +94,8 @@ View the swagger documentation at `http://localhost:5000/docs`.
9494

9595
For using the YoloX model the endpoints are:
9696
```
97-
http://localhost:8000/layout_v1/pdf
98-
http://localhost:8000/layout_v1/image
97+
http://localhost:8000/layout/yolox/pdf
98+
http://localhost:8000/layout/yolox/image
9999
```
100100
For example:
101101
```

0 commit comments

Comments
 (0)