Skip to content

Commit 5fcc3bb

Browse files
committed
docs: add project roadmap with upcoming features, enhancements, and documentation plans
1 parent ad98a61 commit 5fcc3bb

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,31 @@ lifecycleScope.launch {
6969
- [x] Edits (Legacy)
7070
- [x] Streaming for Assistants
7171

72+
## Roadmap
73+
74+
### Upcoming Features
75+
- [ ] **Streaming for Chat Completions** - Real-time token streaming for chat responses
76+
- [ ] **Batch API** - Support for asynchronous batch processing
77+
- [ ] **Vector Stores API** - Direct vector store management endpoints
78+
- [ ] **Uploads API** - Large file upload support
79+
- [ ] **Realtime API** - WebSocket-based real-time communication (GPT-4o Realtime)
80+
81+
### Enhancements
82+
- [ ] **Response Caching** - Built-in caching mechanism for API responses
83+
- [ ] **Retry Logic** - Automatic retry with exponential backoff
84+
- [ ] **Rate Limiting** - Client-side rate limit handling
85+
- [ ] **Modularization** - Split client into focused modules (e.g., `client.chat`, `client.images`, `client.assistants`)
86+
- [ ] **Comprehensive Testing** - Unit and integration tests for all endpoints
87+
- [ ] **Sample App** - Full-featured demo application showcasing all capabilities
88+
89+
### Documentation
90+
- [ ] **API Documentation** - KDoc documentation for all public APIs
91+
- [ ] **Usage Examples** - Comprehensive examples for each endpoint
92+
- [ ] **Migration Guide** - Detailed guide for upgrading from legacy versions
93+
94+
Want to contribute? Check out our [issues](https://github.com/mardillu/OpenAI-Client-Android/issues) or submit a PR!
95+
96+
7297
## License
7398
MIT License
7499

0 commit comments

Comments
 (0)