OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-05-20 11:18:42 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

fix

Browse Source
This commit is contained in:
Timothy J. Baek 2024-10-08 17:09:42 -07:00
parent e467b16d96
commit 46255d3a7b
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/api/index.md
View File

@ -45,18 +45,18 @@ The Retrieval Augmented Generation (RAG) feature allows you to enhance responses
To utilize external data in RAG responses, you first need to upload the files. The content of the uploaded file is automatically extracted and stored in a vector database. To utilize external data in RAG responses, you first need to upload the files. The content of the uploaded file is automatically extracted and stored in a vector database.
- **Endpoint**: `POST /api/files/` - **Endpoint**: `POST /api/v1/files/`
- **Curl Example**: - **Curl Example**:
```bash ```bash
curl -X POST -H "Authorization: Bearer YOUR_API_KEY" -H "Accept: application/json" \ curl -X POST -H "Authorization: Bearer YOUR_API_KEY" -H "Accept: application/json" \
-F "file=@/path/to/your/file" http://localhost:3000/api/files/ -F "file=@/path/to/your/file" http://localhost:3000/api/v1/files/
``` ```
- **Python Example**: - **Python Example**:
```python ```python
import requests import requests
def upload_file(token, file_path): def upload_file(token, file_path):
url = 'http://localhost:3000/api/files/' url = 'http://localhost:3000/api/v1/files/'
headers = { headers = {
'Authorization': f'Bearer {token}', 'Authorization': f'Bearer {token}',
'Accept': 'application/json' 'Accept': 'application/json'
@ -70,10 +70,10 @@ To utilize external data in RAG responses, you first need to upload the files. T
After uploading, you can group files into a knowledge collection or reference them individually in chats. After uploading, you can group files into a knowledge collection or reference them individually in chats.
- **Endpoint**: `POST /api/knowledge/{id}/file/add` - **Endpoint**: `POST /api/v1/knowledge/{id}/file/add`
- **Curl Example**: - **Curl Example**:
```bash ```bash
curl -X POST http://localhost:3000/api/knowledge/{knowledge_id}/file/add \ curl -X POST http://localhost:3000/api/v1/knowledge/{knowledge_id}/file/add \
-H "Authorization: Bearer YOUR_API_KEY" \ -H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-d '{"file_id": "your-file-id-here"}' -d '{"file_id": "your-file-id-here"}'
@ -83,7 +83,7 @@ After uploading, you can group files into a knowledge collection or reference th
import requests import requests
def add_file_to_knowledge(token, knowledge_id, file_id): def add_file_to_knowledge(token, knowledge_id, file_id):
url = f'http://localhost:3000/api/knowledge/{knowledge_id}/file/add' url = f'http://localhost:3000/api/v1/knowledge/{knowledge_id}/file/add'
headers = { headers = {
'Authorization': f'Bearer {token}', 'Authorization': f'Bearer {token}',
'Content-Type': 'application/json' 'Content-Type': 'application/json'