diff --git a/src/models/responses.py b/src/models/responses.py index 90be0cdc..7345b189 100644 --- a/src/models/responses.py +++ b/src/models/responses.py @@ -361,7 +361,11 @@ class FeedbackResponse(BaseModel): ``` """ - response: str + response: str = Field( + ..., + description="The response of the feedback request.", + examples=["feedback received"], + ) # provides examples for /docs endpoint model_config = { @@ -391,8 +395,17 @@ class StatusResponse(BaseModel): ``` """ - functionality: str - status: dict + functionality: str = Field( + ..., + description="The functionality of the service", + examples=["feedback"], + ) + + status: dict = Field( + ..., + description="The status of the service", + examples=[{"enabled": True}], + ) # provides examples for /docs endpoint model_config = { @@ -507,8 +520,26 @@ class ConversationResponse(BaseModel): ``` """ - conversation_id: str - chat_history: list[dict[str, Any]] + conversation_id: str = Field( + ..., + description="Conversation ID (UUID)", + examples=["c5260aec-4d82-4370-9fdf-05cf908b3f16"], + ) + + chat_history: list[dict[str, Any]] = Field( + ..., + description="The simplified chat history as a list of conversation turns", + examples=[ + { + "messages": [ + {"content": "Hello", "type": "user"}, + {"content": "Hi there!", "type": "assistant"}, + ], + "started_at": "2024-01-01T00:01:00Z", + "completed_at": "2024-01-01T00:01:05Z", + } + ], + ) # provides examples for /docs endpoint model_config = {