File size: 8,735 Bytes
87337b1 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 |
openapi: 3.0.0
info:
title: Streaming Chat Completion API with Multimedia Support
version: 1.0.0
description: API for streaming chat completions with support for text, image, and audio content
paths:
/chat/completions:
post:
summary: Create a streaming chat completion
description: Streams a chat completion response
operationId: createChatCompletion
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ChatCompletionRequest"
responses:
"200":
description: Successful response
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ChatCompletionResponse"
- $ref: "#/components/schemas/ChatCompletionChunk"
x-stream: true
components:
schemas:
ChatCompletionRequest:
type: object
required:
- messages
properties:
context:
type: object
model:
type: string
example: "gpt-4o"
messages:
type: array
items:
oneOf:
- $ref: "#/components/schemas/SystemMessage"
- $ref: "#/components/schemas/UserMessage"
- $ref: "#/components/schemas/AssistantMessage"
- $ref: "#/components/schemas/ToolMessage"
response_format:
$ref: "#/components/schemas/ResponseFormat"
modalities:
type: array
items:
type: string
enum: [text, audio]
default: [text]
audio:
type: object
properties:
voice:
type: string
tools:
type: array
items:
$ref: "#/components/schemas/Tool"
tool_choice:
oneOf:
- type: string
enum: [auto, none, required]
- type: object
properties:
type:
type: string
enum: [function]
function:
type: object
parallel_tool_calls:
type: boolean
default: true
stream:
type: boolean
default: true
ssml_enabled:
type: boolean
default: false
SystemMessage:
type: object
required:
- role
- content
properties:
name:
type: string
role:
type: string
enum: [system]
content:
oneOf:
- type: string
- type: array
items:
type: string
UserMessage:
type: object
required:
- role
- content
properties:
name:
type: string
role:
type: string
enum: [user]
content:
oneOf:
- type: string
- type: array
items:
oneOf:
- $ref: "#/components/schemas/TextContent"
- $ref: "#/components/schemas/ImageContent"
- $ref: "#/components/schemas/AudioContent"
AssistantMessage:
type: object
required:
- role
- content
properties:
name:
type: string
role:
type: string
enum: [system]
audio:
type: object
properties:
id:
type: string
content:
oneOf:
- type: string
- type: array
items:
$ref: "#/components/schemas/TextContent"
tool_calls:
type: object
properties:
id:
type: string
type:
type: string
enum: [function]
function:
type: object
properties:
name:
type: string
arguments:
type: string
ToolMessage:
type: object
required:
- role
- content
- tool_call_id
properties:
role:
type: string
enum: [tool]
content:
oneOf:
- type: string
- type: array
items:
type: string
tool_call_id:
type: string
TextContent:
type: object
required:
- type
- text
properties:
type:
type: string
enum: [text]
text:
type: string
ImageContent:
type: object
required:
- type
- image_url
properties:
type:
type: string
enum: [image_url]
image_url:
type: string
format: uri
AudioContent:
type: object
required:
- type
- input_audio
properties:
type:
type: string
enum: [input_audio]
input_audio:
type: object
properties:
data:
type: string
format:
type: string
Tool:
type: object
properties:
type:
type: string
enum: [function]
function:
type: object
required:
- name
properties:
name:
type: string
description:
type: string
parameters:
type: object
strict:
type: boolean
default: false
ResponseFormat:
type: object
properties:
type:
type: string
enum: [json_schema]
json_schema:
type: object
properties:
name:
type: string
schema:
type: object
ChatCompletionResponse:
type: object
properties:
id:
type: string
object:
type: string
created:
type: integer
model:
type: string
usage:
$ref: "#/components/schemas/Usage"
choices:
type: array
items:
$ref: "#/components/schemas/Choice"
ChatCompletionChunk:
type: object
properties:
id:
type: string
object:
type: string
created:
type: integer
model:
type: string
usage:
$ref: "#/components/schemas/Usage"
choices:
type: array
items:
$ref: "#/components/schemas/DeltaChoice"
Usage:
type: object
properties:
completion_tokens:
type: integer
prompt_tokens:
type: integer
total_tokens:
type: integer
completion_tokens_details:
type: object
properties:
accepted_prediction_tokens:
type: integer
audio_tokens:
type: integer
reasoning_tokens:
type: integer
rejected_prediction_tokens:
type: integer
prompt_tokens_details:
type: object
properties:
audio_tokens:
type: integer
cached_tokens:
type: integer
Choice:
type: object
properties:
message:
$ref: "#/components/schemas/ResponseMessage"
index:
type: integer
finish_reason:
type: string
DeltaChoice:
type: object
properties:
delta:
$ref: "#/components/schemas/ResponseMessage"
index:
type: integer
finish_reason:
type: string
Delta:
type: object
properties:
content:
type: string
ResponseMessage:
type: object
properties:
content:
type: string
refusal:
type: string
tool_calls:
$ref: "#/components/schemas/ToolCall"
role:
type: string
audio:
$ref: "#/components/schemas/Audio"
ToolCall:
type: object
properties:
id:
type: string
type:
type: string
enum: [function]
function:
type: object
properties:
name:
type: string
arguments:
type: string
Audio:
type: object
properties:
id:
type: string
expires_at:
type: integer
data:
type: string
transcript:
type: string
|