feat(docs): enhance AI chat API documentation with examples and details

- Improve POST /chat endpoint documentation with request/response examples
- Add session ID management flow explanation
- Enhance GET /sessions endpoint with query parameters and response example
- Update GET /sessions/{session_id}/history with detailed response structure
- Format parameters as tables for better readability
- Clarify session ID usage in streaming conversations
This commit is contained in:
YueGuobin committed 2026-03-08 02:27:48 +08:00
1 parent fd34ef494f
commit 9ba02e9436
6 files changed
+486 -35

No files matched your search

+1 -2
View File
@@ -75,8 +75,7 @@ class OpenAIMessage(BaseModel):
name: Optional[str] = Field(None, description="Tool message name")
tool_call_id: Optional[str] = Field(None, description="Associated tool call ID (for tool messages)")
tool_calls: Optional[List[OpenAIToolCall]] = Field(None, description="Tool calls (for assistant messages)")
metadata: Dict[str, Any] = Field(default_factory=dict, description="Message metadata")
created_at: str = Field(..., description="Message timestamp (ISO 8601)")
metadata: Dict[str, Any] = Field(default_factory=dict, description="Message metadata (includes created_at)")
class ConversationHistory(BaseModel):