Skip to content

Corrected endpoints in README #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 10, 2023
Merged

Corrected endpoints in README #81

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4966c08
Corrected endpoints in README
Apr 10, 2023
98420b9
Merge branch 'main' into fix/readme_fix
benjats07 Apr 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,14 @@ run the API locally, use `make start-app-local`. You can stop the API with `make
The API will run at `http:/localhost:5000`.
You can then `POST` a PDF file to the API endpoint to see its layout with the command:
```
curl -X 'POST' 'http://localhost:5000/layout/pdf' -F 'file=@<your_pdf_file>' | jq -C . | less -R
curl -X 'POST' 'http://localhost:5000/layout/default/pdf' -F 'file=@<your_pdf_file>' | jq -C . | less -R
```

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

For using the YoloX model the endpoints are:
```
http://localhost:8000/layout_v1/pdf
http://localhost:8000/layout_v1/image
http://localhost:8000/layout/yolox/pdf
http://localhost:8000/layout/yolox/image
```
For example:
```
Expand Down