[Bug] Incorrect documentation for file upload in /insert_file endpoint

[DHengW]

---

Description:

When following the provided documentation for uploading a file to the /insert_file endpoint, I encountered an error. The documentation suggests using a JSON body with a file_path field, but this results in a 422 Unprocessable Entity error. After some investigation, I found that the correct way to upload a file is by using the -F option in curl to specify the file directly.

Steps to Reproduce:

1. Follow the provided documentation to upload a file:

   curl -X POST "http://127.0.0.1:8020/insert_file" \
       -H "Content-Type: application/json" \
       -d '{"file_path": "./book.txt"}'

2. Observe the following errors:

   • Server Error:

     127.0.0.1:57274 - "POST /insert_file HTTP/1.1" 422 Unprocessable Entity

   • Client Error:

     {
     "detail": [
      {
        "type": "missing",
        "loc": ["body", "file"],
        "msg": "Field required",
        "input": null
      }
     ]
     }

Correct Usage:

To correctly upload a file to the /insert_file endpoint, use the following curl command:

curl -X POST "http://127.0.0.1:8020/insert_file" -F "file=@path/to/your/example.txt"

Expected Behavior:

The server should accept the file and return a success response, such as:

{
  "status": "success",
  "message": "File content from example.txt inserted successfully"
}

Additional Information:

• Endpoint Source Code:

• lightrag_api_openai_compatible_demo.py , line 120

  @app.post("/insert_file", response_model=Response)
  async def insert_file(file: UploadFile = File(...)):
    try:
        file_content = await file.read()
        # Read file content
        try:
            content = file_content.decode("utf-8")
        except UnicodeDecodeError:
            # If UTF-8 decoding fails, try other encodings
            content = file_content.decode("gbk")
        # Insert file content
        loop = asyncio.get_event_loop()
        await loop.run_in_executor(None, lambda: rag.insert(content))
  
        return Response(
            status="success",
            message=f"File content from {file.filename} inserted successfully",
        )
    except Exception as e:
        raise HTTPException(status_code=500, detail=str(e))

• Environment:

  • version : lightrag-hku = 0.0.8

Suggested Fix:

Update the documentation to reflect the correct usage of the /insert_file endpoint. Specifically, change the example curl command to use the -F option for file upload.

Thank you for your attention to this issue.

---

[suercxx]

这个怎么上传其他类型的文件啊