Skip to content

Commit e2c3035

Browse files
asimurkaasimurka
committed
Fixed responses examples
1 parent 3049234 commit e2c3035

2 files changed

Lines changed: 38 additions & 27 deletions

File tree

‎docs/openapi.json‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4272,7 +4272,13 @@
42724272
},
42734273
"usage": {
42744274
"input_tokens": 100,
4275+
"input_tokens_details": {
4276+
"cached_tokens": 0
4277+
},
42754278
"output_tokens": 50,
4279+
"output_tokens_details": {
4280+
"reasoning_tokens": 0
4281+
},
42764282
"total_tokens": 150
42774283
}
42784284
}
@@ -4281,11 +4287,7 @@
42814287
"schema": {
42824288
"type": "string"
42834289
},
4284-
"examples": {
4285-
"stream": {
4286-
"value": "event: response.created\ndata: {\"type\":\"response.created\",\"sequence_number\":0,\"response\":{\"id\":\"resp_abc\",\"created_at\":1704067200,\"status\":\"in_progress\",\"output\":[],\"conversation\":\"0d21ba731f21f798dc9680125d5d6f49\",\"available_quotas\":{},\"output_text\":\"\"}}\n\nevent: response.output_item.added\ndata: {\"response_id\":\"resp_abc\",\"item\":{\"type\":\"message\",\"role\":\"assistant\",\"content\":[{\"type\":\"output_text\",\"text\":\"Hello! How can I help?\"}]},\"output_index\":0,\"sequence_number\":1}\n\nevent: response.output_item.done\ndata: {\"response_id\":\"resp_abc\",\"item\":{\"type\":\"message\",\"role\":\"assistant\",\"content\":[{\"type\":\"output_text\",\"text\":\"Hello! How can I help?\"}]},\"output_index\":0,\"sequence_number\":2}\n\nevent: response.completed\ndata: {\"type\":\"response.completed\",\"sequence_number\":3,\"response\":{\"id\":\"resp_abc\",\"created_at\":1704067200,\"completed_at\":1704067250,\"status\":\"completed\",\"output\":[{\"type\":\"message\",\"role\":\"assistant\",\"content\":[{\"type\":\"output_text\",\"text\":\"Hello! How can I help?\"}]}],\"usage\":{\"input_tokens\":10,\"output_tokens\":6,\"total_tokens\":16},\"conversation\":\"0d21ba731f21f798dc9680125d5d6f49\",\"available_quotas\":{\"daily\":1000,\"monthly\":50000},\"output_text\":\"Hello! How can I help?\"}}\n\ndata: [DONE]\n\n"
4287-
}
4288-
},
4290+
"example": "event: response.created\ndata: {\"type\":\"response.in_progress\",\"sequence_number\":0,\"response\":{\"id\":\"resp_abc\",\"object\":\"response\",\"created_at\":1704067200,\"status\":\"in_progress\",\"model\":\"openai/gpt-4o-mini\",\"output\":[],\"store\":true,\"text\":{\"format\":{\"type\":\"text\"}},\"conversation\":\"0d21ba731f21f798dc9680125d5d6f49\",\"available_quotas\":{},\"output_text\":\"\"}}\n\nevent: response.output_item.added\ndata: {\"type\":\"response.output_item.added\",\"sequence_number\":1,\"response_id\":\"resp_abc\",\"output_index\":0,\"item\":{\"id\":\"msg_abc\",\"type\":\"message\",\"status\":\"in_progress\",\"role\":\"assistant\",\"content\":[]}}\n\n...\n\nevent: response.completed\ndata: {\"type\":\"response.completed\",\"sequence_number\":30,\"response\":{\"id\":\"resp_abc\",\"object\":\"response\",\"created_at\":1704067200,\"status\":\"completed\",\"model\":\"openai/gpt-4o-mini\",\"output\":[{\"id\":\"msg_abc\",\"type\":\"message\",\"status\":\"completed\",\"role\":\"assistant\",\"content\":[{\"type\":\"output_text\",\"text\":\"Hello! How can I help?\",\"annotations\":[]}]}],\"store\":true,\"text\":{\"format\":{\"type\":\"text\"}},\"usage\":{\"input_tokens\":10,\"output_tokens\":6,\"total_tokens\":16,\"input_tokens_details\":{\"cached_tokens\":0},\"output_tokens_details\":{\"reasoning_tokens\":0}},\"conversation\":\"0d21ba731f21f798dc9680125d5d6f49\",\"available_quotas\":{\"daily\":1000,\"monthly\":50000},\"output_text\":\"Hello! How can I help?\"}}\n\ndata: [DONE]\n\n",
42894291
"description": "SSE stream of events"
42904292
}
42914293
}
@@ -12663,12 +12665,18 @@
1266312665
},
1266412666
"usage": {
1266512667
"input_tokens": 100,
12668+
"input_tokens_details": {
12669+
"cached_tokens": 0
12670+
},
1266612671
"output_tokens": 50,
12672+
"output_tokens_details": {
12673+
"reasoning_tokens": 0
12674+
},
1266712675
"total_tokens": 150
1266812676
}
1266912677
}
1267012678
],
12671-
"sse_example": "event: response.created\ndata: {\"type\":\"response.created\",\"sequence_number\":0,\"response\":{\"id\":\"resp_abc\",\"created_at\":1704067200,\"status\":\"in_progress\",\"output\":[],\"conversation\":\"0d21ba731f21f798dc9680125d5d6f49\",\"available_quotas\":{},\"output_text\":\"\"}}\n\nevent: response.output_item.added\ndata: {\"response_id\":\"resp_abc\",\"item\":{\"type\":\"message\",\"role\":\"assistant\",\"content\":[{\"type\":\"output_text\",\"text\":\"Hello! How can I help?\"}]},\"output_index\":0,\"sequence_number\":1}\n\nevent: response.output_item.done\ndata: {\"response_id\":\"resp_abc\",\"item\":{\"type\":\"message\",\"role\":\"assistant\",\"content\":[{\"type\":\"output_text\",\"text\":\"Hello! How can I help?\"}]},\"output_index\":0,\"sequence_number\":2}\n\nevent: response.completed\ndata: {\"type\":\"response.completed\",\"sequence_number\":3,\"response\":{\"id\":\"resp_abc\",\"created_at\":1704067200,\"completed_at\":1704067250,\"status\":\"completed\",\"output\":[{\"type\":\"message\",\"role\":\"assistant\",\"content\":[{\"type\":\"output_text\",\"text\":\"Hello! How can I help?\"}]}],\"usage\":{\"input_tokens\":10,\"output_tokens\":6,\"total_tokens\":16},\"conversation\":\"0d21ba731f21f798dc9680125d5d6f49\",\"available_quotas\":{\"daily\":1000,\"monthly\":50000},\"output_text\":\"Hello! How can I help?\"}}\n\ndata: [DONE]\n\n"
12679+
"sse_example": "event: response.created\ndata: {\"type\":\"response.in_progress\",\"sequence_number\":0,\"response\":{\"id\":\"resp_abc\",\"object\":\"response\",\"created_at\":1704067200,\"status\":\"in_progress\",\"model\":\"openai/gpt-4o-mini\",\"output\":[],\"store\":true,\"text\":{\"format\":{\"type\":\"text\"}},\"conversation\":\"0d21ba731f21f798dc9680125d5d6f49\",\"available_quotas\":{},\"output_text\":\"\"}}\n\nevent: response.output_item.added\ndata: {\"type\":\"response.output_item.added\",\"sequence_number\":1,\"response_id\":\"resp_abc\",\"output_index\":0,\"item\":{\"id\":\"msg_abc\",\"type\":\"message\",\"status\":\"in_progress\",\"role\":\"assistant\",\"content\":[]}}\n\n...\n\nevent: response.completed\ndata: {\"type\":\"response.completed\",\"sequence_number\":30,\"response\":{\"id\":\"resp_abc\",\"object\":\"response\",\"created_at\":1704067200,\"status\":\"completed\",\"model\":\"openai/gpt-4o-mini\",\"output\":[{\"id\":\"msg_abc\",\"type\":\"message\",\"status\":\"completed\",\"role\":\"assistant\",\"content\":[{\"type\":\"output_text\",\"text\":\"Hello! How can I help?\",\"annotations\":[]}]}],\"store\":true,\"text\":{\"format\":{\"type\":\"text\"}},\"usage\":{\"input_tokens\":10,\"output_tokens\":6,\"total_tokens\":16,\"input_tokens_details\":{\"cached_tokens\":0},\"output_tokens_details\":{\"reasoning_tokens\":0}},\"conversation\":\"0d21ba731f21f798dc9680125d5d6f49\",\"available_quotas\":{\"daily\":1000,\"monthly\":50000},\"output_text\":\"Hello! How can I help?\"}}\n\ndata: [DONE]\n\n"
1267212680
},
1267312681
"RlsapiV1Attachment": {
1267412682
"properties": {

‎src/models/responses.py‎

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1617,6 +1617,8 @@ class ResponsesResponse(AbstractSuccessfulResponse):
16171617
"input_tokens": 100,
16181618
"output_tokens": 50,
16191619
"total_tokens": 150,
1620+
"input_tokens_details": {"cached_tokens": 0},
1621+
"output_tokens_details": {"reasoning_tokens": 0},
16201622
},
16211623
"instructions": "You are a helpful assistant",
16221624
"store": True,
@@ -1630,28 +1632,29 @@ class ResponsesResponse(AbstractSuccessfulResponse):
16301632
],
16311633
"sse_example": (
16321634
"event: response.created\n"
1633-
'data: {"type":"response.created","sequence_number":0,'
1634-
'"response":{"id":"resp_abc","created_at":1704067200,'
1635-
'"status":"in_progress","output":[],"conversation":'
1636-
'"0d21ba731f21f798dc9680125d5d6f49","available_quotas":{},'
1637-
'"output_text":""}}\n\n'
1635+
'data: {"type":"response.in_progress","sequence_number":0,'
1636+
'"response":{"id":"resp_abc","object":"response",'
1637+
'"created_at":1704067200,"status":"in_progress","model":"openai/gpt-4o-mini",'
1638+
'"output":[],"store":true,"text":{"format":{"type":"text"}},'
1639+
'"conversation":"0d21ba731f21f798dc9680125d5d6f49",'
1640+
'"available_quotas":{},"output_text":""}}\n\n'
16381641
"event: response.output_item.added\n"
1639-
'data: {"response_id":"resp_abc","item":{"type":"message",'
1640-
'"role":"assistant","content":[{"type":"output_text",'
1641-
'"text":"Hello! How can I help?"}]},"output_index":0,'
1642-
'"sequence_number":1}\n\n'
1643-
"event: response.output_item.done\n"
1644-
'data: {"response_id":"resp_abc","item":{"type":"message",'
1645-
'"role":"assistant","content":[{"type":"output_text",'
1646-
'"text":"Hello! How can I help?"}]},"output_index":0,'
1647-
'"sequence_number":2}\n\n'
1642+
'data: {"type":"response.output_item.added","sequence_number":1,'
1643+
'"response_id":"resp_abc","output_index":0,'
1644+
'"item":{"id":"msg_abc","type":"message","status":"in_progress",'
1645+
'"role":"assistant","content":[]}}\n\n'
1646+
"...\n\n"
16481647
"event: response.completed\n"
1649-
'data: {"type":"response.completed","sequence_number":3,'
1650-
'"response":{"id":"resp_abc","created_at":1704067200,'
1651-
'"completed_at":1704067250,"status":"completed",'
1652-
'"output":[{"type":"message","role":"assistant",'
1653-
'"content":[{"type":"output_text","text":"Hello! How can I help?"}]}],'
1654-
'"usage":{"input_tokens":10,"output_tokens":6,"total_tokens":16},'
1648+
'data: {"type":"response.completed","sequence_number":30,'
1649+
'"response":{"id":"resp_abc","object":"response",'
1650+
'"created_at":1704067200,"status":"completed","model":"openai/gpt-4o-mini",'
1651+
'"output":[{"id":"msg_abc","type":"message","status":"completed",'
1652+
'"role":"assistant","content":[{"type":"output_text",'
1653+
'"text":"Hello! How can I help?","annotations":[]}]}],'
1654+
'"store":true,"text":{"format":{"type":"text"}},'
1655+
'"usage":{"input_tokens":10,"output_tokens":6,"total_tokens":16,'
1656+
'"input_tokens_details":{"cached_tokens":0},'
1657+
'"output_tokens_details":{"reasoning_tokens":0}},'
16551658
'"conversation":"0d21ba731f21f798dc9680125d5d6f49",'
16561659
'"available_quotas":{"daily":1000,"monthly":50000},'
16571660
'"output_text":"Hello! How can I help?"}}\n\n'
@@ -1682,7 +1685,7 @@ def openapi_response(cls) -> dict[str, Any]:
16821685
"text/event-stream": {
16831686
"schema": {"type": "string"},
16841687
"description": "SSE stream of events",
1685-
"examples": {"stream": {"value": sse_example}} if sse_example else {},
1688+
"example": sse_example,
16861689
},
16871690
}
16881691

0 commit comments

Comments
 (0)