gmakstutis/ragflow
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ragflow/docs
History
Jayant 483f3aa71d
Update API reference to use 'title' instead of 'name' for listing agents (#9907) 
### 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:

9b026fc5b6/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):
2025-09-04 16:53:55 +08:00
..
contribution Docs: Added contribution guidelines and sandbox-related tips (#7685) 2025-05-16 16:28:21 +08:00
develop Docs: Update version references to v0.20.4 in READMEs and docs (#9758) 2025-08-27 16:56:55 +08:00
guides Docs: Updated instructions on importing third-party packages to Sandbox (#9890) 2025-09-03 15:47:07 +08:00
references Update API reference to use 'title' instead of 'name' for listing agents (#9907) 2025-09-04 16:53:55 +08:00
_category_.json Reorganized docs for docusaurus publish (#860) 2024-05-21 20:53:55 +08:00
configurations.md Docs: Update version references to v0.20.4 in READMEs and docs (#9758) 2025-08-27 16:56:55 +08:00
faq.mdx Docs: Update version references to v0.20.4 in READMEs and docs (#9758) 2025-08-27 16:56:55 +08:00
quickstart.mdx Docs: Refactored Retrieval component reference (#9862) 2025-09-02 10:28:23 +08:00
release_notes.md Added v0.20.4 release notes (#9757) 2025-08-27 15:29:09 +08:00