Skip to content

Commit 65b3026

Browse files
authored
Merge pull request #623 from tisnik/added-missing-fields-for-responses
LCORE-632: Added missing fields for responses
2 parents 00f242b + b4e9bed commit 65b3026

File tree

1 file changed

+36
-5
lines changed

1 file changed

+36
-5
lines changed

src/models/responses.py

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,11 @@ class FeedbackResponse(BaseModel):
361361
```
362362
"""
363363

364-
response: str
364+
response: str = Field(
365+
...,
366+
description="The response of the feedback request.",
367+
examples=["feedback received"],
368+
)
365369

366370
# provides examples for /docs endpoint
367371
model_config = {
@@ -391,8 +395,17 @@ class StatusResponse(BaseModel):
391395
```
392396
"""
393397

394-
functionality: str
395-
status: dict
398+
functionality: str = Field(
399+
...,
400+
description="The functionality of the service",
401+
examples=["feedback"],
402+
)
403+
404+
status: dict = Field(
405+
...,
406+
description="The status of the service",
407+
examples=[{"enabled": True}],
408+
)
396409

397410
# provides examples for /docs endpoint
398411
model_config = {
@@ -507,8 +520,26 @@ class ConversationResponse(BaseModel):
507520
```
508521
"""
509522

510-
conversation_id: str
511-
chat_history: list[dict[str, Any]]
523+
conversation_id: str = Field(
524+
...,
525+
description="Conversation ID (UUID)",
526+
examples=["c5260aec-4d82-4370-9fdf-05cf908b3f16"],
527+
)
528+
529+
chat_history: list[dict[str, Any]] = Field(
530+
...,
531+
description="The simplified chat history as a list of conversation turns",
532+
examples=[
533+
{
534+
"messages": [
535+
{"content": "Hello", "type": "user"},
536+
{"content": "Hi there!", "type": "assistant"},
537+
],
538+
"started_at": "2024-01-01T00:01:00Z",
539+
"completed_at": "2024-01-01T00:01:05Z",
540+
}
541+
],
542+
)
512543

513544
# provides examples for /docs endpoint
514545
model_config = {

0 commit comments

Comments
 (0)