AI/ragflow

mirror of https://git.mirrors.martin98.com/https://github.com/infiniflow/ragflow.git synced 2025-04-21 21:50:02 +08:00

History

Improve API Documentation, Standardize Error Handling, and Enhance Comments (#5990 )

### What problem does this PR solve?  
- The API documentation lacks detailed error code explanations. Added
error code tables to `python_api_reference.md` and
`http_api_reference.md` to clarify possible error codes and their
meanings.
- Error handling in the codebase is inconsistent. Standardized error
handling logic in `sdk/python/ragflow_sdk/modules/chunk.py`.
- Improved API comments by adding standardized docstrings to enhance
code readability and maintainability.

### Type of change  
- [x] Documentation Update  
- [x] Refactoring

2025-03-13 19:06:50 +08:00

ragflow_sdk

Improve API Documentation, Standardize Error Handling, and Enhance Comments (#5990 )

2025-03-13 19:06:50 +08:00

test

Test: Added test cases for Download Documents HTTP API (#6032 )

2025-03-13 18:32:57 +08:00

hello_ragflow.py

Update comments (#4569 )

2025-01-21 20:52:28 +08:00

pyproject.toml

DOCS: for release. (#6023 )

2025-03-13 15:09:29 +08:00

README.md

Replace poetry with uv (#4471 )

2025-01-14 11:49:43 +08:00

uv.lock

DOCS: for release. (#6023 )

2025-03-13 15:09:29 +08:00

README.md

ragflow-sdk

build and publish python SDK to pypi.org

uv build
uv pip install twine
export TWINE_USERNAME="__token__"
export TWINE_PASSWORD=$YOUR_PYPI_API_TOKEN
twine upload dist/*.whl