lasse/pdf-highlighter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updates command line example and arguments

Browse Source
This commit is contained in:
lasseedfast 2024-10-08 10:57:56 +02:00
parent 021dd7a759
commit 6c9aececd5
1 changed files with 2 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -58,10 +58,6 @@ A library for highlighting and annotating sentences in PDF documents using Large
You can use the command-line interface to highlight sentences in a PDF document. You can use the command-line interface to highlight sentences in a PDF document.
```sh
python highlight_pdf.py --user_input "Your question or input text" --pdf_filename "path/to/your/document.pdf" --openai_key "your_openai_api_key" --comment
```
#### Arguments #### Arguments
- `--user_input`: The text input from the user to highlight in the PDFs. - `--user_input`: The text input from the user to highlight in the PDFs.
@ -69,7 +65,8 @@ python highlight_pdf.py --user_input "Your question or input text" --pdf_filenam
- `--silent`: Suppress warnings (optional). - `--silent`: Suppress warnings (optional).
- `--openai_key`: OpenAI API key (optional if set in `.env`). - `--openai_key`: OpenAI API key (optional if set in `.env`).
- `--comment`: Include comments in the highlighted PDF (optional). - `--comment`: Include comments in the highlighted PDF (optional).
- `--data`: Data in JSON format (fields: text, pdf_filename, pages) (optional). - `--data`: Data in JSON format (fields: user_input, pdf_filename, pages) (optional).
- `--llm_model`: The LLM model to use (optional if set in `.env`).
#### Example #### Example