mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-11-11 05:40:52 +08:00
Jayant
483f3aa71d
### What problem does this PR solve? HTTP API documentation incorrectly refers `agent_name` as `name` instead of `title`. This PR updates that documentation with the correct terms. As per the codebase, the GET request for listing agents is accepting `title` as a parameter: https://github.com/infiniflow/ragflow/blob/9b026fc5b6f234a3abdf954f359bc2f9e99d9ba8/api/apps/sdk/agent.py#L32 This is referred to as `name` parameter in the HTTP API documentation ([link](https://ragflow.io/docs/dev/http_api_reference#list-documents)) ``` GET /api/v1/datasets/{dataset_id}/documents?page={page}&page_size={page_size}&orderby={orderby}&desc={desc}&keywords={keywords}&id={document_id}&name={document_name}&create_time_from={timestamp}&create_time_to={timestamp} ``` Meanwhile, it is correctly mentioned in the Python API docs ([link](https://ragflow.io/docs/dev/python_api_reference#list-agents)): ``` RAGFlow.list_agents( page: int = 1, page_size: int = 30, orderby: str = "create_time", desc: bool = True, id: str = None, title: str = None ) -> List[Agent] ``` ### Type of change - [ ] Bug Fix (non-breaking change which fixes an issue) - [ ] New Feature (non-breaking change which adds functionality) - [x] Documentation Update - [ ] Refactoring - [ ] Performance Improvement - [ ] Other (please describe):