ilia
7c633a02ed
- Added .cursorrules for project guidelines and context - Created README.md for project overview and goals - Established ARCHITECTURE.md for architectural documentation - Set up tickets directory with initial ticket management files - Included .gitignore to manage ignored files and directories This commit lays the foundation for the Atlas project, ensuring a clear structure for development and collaboration.
52 lines
1.1 KiB
Markdown
52 lines
1.1 KiB
Markdown
# Ticket: Define ASR API Contract
|
|
|
|
## Ticket Information
|
|
|
|
- **ID**: TICKET-011
|
|
- **Title**: Define ASR API Contract
|
|
- **Type**: Documentation
|
|
- **Priority**: Medium
|
|
- **Status**: Backlog
|
|
- **Track**: Voice I/O
|
|
- **Milestone**: Milestone 2 - Voice Chat MVP
|
|
- **Created**: 2024-01-XX
|
|
|
|
## Description
|
|
|
|
Define the ASR service API contract:
|
|
- gRPC or HTTP endpoint specification
|
|
- Request/response formats
|
|
- Text segments and timestamp format
|
|
- Error handling
|
|
- Streaming vs batch modes
|
|
|
|
## Acceptance Criteria
|
|
|
|
- [ ] API contract documented (OpenAPI/gRPC proto)
|
|
- [ ] Request/response schemas defined
|
|
- [ ] Error codes and handling documented
|
|
- [ ] Streaming protocol defined
|
|
- [ ] Client integration examples provided
|
|
|
|
## Technical Details
|
|
|
|
API should support:
|
|
- Streaming audio input
|
|
- Real-time text segments
|
|
- Timestamps for each segment
|
|
- Confidence scores
|
|
- End-of-speech detection
|
|
|
|
## Dependencies
|
|
|
|
- TICKET-010 (ASR service implementation)
|
|
|
|
## Related Files
|
|
|
|
- `docs/API_ASR.md` (to be created)
|
|
- `home-voice-agent/asr/api/` (to be created)
|
|
|
|
## Notes
|
|
|
|
Should be defined early to enable parallel client development.
|