protocol.py 24.3 KB
Newer Older
1
2
# Adapted from
# https://github.com/lm-sys/FastChat/blob/168ccc29d3f7edc50823016105c024fe2282732a/fastchat/protocol/openai_api_protocol.py
Zhuohan Li's avatar
Zhuohan Li committed
3
import time
4
from typing import Any, Dict, List, Literal, Optional, Union
Zhuohan Li's avatar
Zhuohan Li committed
5

6
import openai.types.chat
7
import torch
8
from pydantic import BaseModel, ConfigDict, Field, model_validator
9
10
# pydantic needs the TypedDict from typing_extensions
from typing_extensions import Annotated, Required, TypedDict
Zhuohan Li's avatar
Zhuohan Li committed
11

12
from vllm.pooling_params import PoolingParams
13
from vllm.sampling_params import SamplingParams
14
from vllm.utils import random_uuid
15

Zhuohan Li's avatar
Zhuohan Li committed
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
class CustomChatCompletionContentPartParam(TypedDict, total=False):
    __pydantic_config__ = ConfigDict(extra="allow")  # type: ignore

    type: Required[str]
    """The type of the content part."""


ChatCompletionContentPartParam = Union[
    openai.types.chat.ChatCompletionContentPartParam,
    CustomChatCompletionContentPartParam]


class CustomChatCompletionMessageParam(TypedDict, total=False):
    """Enables custom roles in the Chat Completion API."""
    role: Required[str]
    """The role of the message's author."""

    content: Union[str, List[ChatCompletionContentPartParam]]
    """The contents of the message."""

    name: str
    """An optional name for the participant.

    Provides the model information to differentiate between participants of the
    same role.
    """


ChatCompletionMessageParam = Union[
    openai.types.chat.ChatCompletionMessageParam,
    CustomChatCompletionMessageParam]


50
51
52
53
54
55
class OpenAIBaseModel(BaseModel):
    # OpenAI API does not allow extra fields
    model_config = ConfigDict(extra="forbid")


class ErrorResponse(OpenAIBaseModel):
Zhuohan Li's avatar
Zhuohan Li committed
56
57
58
59
    object: str = "error"
    message: str
    type: str
    param: Optional[str] = None
60
    code: int
Zhuohan Li's avatar
Zhuohan Li committed
61
62


63
class ModelPermission(OpenAIBaseModel):
Zhuohan Li's avatar
Zhuohan Li committed
64
65
66
67
68
69
70
71
72
73
74
    id: str = Field(default_factory=lambda: f"modelperm-{random_uuid()}")
    object: str = "model_permission"
    created: int = Field(default_factory=lambda: int(time.time()))
    allow_create_engine: bool = False
    allow_sampling: bool = True
    allow_logprobs: bool = True
    allow_search_indices: bool = False
    allow_view: bool = True
    allow_fine_tuning: bool = False
    organization: str = "*"
    group: Optional[str] = None
75
    is_blocking: bool = False
Zhuohan Li's avatar
Zhuohan Li committed
76
77


78
class ModelCard(OpenAIBaseModel):
Zhuohan Li's avatar
Zhuohan Li committed
79
80
81
    id: str
    object: str = "model"
    created: int = Field(default_factory=lambda: int(time.time()))
Woosuk Kwon's avatar
Woosuk Kwon committed
82
    owned_by: str = "vllm"
Zhuohan Li's avatar
Zhuohan Li committed
83
84
    root: Optional[str] = None
    parent: Optional[str] = None
85
    max_model_len: Optional[int] = None
Zhuohan Li's avatar
Zhuohan Li committed
86
87
88
    permission: List[ModelPermission] = Field(default_factory=list)


89
class ModelList(OpenAIBaseModel):
Zhuohan Li's avatar
Zhuohan Li committed
90
91
92
93
    object: str = "list"
    data: List[ModelCard] = Field(default_factory=list)


94
class UsageInfo(OpenAIBaseModel):
Zhuohan Li's avatar
Zhuohan Li committed
95
96
97
98
99
    prompt_tokens: int = 0
    total_tokens: int = 0
    completion_tokens: Optional[int] = 0


100
class ResponseFormat(OpenAIBaseModel):
101
    # type must be "json_object" or "text"
102
    type: Literal["text", "json_object"]
103
104


105
106
107
108
class StreamOptions(OpenAIBaseModel):
    include_usage: Optional[bool]


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
class FunctionDefinition(OpenAIBaseModel):
    name: str
    description: Optional[str] = None
    parameters: Optional[Dict[str, Any]] = None


class ChatCompletionToolsParam(OpenAIBaseModel):
    type: Literal["function"] = "function"
    function: FunctionDefinition


class ChatCompletionNamedFunction(OpenAIBaseModel):
    name: str


class ChatCompletionNamedToolChoiceParam(OpenAIBaseModel):
    function: ChatCompletionNamedFunction
    type: Literal["function"] = "function"


129
class ChatCompletionRequest(OpenAIBaseModel):
130
131
    # Ordered by official OpenAI API documentation
    # https://platform.openai.com/docs/api-reference/chat/create
132
    messages: List[ChatCompletionMessageParam]
133
134
135
136
    model: str
    frequency_penalty: Optional[float] = 0.0
    logit_bias: Optional[Dict[str, float]] = None
    logprobs: Optional[bool] = False
137
    top_logprobs: Optional[int] = 0
138
    max_tokens: Optional[int] = None
139
140
141
    n: Optional[int] = 1
    presence_penalty: Optional[float] = 0.0
    response_format: Optional[ResponseFormat] = None
142
143
144
    seed: Optional[int] = Field(None,
                                ge=torch.iinfo(torch.long).min,
                                le=torch.iinfo(torch.long).max)
145
    stop: Optional[Union[str, List[str]]] = Field(default_factory=list)
Zhuohan Li's avatar
Zhuohan Li committed
146
    stream: Optional[bool] = False
147
    stream_options: Optional[StreamOptions] = None
148
149
    temperature: Optional[float] = 0.7
    top_p: Optional[float] = 1.0
150
151
152
    tools: Optional[List[ChatCompletionToolsParam]] = None
    tool_choice: Optional[Union[Literal["none"],
                                ChatCompletionNamedToolChoiceParam]] = "none"
Zhuohan Li's avatar
Zhuohan Li committed
153
    user: Optional[str] = None
154
155

    # doc: begin-chat-completion-sampling-params
156
157
    best_of: Optional[int] = None
    use_beam_search: Optional[bool] = False
158
159
160
161
    top_k: Optional[int] = -1
    min_p: Optional[float] = 0.0
    repetition_penalty: Optional[float] = 1.0
    length_penalty: Optional[float] = 1.0
162
    early_stopping: Optional[bool] = False
163
    ignore_eos: Optional[bool] = False
164
    min_tokens: Optional[int] = 0
165
    stop_token_ids: Optional[List[int]] = Field(default_factory=list)
166
    skip_special_tokens: Optional[bool] = True
167
    spaces_between_special_tokens: Optional[bool] = True
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
    # doc: end-chat-completion-sampling-params

    # doc: begin-chat-completion-extra-params
    echo: Optional[bool] = Field(
        default=False,
        description=(
            "If true, the new message will be prepended with the last message "
            "if they belong to the same role."),
    )
    add_generation_prompt: Optional[bool] = Field(
        default=True,
        description=
        ("If true, the generation prompt will be added to the chat template. "
         "This is a parameter used by chat template in tokenizer config of the "
         "model."),
    )
184
185
186
187
188
189
190
191
192
    add_special_tokens: Optional[bool] = Field(
        default=False,
        description=(
            "If true, special tokens (e.g. BOS) will be added to the prompt "
            "on top of what is added by the chat template. "
            "For most models, the chat template takes care of adding the "
            "special tokens so this should be set to False (as is the "
            "default)."),
    )
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
    include_stop_str_in_output: Optional[bool] = Field(
        default=False,
        description=(
            "Whether to include the stop string in the output. "
            "This is only applied when the stop or stop_token_ids is set."),
    )
    guided_json: Optional[Union[str, dict, BaseModel]] = Field(
        default=None,
        description=("If specified, the output will follow the JSON schema."),
    )
    guided_regex: Optional[str] = Field(
        default=None,
        description=(
            "If specified, the output will follow the regex pattern."),
    )
    guided_choice: Optional[List[str]] = Field(
        default=None,
        description=(
            "If specified, the output will be exactly one of the choices."),
    )
    guided_grammar: Optional[str] = Field(
        default=None,
        description=(
            "If specified, the output will follow the context free grammar."),
    )
218
219
220
221
222
223
    guided_decoding_backend: Optional[str] = Field(
        default=None,
        description=(
            "If specified, will override the default guided decoding backend "
            "of the server for this specific request. If set, must be either "
            "'outlines' / 'lm-format-enforcer'"))
224
225
226
227
228
    guided_whitespace_pattern: Optional[str] = Field(
        default=None,
        description=(
            "If specified, will override the default whitespace pattern "
            "for guided json decoding."))
229
230

    # doc: end-chat-completion-extra-params
Zhuohan Li's avatar
Zhuohan Li committed
231

232
    def to_sampling_params(self) -> SamplingParams:
233
        # We now allow logprobs being true without top_logrobs.
234
235
236
237
238
239
240

        logits_processors = None
        if self.logit_bias:

            def logit_bias_logits_processor(
                    token_ids: List[int],
                    logits: torch.Tensor) -> torch.Tensor:
241
                assert self.logit_bias is not None
242
243
244
245
246
247
248
249
                for token_id, bias in self.logit_bias.items():
                    # Clamp the bias between -100 and 100 per OpenAI API spec
                    bias = min(100, max(-100, bias))
                    logits[int(token_id)] += bias
                return logits

            logits_processors = [logit_bias_logits_processor]

250
251
252
253
254
255
256
257
        return SamplingParams(
            n=self.n,
            presence_penalty=self.presence_penalty,
            frequency_penalty=self.frequency_penalty,
            repetition_penalty=self.repetition_penalty,
            temperature=self.temperature,
            top_p=self.top_p,
            min_p=self.min_p,
Nick Hill's avatar
Nick Hill committed
258
            seed=self.seed,
259
260
261
            stop=self.stop,
            stop_token_ids=self.stop_token_ids,
            max_tokens=self.max_tokens,
262
            min_tokens=self.min_tokens,
263
264
            logprobs=self.top_logprobs if self.logprobs else None,
            prompt_logprobs=self.top_logprobs if self.echo else None,
265
266
267
268
            best_of=self.best_of,
            top_k=self.top_k,
            ignore_eos=self.ignore_eos,
            use_beam_search=self.use_beam_search,
269
            early_stopping=self.early_stopping,
270
271
            skip_special_tokens=self.skip_special_tokens,
            spaces_between_special_tokens=self.spaces_between_special_tokens,
272
273
            include_stop_str_in_output=self.include_stop_str_in_output,
            length_penalty=self.length_penalty,
274
            logits_processors=logits_processors,
275
276
        )

277
278
279
280
281
282
283
284
285
    @model_validator(mode='before')
    @classmethod
    def validate_stream_options(cls, values):
        if (values.get('stream_options') is not None
                and not values.get('stream')):
            raise ValueError(
                "stream_options can only be set if stream is true")
        return values

286
287
288
289
290
291
292
293
    @model_validator(mode="before")
    @classmethod
    def check_guided_decoding_count(cls, data):
        guide_count = sum([
            "guided_json" in data and data["guided_json"] is not None,
            "guided_regex" in data and data["guided_regex"] is not None,
            "guided_choice" in data and data["guided_choice"] is not None
        ])
294
        # you can only use one kind of guided decoding
295
296
297
298
        if guide_count > 1:
            raise ValueError(
                "You can only use one kind of guided decoding "
                "('guided_json', 'guided_regex' or 'guided_choice').")
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
        # you can only either use guided decoding or tools, not both
        if guide_count > 1 and "tool_choice" in data and data[
                "tool_choice"] != "none":
            raise ValueError(
                "You can only either use guided decoding or tools, not both.")
        return data

    @model_validator(mode="before")
    @classmethod
    def check_tool_choice(cls, data):
        if "tool_choice" in data and data["tool_choice"] != "none":
            if not isinstance(data["tool_choice"], dict):
                raise ValueError("Currently only named tools are supported.")
            if "tools" not in data or data["tools"] is None:
                raise ValueError(
                    "When using `tool_choice`, `tools` must be set.")
315
316
        return data

317
318
319
320
321
322
323
324
    @model_validator(mode="before")
    @classmethod
    def check_logprobs(cls, data):
        if "top_logprobs" in data and data["top_logprobs"] is not None:
            if "logprobs" not in data or data["logprobs"] is False:
                raise ValueError(
                    "when using `top_logprobs`, `logprobs` must be set to true."
                )
325
            elif data["top_logprobs"] < 0:
326
                raise ValueError(
327
                    "`top_logprobs` must be a value a positive value.")
328
329
        return data

Zhuohan Li's avatar
Zhuohan Li committed
330

331
class CompletionRequest(OpenAIBaseModel):
332
333
    # Ordered by official OpenAI API documentation
    # https://platform.openai.com/docs/api-reference/completions/create
Zhuohan Li's avatar
Zhuohan Li committed
334
    model: str
335
    prompt: Union[List[int], List[List[int]], str, List[str]]
336
    best_of: Optional[int] = None
Zhuohan Li's avatar
Zhuohan Li committed
337
338
339
    echo: Optional[bool] = False
    frequency_penalty: Optional[float] = 0.0
    logit_bias: Optional[Dict[str, float]] = None
340
341
    logprobs: Optional[int] = None
    max_tokens: Optional[int] = 16
342
    n: int = 1
343
    presence_penalty: Optional[float] = 0.0
344
345
346
    seed: Optional[int] = Field(None,
                                ge=torch.iinfo(torch.long).min,
                                le=torch.iinfo(torch.long).max)
347
348
    stop: Optional[Union[str, List[str]]] = Field(default_factory=list)
    stream: Optional[bool] = False
349
    stream_options: Optional[StreamOptions] = None
350
351
352
    suffix: Optional[str] = None
    temperature: Optional[float] = 1.0
    top_p: Optional[float] = 1.0
Zhuohan Li's avatar
Zhuohan Li committed
353
    user: Optional[str] = None
354
355

    # doc: begin-completion-sampling-params
Zhuohan Li's avatar
Zhuohan Li committed
356
    use_beam_search: Optional[bool] = False
357
358
359
360
    top_k: Optional[int] = -1
    min_p: Optional[float] = 0.0
    repetition_penalty: Optional[float] = 1.0
    length_penalty: Optional[float] = 1.0
361
    early_stopping: Optional[bool] = False
362
    stop_token_ids: Optional[List[int]] = Field(default_factory=list)
363
    ignore_eos: Optional[bool] = False
364
    min_tokens: Optional[int] = 0
365
    skip_special_tokens: Optional[bool] = True
366
    spaces_between_special_tokens: Optional[bool] = True
367
    truncate_prompt_tokens: Optional[Annotated[int, Field(ge=1)]] = None
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
393
394
395
396
397
398
399
400
401
402
    # doc: end-completion-sampling-params

    # doc: begin-completion-extra-params
    include_stop_str_in_output: Optional[bool] = Field(
        default=False,
        description=(
            "Whether to include the stop string in the output. "
            "This is only applied when the stop or stop_token_ids is set."),
    )
    response_format: Optional[ResponseFormat] = Field(
        default=None,
        description=
        ("Similar to chat completion, this parameter specifies the format of "
         "output. Only {'type': 'json_object'} or {'type': 'text' } is "
         "supported."),
    )
    guided_json: Optional[Union[str, dict, BaseModel]] = Field(
        default=None,
        description=("If specified, the output will follow the JSON schema."),
    )
    guided_regex: Optional[str] = Field(
        default=None,
        description=(
            "If specified, the output will follow the regex pattern."),
    )
    guided_choice: Optional[List[str]] = Field(
        default=None,
        description=(
            "If specified, the output will be exactly one of the choices."),
    )
    guided_grammar: Optional[str] = Field(
        default=None,
        description=(
            "If specified, the output will follow the context free grammar."),
    )
403
404
405
406
407
408
    guided_decoding_backend: Optional[str] = Field(
        default=None,
        description=(
            "If specified, will override the default guided decoding backend "
            "of the server for this specific request. If set, must be one of "
            "'outlines' / 'lm-format-enforcer'"))
409
410
411
412
413
    guided_whitespace_pattern: Optional[str] = Field(
        default=None,
        description=(
            "If specified, will override the default whitespace pattern "
            "for guided json decoding."))
414
415

    # doc: end-completion-extra-params
Zhuohan Li's avatar
Zhuohan Li committed
416

417
418
419
    def to_sampling_params(self):
        echo_without_generation = self.echo and self.max_tokens == 0

420
421
422
423
424
425
        logits_processors = None
        if self.logit_bias:

            def logit_bias_logits_processor(
                    token_ids: List[int],
                    logits: torch.Tensor) -> torch.Tensor:
426
                assert self.logit_bias is not None
427
428
429
430
431
432
433
434
                for token_id, bias in self.logit_bias.items():
                    # Clamp the bias between -100 and 100 per OpenAI API spec
                    bias = min(100, max(-100, bias))
                    logits[int(token_id)] += bias
                return logits

            logits_processors = [logit_bias_logits_processor]

435
436
437
438
439
440
441
442
443
444
        return SamplingParams(
            n=self.n,
            best_of=self.best_of,
            presence_penalty=self.presence_penalty,
            frequency_penalty=self.frequency_penalty,
            repetition_penalty=self.repetition_penalty,
            temperature=self.temperature,
            top_p=self.top_p,
            top_k=self.top_k,
            min_p=self.min_p,
Nick Hill's avatar
Nick Hill committed
445
            seed=self.seed,
446
447
448
449
            stop=self.stop,
            stop_token_ids=self.stop_token_ids,
            ignore_eos=self.ignore_eos,
            max_tokens=self.max_tokens if not echo_without_generation else 1,
450
            min_tokens=self.min_tokens,
451
452
            logprobs=self.logprobs,
            use_beam_search=self.use_beam_search,
453
            early_stopping=self.early_stopping,
454
455
456
            prompt_logprobs=self.logprobs if self.echo else None,
            skip_special_tokens=self.skip_special_tokens,
            spaces_between_special_tokens=(self.spaces_between_special_tokens),
457
458
            include_stop_str_in_output=self.include_stop_str_in_output,
            length_penalty=self.length_penalty,
459
            logits_processors=logits_processors,
460
            truncate_prompt_tokens=self.truncate_prompt_tokens,
461
462
        )

463
464
465
466
467
468
469
470
471
472
473
474
475
476
    @model_validator(mode="before")
    @classmethod
    def check_guided_decoding_count(cls, data):
        guide_count = sum([
            "guided_json" in data and data["guided_json"] is not None,
            "guided_regex" in data and data["guided_regex"] is not None,
            "guided_choice" in data and data["guided_choice"] is not None
        ])
        if guide_count > 1:
            raise ValueError(
                "You can only use one kind of guided decoding "
                "('guided_json', 'guided_regex' or 'guided_choice').")
        return data

477
478
479
480
    @model_validator(mode="before")
    @classmethod
    def check_logprobs(cls, data):
        if "logprobs" in data and data[
481
482
                "logprobs"] is not None and not data["logprobs"] >= 0:
            raise ValueError("if passed, `logprobs` must be a positive value.")
483
484
        return data

485
486
487
488
489
490
491
492
    @model_validator(mode="before")
    @classmethod
    def validate_stream_options(cls, data):
        if data.get("stream_options") and not data.get("stream"):
            raise ValueError(
                "Stream options can only be defined when stream is True.")
        return data

Zhuohan Li's avatar
Zhuohan Li committed
493

494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
class EmbeddingRequest(BaseModel):
    # Ordered by official OpenAI API documentation
    # https://platform.openai.com/docs/api-reference/embeddings
    model: str
    input: Union[List[int], List[List[int]], str, List[str]]
    encoding_format: Optional[str] = Field('float', pattern='^(float|base64)$')
    dimensions: Optional[int] = None
    user: Optional[str] = None

    # doc: begin-embedding-pooling-params
    additional_data: Optional[Any] = None

    # doc: end-embedding-pooling-params

    def to_pooling_params(self):
        return PoolingParams(additional_data=self.additional_data)


512
class CompletionLogProbs(OpenAIBaseModel):
Zhuohan Li's avatar
Zhuohan Li committed
513
514
515
    text_offset: List[int] = Field(default_factory=list)
    token_logprobs: List[Optional[float]] = Field(default_factory=list)
    tokens: List[str] = Field(default_factory=list)
516
517
    top_logprobs: List[Optional[Dict[str,
                                     float]]] = Field(default_factory=list)
Zhuohan Li's avatar
Zhuohan Li committed
518
519


520
class CompletionResponseChoice(OpenAIBaseModel):
Zhuohan Li's avatar
Zhuohan Li committed
521
522
    index: int
    text: str
523
    logprobs: Optional[CompletionLogProbs] = None
524
525
    finish_reason: Optional[str] = None
    stop_reason: Optional[Union[int, str]] = Field(
526
527
528
529
530
531
        default=None,
        description=(
            "The stop string or token id that caused the completion "
            "to stop, None if the completion finished for some other reason "
            "including encountering the EOS token"),
    )
Zhuohan Li's avatar
Zhuohan Li committed
532
533


534
class CompletionResponse(OpenAIBaseModel):
Zhuohan Li's avatar
Zhuohan Li committed
535
536
537
538
539
540
541
542
    id: str = Field(default_factory=lambda: f"cmpl-{random_uuid()}")
    object: str = "text_completion"
    created: int = Field(default_factory=lambda: int(time.time()))
    model: str
    choices: List[CompletionResponseChoice]
    usage: UsageInfo


543
class CompletionResponseStreamChoice(OpenAIBaseModel):
Zhuohan Li's avatar
Zhuohan Li committed
544
545
    index: int
    text: str
546
    logprobs: Optional[CompletionLogProbs] = None
547
548
    finish_reason: Optional[str] = None
    stop_reason: Optional[Union[int, str]] = Field(
549
550
551
552
553
554
        default=None,
        description=(
            "The stop string or token id that caused the completion "
            "to stop, None if the completion finished for some other reason "
            "including encountering the EOS token"),
    )
Zhuohan Li's avatar
Zhuohan Li committed
555
556


557
class CompletionStreamResponse(OpenAIBaseModel):
Zhuohan Li's avatar
Zhuohan Li committed
558
559
560
561
562
    id: str = Field(default_factory=lambda: f"cmpl-{random_uuid()}")
    object: str = "text_completion"
    created: int = Field(default_factory=lambda: int(time.time()))
    model: str
    choices: List[CompletionResponseStreamChoice]
563
    usage: Optional[UsageInfo] = Field(default=None)
564
565


566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
class EmbeddingResponseData(BaseModel):
    index: int
    object: str = "embedding"
    embedding: List[float]


class EmbeddingResponse(BaseModel):
    id: str = Field(default_factory=lambda: f"cmpl-{random_uuid()}")
    object: str = "list"
    created: int = Field(default_factory=lambda: int(time.time()))
    model: str
    data: List[EmbeddingResponseData]
    usage: UsageInfo


581
582
583
584
585
586
587
588
589
590
591
class FunctionCall(OpenAIBaseModel):
    name: str
    arguments: str


class ToolCall(OpenAIBaseModel):
    id: str = Field(default_factory=lambda: f"chatcmpl-tool-{random_uuid()}")
    type: Literal["function"] = "function"
    function: FunctionCall


592
class ChatMessage(OpenAIBaseModel):
593
594
    role: str
    content: str
595
    tool_calls: List[ToolCall] = Field(default_factory=list)
596
597


598
599
600
601
602
603
604
605
606
607
608
609
610
611
class ChatCompletionLogProb(OpenAIBaseModel):
    token: str
    logprob: float = -9999.0
    bytes: Optional[List[int]] = None


class ChatCompletionLogProbsContent(ChatCompletionLogProb):
    top_logprobs: List[ChatCompletionLogProb] = Field(default_factory=list)


class ChatCompletionLogProbs(OpenAIBaseModel):
    content: Optional[List[ChatCompletionLogProbsContent]] = None


612
class ChatCompletionResponseChoice(OpenAIBaseModel):
613
614
    index: int
    message: ChatMessage
615
    logprobs: Optional[ChatCompletionLogProbs] = None
616
    finish_reason: Optional[str] = None
617
    stop_reason: Optional[Union[int, str]] = None
618
619


620
class ChatCompletionResponse(OpenAIBaseModel):
621
    id: str = Field(default_factory=lambda: f"chatcmpl-{random_uuid()}")
622
    object: Literal["chat.completion"] = "chat.completion"
623
624
625
626
627
628
    created: int = Field(default_factory=lambda: int(time.time()))
    model: str
    choices: List[ChatCompletionResponseChoice]
    usage: UsageInfo


629
class DeltaMessage(OpenAIBaseModel):
630
631
    role: Optional[str] = None
    content: Optional[str] = None
632
    tool_calls: List[ToolCall] = Field(default_factory=list)
633
634


635
class ChatCompletionResponseStreamChoice(OpenAIBaseModel):
636
637
    index: int
    delta: DeltaMessage
638
    logprobs: Optional[ChatCompletionLogProbs] = None
639
    finish_reason: Optional[str] = None
640
    stop_reason: Optional[Union[int, str]] = None
641
642


643
class ChatCompletionStreamResponse(OpenAIBaseModel):
644
    id: str = Field(default_factory=lambda: f"chatcmpl-{random_uuid()}")
645
    object: Literal["chat.completion.chunk"] = "chat.completion.chunk"
646
647
648
    created: int = Field(default_factory=lambda: int(time.time()))
    model: str
    choices: List[ChatCompletionResponseStreamChoice]
649
    usage: Optional[UsageInfo] = Field(default=None)
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674


class BatchRequestInput(OpenAIBaseModel):
    """
    The per-line object of the batch input file.

    NOTE: Currently only the `/v1/chat/completions` endpoint is supported.
    """

    # A developer-provided per-request id that will be used to match outputs to
    # inputs. Must be unique for each request in a batch.
    custom_id: str

    # The HTTP method to be used for the request. Currently only POST is
    # supported.
    method: str

    # The OpenAI API relative URL to be used for the request. Currently
    # /v1/chat/completions is supported.
    url: str

    # The parameteters of the request.
    body: Union[ChatCompletionRequest, ]


675
676
677
678
679
680
681
682
683
684
685
class BatchResponseData(OpenAIBaseModel):
    # HTTP status code of the response.
    status_code: int = 200

    # An unique identifier for the API request.
    request_id: str

    # The body of the response.
    body: Union[ChatCompletionResponse, ]


686
687
688
689
690
691
692
693
694
695
696
class BatchRequestOutput(OpenAIBaseModel):
    """
    The per-line object of the batch output and error files
    """

    id: str

    # A developer-provided per-request id that will be used to match outputs to
    # inputs.
    custom_id: str

697
    response: Optional[BatchResponseData]
698
699
700
701

    # For requests that failed with a non-HTTP error, this will contain more
    # information on the cause of the failure.
    error: Optional[Any]