"tests/kernels/moe/test_modular_kernel_combinations.py" did not exist on "6fb162447bb2eba84cb23c59dfa37321ba89cb53"
protocol.py 26.4 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 argparse import Namespace
5
from typing import Any, Dict, List, Literal, Optional, Union
Zhuohan Li's avatar
Zhuohan Li committed
6

7
import torch
8
from pydantic import BaseModel, ConfigDict, Field, model_validator
9
from typing_extensions import Annotated
Zhuohan Li's avatar
Zhuohan Li committed
10

11
from vllm.entrypoints.chat_utils import ChatCompletionMessageParam
12
from vllm.entrypoints.openai.logits_processors import get_logits_processors
13
from vllm.pooling_params import PoolingParams
14
from vllm.sampling_params import LogitsProcessor, SamplingParams
15
from vllm.sequence import Logprob
16
from vllm.transformers_utils.tokenizer import AnyTokenizer
17
from vllm.utils import random_uuid
18

19
20
21
# torch is mocked during docs generation,
# so we have to provide the values as literals
_MOCK_LONG_INFO = Namespace(min=-9223372036854775808, max=9223372036854775807)
22
_LONG_INFO: Union["torch.iinfo", Namespace]
23
24
25
26
27
28
29
30
31
32
33
34
35
36

try:
    from sphinx.ext.autodoc.mock import _MockModule

    if isinstance(torch, _MockModule):
        _LONG_INFO = _MOCK_LONG_INFO
    else:
        _LONG_INFO = torch.iinfo(torch.long)
except ModuleNotFoundError:
    _LONG_INFO = torch.iinfo(torch.long)

assert _LONG_INFO.min == _MOCK_LONG_INFO.min
assert _LONG_INFO.max == _MOCK_LONG_INFO.max

Zhuohan Li's avatar
Zhuohan Li committed
37

38
39
40
41
42
43
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
44
45
46
47
    object: str = "error"
    message: str
    type: str
    param: Optional[str] = None
48
    code: int
Zhuohan Li's avatar
Zhuohan Li committed
49
50


51
class ModelPermission(OpenAIBaseModel):
Zhuohan Li's avatar
Zhuohan Li committed
52
53
54
55
56
57
58
59
60
61
62
    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
63
    is_blocking: bool = False
Zhuohan Li's avatar
Zhuohan Li committed
64
65


66
class ModelCard(OpenAIBaseModel):
Zhuohan Li's avatar
Zhuohan Li committed
67
68
69
    id: str
    object: str = "model"
    created: int = Field(default_factory=lambda: int(time.time()))
Woosuk Kwon's avatar
Woosuk Kwon committed
70
    owned_by: str = "vllm"
Zhuohan Li's avatar
Zhuohan Li committed
71
72
    root: Optional[str] = None
    parent: Optional[str] = None
73
    max_model_len: Optional[int] = None
Zhuohan Li's avatar
Zhuohan Li committed
74
75
76
    permission: List[ModelPermission] = Field(default_factory=list)


77
class ModelList(OpenAIBaseModel):
Zhuohan Li's avatar
Zhuohan Li committed
78
79
80
81
    object: str = "list"
    data: List[ModelCard] = Field(default_factory=list)


82
class UsageInfo(OpenAIBaseModel):
Zhuohan Li's avatar
Zhuohan Li committed
83
84
85
86
87
    prompt_tokens: int = 0
    total_tokens: int = 0
    completion_tokens: Optional[int] = 0


88
class ResponseFormat(OpenAIBaseModel):
89
    # type must be "json_object" or "text"
90
    type: Literal["text", "json_object"]
91
92


93
class StreamOptions(OpenAIBaseModel):
94
95
    include_usage: Optional[bool] = True
    continuous_usage_stats: Optional[bool] = True
96
97


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
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"


118
class ChatCompletionRequest(OpenAIBaseModel):
119
120
    # Ordered by official OpenAI API documentation
    # https://platform.openai.com/docs/api-reference/chat/create
121
    messages: List[ChatCompletionMessageParam]
122
123
124
125
    model: str
    frequency_penalty: Optional[float] = 0.0
    logit_bias: Optional[Dict[str, float]] = None
    logprobs: Optional[bool] = False
126
    top_logprobs: Optional[int] = 0
127
    max_tokens: Optional[int] = None
128
129
130
    n: Optional[int] = 1
    presence_penalty: Optional[float] = 0.0
    response_format: Optional[ResponseFormat] = None
131
    seed: Optional[int] = Field(None, ge=_LONG_INFO.min, le=_LONG_INFO.max)
132
    stop: Optional[Union[str, List[str]]] = Field(default_factory=list)
Zhuohan Li's avatar
Zhuohan Li committed
133
    stream: Optional[bool] = False
134
    stream_options: Optional[StreamOptions] = None
135
136
    temperature: Optional[float] = 0.7
    top_p: Optional[float] = 1.0
137
138
139
    tools: Optional[List[ChatCompletionToolsParam]] = None
    tool_choice: Optional[Union[Literal["none"],
                                ChatCompletionNamedToolChoiceParam]] = "none"
Zhuohan Li's avatar
Zhuohan Li committed
140
    user: Optional[str] = None
141
142

    # doc: begin-chat-completion-sampling-params
143
    best_of: Optional[int] = None
144
145
146
147
148
149
    use_beam_search: bool = False
    top_k: int = -1
    min_p: float = 0.0
    repetition_penalty: float = 1.0
    length_penalty: float = 1.0
    early_stopping: bool = False
150
    stop_token_ids: Optional[List[int]] = Field(default_factory=list)
151
152
153
154
155
156
    include_stop_str_in_output: bool = False
    ignore_eos: bool = False
    min_tokens: int = 0
    skip_special_tokens: bool = True
    spaces_between_special_tokens: bool = True
    truncate_prompt_tokens: Optional[Annotated[int, Field(ge=1)]] = None
157
    prompt_logprobs: Optional[int] = None
158
159
160
    # doc: end-chat-completion-sampling-params

    # doc: begin-chat-completion-extra-params
161
    echo: bool = Field(
162
163
164
165
166
        default=False,
        description=(
            "If true, the new message will be prepended with the last message "
            "if they belong to the same role."),
    )
167
    add_generation_prompt: bool = Field(
168
169
170
171
172
173
        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."),
    )
174
    add_special_tokens: bool = Field(
175
176
177
178
179
        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 "
180
            "special tokens so this should be set to false (as is the "
181
182
            "default)."),
    )
183
184
185
186
187
188
189
190
191
192
193
194
195
    documents: Optional[List[Dict[str, str]]] = Field(
        default=None,
        description=
        ("A list of dicts representing documents that will be accessible to "
         "the model if it is performing RAG (retrieval-augmented generation)."
         " If the template does not support RAG, this argument will have no "
         "effect. We recommend that each document should be a dict containing "
         "\"title\" and \"text\" keys."),
    )
    chat_template: Optional[str] = Field(
        default=None,
        description=(
            "A Jinja template to use for this conversion. "
196
197
198
            "As of transformers v4.44, default chat template is no longer "
            "allowed, so you must provide a chat template if the tokenizer "
            "does not define one."),
199
200
201
202
203
204
    )
    chat_template_kwargs: Optional[Dict[str, Any]] = Field(
        default=None,
        description=("Additional kwargs to pass to the template renderer. "
                     "Will be accessible by the chat template."),
    )
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
    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."),
    )
224
225
226
227
228
229
    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'"))
230
231
232
233
234
    guided_whitespace_pattern: Optional[str] = Field(
        default=None,
        description=(
            "If specified, will override the default whitespace pattern "
            "for guided json decoding."))
235
236

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

238
    def to_sampling_params(
239
            self, tokenizer: AnyTokenizer,
240
241
242
243
244
            guided_decode_logits_processor: Optional[LogitsProcessor],
            default_max_tokens: int) -> SamplingParams:
        max_tokens = self.max_tokens
        if max_tokens is None:
            max_tokens = default_max_tokens
245

246
247
248
249
        prompt_logprobs = self.prompt_logprobs
        if prompt_logprobs is None and self.echo:
            prompt_logprobs = self.top_logprobs

250
        # We now allow logprobs being true without top_logrobs.
251
252
253
254
255
        logits_processors = get_logits_processors(
            logit_bias=self.logit_bias,
            allowed_token_ids=None,
            tokenizer=tokenizer,
        )
256
257
        if guided_decode_logits_processor:
            logits_processors.append(guided_decode_logits_processor)
258

259
        return SamplingParams.from_optional(
260
            n=self.n,
261
            best_of=self.best_of,
262
263
264
265
266
            presence_penalty=self.presence_penalty,
            frequency_penalty=self.frequency_penalty,
            repetition_penalty=self.repetition_penalty,
            temperature=self.temperature,
            top_p=self.top_p,
267
            top_k=self.top_k,
268
            min_p=self.min_p,
Nick Hill's avatar
Nick Hill committed
269
            seed=self.seed,
270
271
            stop=self.stop,
            stop_token_ids=self.stop_token_ids,
272
            logprobs=self.top_logprobs if self.logprobs else None,
273
            prompt_logprobs=prompt_logprobs,
274
            ignore_eos=self.ignore_eos,
275
            max_tokens=max_tokens,
276
            min_tokens=self.min_tokens,
277
            use_beam_search=self.use_beam_search,
278
            early_stopping=self.early_stopping,
279
280
            skip_special_tokens=self.skip_special_tokens,
            spaces_between_special_tokens=self.spaces_between_special_tokens,
281
282
            include_stop_str_in_output=self.include_stop_str_in_output,
            length_penalty=self.length_penalty,
283
            logits_processors=logits_processors,
284
            truncate_prompt_tokens=self.truncate_prompt_tokens,
285
286
        )

287
    @model_validator(mode="before")
288
    @classmethod
289
290
    def validate_stream_options(cls, data):
        if data.get("stream_options") and not data.get("stream"):
291
            raise ValueError(
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
                "Stream options can only be defined when `stream=True`.")

        return data

    @model_validator(mode="before")
    @classmethod
    def check_logprobs(cls, data):
        if (prompt_logprobs := data.get("prompt_logprobs")) is not None:
            if data.get("stream") and prompt_logprobs > 0:
                raise ValueError(
                    "`prompt_logprobs` are not available when `stream=True`.")

            if prompt_logprobs < 0:
                raise ValueError("`prompt_logprobs` must be a positive value.")

        if (top_logprobs := data.get("top_logprobs")) is not None:
            if top_logprobs < 0:
                raise ValueError("`top_logprobs` must be a positive value.")

            if not data.get("logprobs"):
                raise ValueError(
                    "when using `top_logprobs`, `logprobs` must be set to true."
                )

        return data
317

318
319
320
321
322
323
324
325
    @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
        ])
326
        # you can only use one kind of guided decoding
327
328
329
330
        if guide_count > 1:
            raise ValueError(
                "You can only use one kind of guided decoding "
                "('guided_json', 'guided_regex' or 'guided_choice').")
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
        # 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.")
347
348
        return data

Zhuohan Li's avatar
Zhuohan Li committed
349

350
class CompletionRequest(OpenAIBaseModel):
351
352
    # Ordered by official OpenAI API documentation
    # https://platform.openai.com/docs/api-reference/completions/create
Zhuohan Li's avatar
Zhuohan Li committed
353
    model: str
354
    prompt: Union[List[int], List[List[int]], str, List[str]]
355
    best_of: Optional[int] = None
Zhuohan Li's avatar
Zhuohan Li committed
356
357
358
    echo: Optional[bool] = False
    frequency_penalty: Optional[float] = 0.0
    logit_bias: Optional[Dict[str, float]] = None
359
360
    logprobs: Optional[int] = None
    max_tokens: Optional[int] = 16
361
    n: int = 1
362
    presence_penalty: Optional[float] = 0.0
363
    seed: Optional[int] = Field(None, ge=_LONG_INFO.min, le=_LONG_INFO.max)
364
365
    stop: Optional[Union[str, List[str]]] = Field(default_factory=list)
    stream: Optional[bool] = False
366
    stream_options: Optional[StreamOptions] = None
367
368
369
    suffix: Optional[str] = None
    temperature: Optional[float] = 1.0
    top_p: Optional[float] = 1.0
Zhuohan Li's avatar
Zhuohan Li committed
370
    user: Optional[str] = None
371
372

    # doc: begin-completion-sampling-params
373
374
375
376
377
378
    use_beam_search: bool = False
    top_k: int = -1
    min_p: float = 0.0
    repetition_penalty: float = 1.0
    length_penalty: float = 1.0
    early_stopping: bool = False
379
    stop_token_ids: Optional[List[int]] = Field(default_factory=list)
380
381
382
383
384
    include_stop_str_in_output: bool = False
    ignore_eos: bool = False
    min_tokens: int = 0
    skip_special_tokens: bool = True
    spaces_between_special_tokens: bool = True
385
    truncate_prompt_tokens: Optional[Annotated[int, Field(ge=1)]] = None
386
    allowed_token_ids: Optional[List[int]] = None
387
    prompt_logprobs: Optional[int] = None
388
389
390
    # doc: end-completion-sampling-params

    # doc: begin-completion-extra-params
391
392
    add_special_tokens: bool = Field(
        default=True,
393
        description=(
394
395
            "If true (the default), special tokens (e.g. BOS) will be added to "
            "the prompt."),
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
    )
    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."),
    )
423
424
425
426
427
428
    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'"))
429
430
431
432
433
    guided_whitespace_pattern: Optional[str] = Field(
        default=None,
        description=(
            "If specified, will override the default whitespace pattern "
            "for guided json decoding."))
434
435

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

437
    def to_sampling_params(
438
            self, tokenizer: AnyTokenizer,
439
440
441
442
443
444
            guided_decode_logits_processor: Optional[LogitsProcessor],
            default_max_tokens: int) -> SamplingParams:
        max_tokens = self.max_tokens
        if max_tokens is None:
            max_tokens = default_max_tokens

445
446
447
448
        prompt_logprobs = self.prompt_logprobs
        if prompt_logprobs is None and self.echo:
            prompt_logprobs = self.logprobs

449
450
        echo_without_generation = self.echo and self.max_tokens == 0

451
452
453
454
455
        logits_processors = get_logits_processors(
            logit_bias=self.logit_bias,
            allowed_token_ids=self.allowed_token_ids,
            tokenizer=tokenizer,
        )
456
457
        if guided_decode_logits_processor:
            logits_processors.append(guided_decode_logits_processor)
458

459
        return SamplingParams.from_optional(
460
461
462
463
464
465
466
467
468
            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
469
            seed=self.seed,
470
471
            stop=self.stop,
            stop_token_ids=self.stop_token_ids,
472
            logprobs=self.logprobs,
473
            ignore_eos=self.ignore_eos,
474
            max_tokens=max_tokens if not echo_without_generation else 1,
475
            min_tokens=self.min_tokens,
476
            use_beam_search=self.use_beam_search,
477
            early_stopping=self.early_stopping,
478
            prompt_logprobs=prompt_logprobs,
479
            skip_special_tokens=self.skip_special_tokens,
480
            spaces_between_special_tokens=self.spaces_between_special_tokens,
481
482
            include_stop_str_in_output=self.include_stop_str_in_output,
            length_penalty=self.length_penalty,
483
            logits_processors=logits_processors,
484
            truncate_prompt_tokens=self.truncate_prompt_tokens,
485
486
        )

487
488
489
490
491
492
493
494
495
496
497
498
499
500
    @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

501
502
503
    @model_validator(mode="before")
    @classmethod
    def check_logprobs(cls, data):
504
505
506
507
508
509
510
511
512
513
514
        if (prompt_logprobs := data.get("prompt_logprobs")) is not None:
            if data.get("stream") and prompt_logprobs > 0:
                raise ValueError(
                    "`prompt_logprobs` are not available when `stream=True`.")

            if prompt_logprobs < 0:
                raise ValueError("`prompt_logprobs` must be a positive value.")

        if (logprobs := data.get("logprobs")) is not None and logprobs < 0:
            raise ValueError("`logprobs` must be a positive value.")

515
516
        return data

517
518
519
520
521
    @model_validator(mode="before")
    @classmethod
    def validate_stream_options(cls, data):
        if data.get("stream_options") and not data.get("stream"):
            raise ValueError(
522
523
                "Stream options can only be defined when `stream=True`.")

524
525
        return data

Zhuohan Li's avatar
Zhuohan Li committed
526

527
class EmbeddingRequest(OpenAIBaseModel):
528
529
530
531
    # 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]]
532
    encoding_format: Literal["float", "base64"] = "float"
533
534
535
536
537
538
539
540
541
542
543
544
    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)


545
class CompletionLogProbs(OpenAIBaseModel):
Zhuohan Li's avatar
Zhuohan Li committed
546
547
548
    text_offset: List[int] = Field(default_factory=list)
    token_logprobs: List[Optional[float]] = Field(default_factory=list)
    tokens: List[str] = Field(default_factory=list)
549
550
    top_logprobs: List[Optional[Dict[str,
                                     float]]] = Field(default_factory=list)
Zhuohan Li's avatar
Zhuohan Li committed
551
552


553
class CompletionResponseChoice(OpenAIBaseModel):
Zhuohan Li's avatar
Zhuohan Li committed
554
555
    index: int
    text: str
556
    logprobs: Optional[CompletionLogProbs] = None
557
558
    finish_reason: Optional[str] = None
    stop_reason: Optional[Union[int, str]] = Field(
559
560
561
562
563
564
        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"),
    )
565
    prompt_logprobs: Optional[List[Optional[Dict[int, Logprob]]]] = None
Zhuohan Li's avatar
Zhuohan Li committed
566
567


568
class CompletionResponse(OpenAIBaseModel):
Zhuohan Li's avatar
Zhuohan Li committed
569
570
571
572
573
574
575
576
    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


577
class CompletionResponseStreamChoice(OpenAIBaseModel):
Zhuohan Li's avatar
Zhuohan Li committed
578
579
    index: int
    text: str
580
    logprobs: Optional[CompletionLogProbs] = None
581
582
    finish_reason: Optional[str] = None
    stop_reason: Optional[Union[int, str]] = Field(
583
584
585
586
587
588
        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
589
590


591
class CompletionStreamResponse(OpenAIBaseModel):
Zhuohan Li's avatar
Zhuohan Li committed
592
593
594
595
596
    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]
597
    usage: Optional[UsageInfo] = Field(default=None)
598
599


600
class EmbeddingResponseData(OpenAIBaseModel):
601
602
    index: int
    object: str = "embedding"
603
    embedding: Union[List[float], str]
604
605


606
class EmbeddingResponse(OpenAIBaseModel):
607
608
609
610
611
612
613
614
    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


615
616
617
618
619
620
621
622
623
624
625
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


626
class ChatMessage(OpenAIBaseModel):
627
628
    role: str
    content: str
629
    tool_calls: List[ToolCall] = Field(default_factory=list)
630
631


632
633
634
635
636
637
638
639
640
641
642
643
644
645
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


646
class ChatCompletionResponseChoice(OpenAIBaseModel):
647
648
    index: int
    message: ChatMessage
649
    logprobs: Optional[ChatCompletionLogProbs] = None
650
    finish_reason: Optional[str] = None
651
    stop_reason: Optional[Union[int, str]] = None
652
653


654
class ChatCompletionResponse(OpenAIBaseModel):
655
    id: str = Field(default_factory=lambda: f"chatcmpl-{random_uuid()}")
656
    object: Literal["chat.completion"] = "chat.completion"
657
658
659
660
    created: int = Field(default_factory=lambda: int(time.time()))
    model: str
    choices: List[ChatCompletionResponseChoice]
    usage: UsageInfo
661
    prompt_logprobs: Optional[List[Optional[Dict[int, Logprob]]]] = None
662
663


664
class DeltaMessage(OpenAIBaseModel):
665
666
    role: Optional[str] = None
    content: Optional[str] = None
667
    tool_calls: List[ToolCall] = Field(default_factory=list)
668
669


670
class ChatCompletionResponseStreamChoice(OpenAIBaseModel):
671
672
    index: int
    delta: DeltaMessage
673
    logprobs: Optional[ChatCompletionLogProbs] = None
674
    finish_reason: Optional[str] = None
675
    stop_reason: Optional[Union[int, str]] = None
676
677


678
class ChatCompletionStreamResponse(OpenAIBaseModel):
679
    id: str = Field(default_factory=lambda: f"chatcmpl-{random_uuid()}")
680
    object: Literal["chat.completion.chunk"] = "chat.completion.chunk"
681
682
683
    created: int = Field(default_factory=lambda: int(time.time()))
    model: str
    choices: List[ChatCompletionResponseStreamChoice]
684
    usage: Optional[UsageInfo] = Field(default=None)
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705


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

706
    # The parameters of the request.
707
    body: Union[ChatCompletionRequest, EmbeddingRequest]
708
709


710
711
712
713
714
715
716
717
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.
718
    body: Optional[Union[ChatCompletionResponse, EmbeddingResponse]] = None
719
720


721
722
723
724
725
726
727
728
729
730
731
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

732
    response: Optional[BatchResponseData]
733
734
735
736

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


739
740
741
742
743
744
745
746
747
748
749
class TokenizeCompletionRequest(OpenAIBaseModel):
    model: str
    prompt: str

    add_special_tokens: bool = Field(default=True)


class TokenizeChatRequest(OpenAIBaseModel):
    model: str
    messages: List[ChatCompletionMessageParam]

750
751
    add_generation_prompt: bool = Field(default=True)
    add_special_tokens: bool = Field(default=False)
752
753
754


TokenizeRequest = Union[TokenizeCompletionRequest, TokenizeChatRequest]
755
756
757
758
759


class TokenizeResponse(OpenAIBaseModel):
    count: int
    max_model_len: int
760
    tokens: List[int]
761
762
763
764
765
766
767
768
769


class DetokenizeRequest(OpenAIBaseModel):
    model: str
    tokens: List[int]


class DetokenizeResponse(OpenAIBaseModel):
    prompt: str