Update ingest api docs with Windows support (#1289)

This commit is contained in:
Francisco García Sierra 2023-11-29 20:56:37 +01:00 committed by GitHub
parent 28d03fdda8
commit b7ca7d35a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -22,6 +22,13 @@ To log the processed and failed files to an additional file, use:
make ingest /path/to/folder -- --watch --log-file /path/to/log/file.log
```
**Note for Windows Users:** Depending on your Windows version and whether you are using PowerShell to execute
PrivateGPT API calls, you may need to include the parameter name before passing the folder path for consumption:
```bash
make ingest arg=/path/to/folder -- --watch --log-file /path/to/log/file.log
```
After ingestion is complete, you should be able to chat with your documents
by navigating to http://localhost:8001 and using the option `Query documents`,
or using the completions / chat API.