serving.py 78.7 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3

4
import asyncio
5
import json
6
import time
7
8
from collections.abc import AsyncGenerator, AsyncIterator
from collections.abc import Sequence as GenericSequence
9
from http import HTTPStatus
10
from typing import TYPE_CHECKING, Any, Final
11

12
import partial_json_parser
13
import regex as re
14
from fastapi import Request
15
from partial_json_parser.core.options import Allow
16

17
from vllm.engine.protocol import EngineClient
18
19
20
21
from vllm.entrypoints.chat_utils import (
    ChatTemplateContentFormatOption,
    ConversationMessage,
    get_history_tool_calls_cnt,
22
    get_tool_call_id_type,
23
24
    make_tool_call_id,
)
25
from vllm.entrypoints.logger import RequestLogger
26
from vllm.entrypoints.openai.chat_completion.protocol import (
27
28
29
30
31
32
33
34
35
36
    ChatCompletionLogProb,
    ChatCompletionLogProbs,
    ChatCompletionLogProbsContent,
    ChatCompletionNamedToolChoiceParam,
    ChatCompletionRequest,
    ChatCompletionResponse,
    ChatCompletionResponseChoice,
    ChatCompletionResponseStreamChoice,
    ChatCompletionStreamResponse,
    ChatMessage,
37
38
)
from vllm.entrypoints.openai.chat_completion.stream_harmony import (
39
    TokenState,
40
41
42
    extract_harmony_streaming_delta,
)
from vllm.entrypoints.openai.engine.protocol import (
43
44
45
46
    DeltaFunctionCall,
    DeltaMessage,
    DeltaToolCall,
    ErrorResponse,
47
    FunctionCall,
48
49
50
51
52
    PromptTokenUsageInfo,
    RequestResponseMetadata,
    ToolCall,
    UsageInfo,
)
53
from vllm.entrypoints.openai.engine.serving import (
54
55
56
57
    GenerationError,
    OpenAIServing,
    clamp_prompt_logprobs,
)
58
from vllm.entrypoints.openai.models.serving import OpenAIServingModels
59
60
61
62
63
from vllm.entrypoints.openai.parser.harmony_utils import (
    get_stop_tokens_for_assistant_actions,
    get_streamable_parser_for_assistant,
    parse_chat_output,
)
64
from vllm.entrypoints.openai.utils import maybe_filter_parallel_tool_calls
65
from vllm.entrypoints.utils import get_max_tokens, should_include_usage
66
from vllm.inputs import EngineInput
67
from vllm.logger import init_logger
68
from vllm.logprobs import Logprob
69
from vllm.outputs import CompletionOutput, RequestOutput
70
from vllm.parser import ParserManager
71
from vllm.parser.abstract_parser import Parser
72
from vllm.reasoning import ReasoningParser
73
from vllm.renderers import ChatParams
74
from vllm.sampling_params import BeamSearchParams, SamplingParams
75
from vllm.tokenizers import TokenizerLike
76
77
78
79
from vllm.tool_parsers.mistral_tool_parser import (
    MistralToolCall,
    MistralToolParser,
)
80
from vllm.tool_parsers.utils import partial_json_loads
81
from vllm.utils.collection_utils import as_list
82
from vllm.utils.mistral import is_mistral_tokenizer
83
84
85

if TYPE_CHECKING:
    from vllm.entrypoints.serve.render.serving import OpenAIServingRender
86
87
88
89
90

logger = init_logger(__name__)


class OpenAIServingChat(OpenAIServing):
91
92
93
    def __init__(
        self,
        engine_client: EngineClient,
94
        models: OpenAIServingModels,
95
96
        response_role: str,
        *,
97
        openai_serving_render: "OpenAIServingRender",
98
99
        request_logger: RequestLogger | None,
        chat_template: str | None,
100
        chat_template_content_format: ChatTemplateContentFormatOption,
101
        trust_request_chat_template: bool = False,
102
        return_tokens_as_token_ids: bool = False,
103
        reasoning_parser: str = "",
104
        enable_auto_tools: bool = False,
105
        exclude_tools_when_tool_choice_none: bool = False,
106
        tool_parser: str | None = None,
107
        enable_prompt_tokens_details: bool = False,
108
        enable_force_include_usage: bool = False,
109
        enable_log_outputs: bool = False,
110
        enable_log_deltas: bool = True,
111
        default_chat_template_kwargs: dict[str, Any] | None = None,
112
    ) -> None:
113
114
115
116
117
118
        super().__init__(
            engine_client=engine_client,
            models=models,
            request_logger=request_logger,
            return_tokens_as_token_ids=return_tokens_as_token_ids,
        )
119

120
        self.openai_serving_render = openai_serving_render
121
        self.response_role = response_role
122
123
        self.chat_template = chat_template
        self.chat_template_content_format: Final = chat_template_content_format
124
        self.trust_request_chat_template = trust_request_chat_template
125
        self.default_chat_template_kwargs = default_chat_template_kwargs or {}
126
        self.enable_log_outputs = enable_log_outputs
127
        self.enable_log_deltas = enable_log_deltas
128

129
        # set up reasoning parser
130
        self.reasoning_parser_cls = ParserManager.get_reasoning_parser(
131
132
            reasoning_parser_name=reasoning_parser
        )
133
134
        # set up tool use
        self.enable_auto_tools: bool = enable_auto_tools
135
136
137
138
        self.tool_parser = ParserManager.get_tool_parser(
            tool_parser_name=tool_parser,
            enable_auto_tools=enable_auto_tools,
            model_name=self.model_config.model,
139
        )
140
141
142
143
144
145
        self.parser_cls = ParserManager.get_parser(
            tool_parser_name=tool_parser,
            reasoning_parser_name=reasoning_parser,
            enable_auto_tools=enable_auto_tools,
            model_name=self.model_config.model,
        )
146
147
148
149
150
151
        _is_mistral_tool_parser = self.tool_parser is not None and issubclass(
            self.tool_parser, MistralToolParser
        )
        if _is_mistral_tool_parser and self.reasoning_parser_cls is not None:
            MistralToolParser.model_can_reason = True

152
        self.exclude_tools_when_tool_choice_none = exclude_tools_when_tool_choice_none
153

154
        self.enable_prompt_tokens_details = enable_prompt_tokens_details
155
        self.enable_force_include_usage = enable_force_include_usage
156
        self.default_sampling_params = self.model_config.get_diff_sampling_param()
157
158
159
160
161
162
        mc = self.model_config
        self.override_max_tokens = (
            self.default_sampling_params.get("max_tokens")
            if mc.generation_config not in ("auto", "vllm")
            else getattr(mc, "override_generation_config", {}).get("max_new_tokens")
        )
163
        self.use_harmony = self.model_config.hf_config.model_type == "gpt_oss"
164
165
166
167
        if self.use_harmony:
            if "stop_token_ids" not in self.default_sampling_params:
                self.default_sampling_params["stop_token_ids"] = []
            self.default_sampling_params["stop_token_ids"].extend(
168
169
                get_stop_tokens_for_assistant_actions()
            )
170

171
        self.tool_call_id_type = get_tool_call_id_type(self.model_config)
172

173
174
175
176
177
178
179
180
181
182
        # NOTE(woosuk): While OpenAI's chat completion API supports browsing
        # for some models, currently vLLM doesn't support it. Please use the
        # Responses API instead.
        self.supports_browsing = False
        self.browser_tool = None
        # NOTE(woosuk): Chat completion API does not support code interpreter.
        # Please use the Responses API instead.
        self.supports_code_interpreter = False
        self.python_tool = None

183
184
185
186
187
188
    def warmup(self) -> None:
        self.renderer.warmup(
            ChatParams(
                chat_template=self.chat_template,
                chat_template_content_format=self.chat_template_content_format,
                chat_template_kwargs=self.default_chat_template_kwargs,
189
            )
190
        )
191

192
    async def render_chat_request(
193
194
        self,
        request: ChatCompletionRequest,
195
    ) -> tuple[list[ConversationMessage], list[EngineInput]] | ErrorResponse:
196
        """
197
198
199
200
        Validate the model and preprocess a chat completion request.

        Delegates preprocessing logic to OpenAIServingRender, adding the
        engine-aware checks (LoRA model validation, engine health).
201

202
        Returns:
203
            A tuple of (conversation, engine_inputs) on success,
204
            or an ErrorResponse on failure.
205
206
207
        """
        error_check_ret = await self._check_model(request)
        if error_check_ret is not None:
208
            logger.error("Error with model %s", error_check_ret)
209
210
            return error_check_ret

211
212
213
214
215
216
        # If the engine is dead, raise the engine's DEAD_ERROR.
        # This is required for the streaming case, where we return a
        # success status before we actually start generating text :).
        if self.engine_client.errored:
            raise self.engine_client.dead_error

217
        return await self.openai_serving_render.render_chat(request)
218
219
220
221
222
223
224
225
226
227
228
229
230

    async def create_chat_completion(
        self,
        request: ChatCompletionRequest,
        raw_request: Request | None = None,
    ) -> AsyncGenerator[str, None] | ChatCompletionResponse | ErrorResponse:
        """
        Chat Completion API similar to OpenAI's API.

        See https://platform.openai.com/docs/api-reference/chat/create
        for the API specification. This API mimics the OpenAI
        Chat Completion API.
        """
231
232
233
        # Streaming response
        tokenizer = self.renderer.tokenizer
        assert tokenizer is not None
234
235
236
237
        chat_template_kwargs = self._prepare_extra_chat_template_kwargs(
            request.chat_template_kwargs,
            self.default_chat_template_kwargs,
        )
238
        reasoning_parser: ReasoningParser | None = None
239
240
241
242
243
        if self.reasoning_parser_cls:
            reasoning_parser = self.reasoning_parser_cls(
                tokenizer,
                chat_template_kwargs=chat_template_kwargs,  # type: ignore[call-arg]
            )
244
245
246
247
        result = await self.render_chat_request(request)
        if isinstance(result, ErrorResponse):
            return result

248
        conversation, engine_inputs = result
249

250
251
252
        request_id = (
            f"chatcmpl-{self._base_request_id(raw_request, request.request_id)}"
        )
253
254
255
256
257

        request_metadata = RequestResponseMetadata(request_id=request_id)
        if raw_request:
            raw_request.state.request_metadata = request_metadata

258
        lora_request = self._maybe_get_adapters(request, supports_default_mm_loras=True)
259

260
        model_name = self.models.model_name(lora_request)
261

262
263
264
        # Extract data_parallel_rank from header (router can inject it)
        data_parallel_rank = self._get_data_parallel_rank(raw_request)

265
        # Schedule the request and get the result generator.
266
        max_model_len = self.model_config.max_model_len
267
        generators: list[AsyncGenerator[RequestOutput, None]] = []
268
269
        for i, engine_input in enumerate(engine_inputs):
            prompt_token_ids = self._extract_prompt_components(engine_input).token_ids
270
271
272
273

            # If we are creating sub requests for multiple prompts, ensure that they
            # have unique request ids.
            sub_request_id = (
274
                request_id if len(engine_inputs) == 1 else f"{request_id}_{i}"
275
            )
276

277
278
279
280
281
            max_tokens = get_max_tokens(
                max_model_len,
                request.max_completion_tokens
                if request.max_completion_tokens is not None
                else request.max_tokens,
282
                self._extract_prompt_len(engine_input),
283
284
285
286
287
288
289
290
291
292
293
294
                self.default_sampling_params,
                self.override_max_tokens,
            )

            sampling_params: SamplingParams | BeamSearchParams
            if request.use_beam_search:
                sampling_params = request.to_beam_search_params(
                    max_tokens, self.default_sampling_params
                )
            else:
                sampling_params = request.to_sampling_params(
                    max_tokens,
295
                    self.default_sampling_params,
296
                )
297

298
299
            self._log_inputs(
                sub_request_id,
300
                engine_input,
301
302
303
                params=sampling_params,
                lora_request=lora_request,
            )
304

305
306
307
308
309
310
311
312
            trace_headers = (
                None
                if raw_request is None
                else await self._get_trace_headers(raw_request.headers)
            )

            if isinstance(sampling_params, BeamSearchParams):
                generator = self.beam_search(
313
                    prompt=engine_input,
314
                    request_id=sub_request_id,
315
316
                    params=sampling_params,
                    lora_request=lora_request,
317
                    trace_headers=trace_headers,
318
                )
319
            else:
320
321
                if not request.include_reasoning:
                    reasoning_ended = True
322
323
324
325
326
                elif request._grammar_from_tool_parser:
                    # The Mistral grammar already includes an optional
                    # `think?` rule that handles both reasoning and
                    # non-reasoning outputs.
                    reasoning_ended = True
327
328
329
330
331
332
                elif reasoning_parser:
                    reasoning_ended = reasoning_parser.is_reasoning_end(
                        prompt_token_ids or []
                    )
                else:
                    reasoning_ended = None
333

334
                generator = self.engine_client.generate(
335
                    engine_input,
336
337
338
339
340
341
342
343
                    sampling_params,
                    sub_request_id,
                    lora_request=lora_request,
                    trace_headers=trace_headers,
                    priority=request.priority,
                    data_parallel_rank=data_parallel_rank,
                    reasoning_ended=reasoning_ended,
                )
344

345
            generators.append(generator)
346

347
        assert len(generators) == 1
348
        (result_generator,) = generators
349

350
351
        if request.stream:
            return self.chat_completion_stream_generator(
352
353
354
355
356
357
358
                request,
                result_generator,
                request_id,
                model_name,
                conversation,
                tokenizer,
                request_metadata,
359
                reasoning_parser,
360
                chat_template_kwargs=chat_template_kwargs,
361
            )
362

363
364
365
366
367
368
369
370
371
372
        return await self.chat_completion_full_generator(
            request,
            result_generator,
            request_id,
            model_name,
            conversation,
            tokenizer,
            request_metadata,
            reasoning_parser,
        )
373
374
375
376

    def get_chat_request_role(self, request: ChatCompletionRequest) -> str:
        if request.add_generation_prompt:
            return self.response_role
377
        return request.messages[-1]["role"]
378

379
    @staticmethod
380
    def _bracket_level(s: str, opening="{", closing="}") -> int:
381
382
383
384
385
386
387
388
389
390
391
392
        """
        Calculate the current level of nested brackets in a given string.
        """
        level = 0
        for char in s:
            if char == opening:
                level += 1
            elif char == closing:
                level -= 1
        return level

    @staticmethod
393
    def _filter_delta_text(delta_text: str, previous_text: str) -> tuple[str, bool]:
394
395
396
397
398
399
400
401
402
        # remove last '},' of the tool definition stemming from the
        # "name"/"parameters" outer object or closing ']' of the tool list
        # count occurrences of opening and closing curly braces and
        # once level 0 is reached stop outputting text
        # if 0 is reached while parsing the delta_text we know the current
        # tool will finish in this current iteration
        bracket_level = OpenAIServingChat._bracket_level(previous_text)
        updated_delta, passed_zero = "", False
        for c in delta_text:
403
            if c == "{":
404
405
                bracket_level += 1
                passed_zero = bracket_level == 0
406
            elif c == "}":
407
408
409
410
411
412
413
                bracket_level -= 1
                passed_zero = bracket_level == 0

            if bracket_level != 0:
                updated_delta += c
            else:
                # if a comma is reached at level 0 we can stop
414
                if c == ",":
415
416
417
418
419
420
                    break
        return updated_delta, passed_zero

    def extract_tool_call_required_streaming(
        self,
        previous_text: str,
421
        current_text: str | None,
422
423
        delta_text: str,
        function_name_returned: bool,
424
425
        tool_call_idx: int | None = None,
    ) -> tuple[DeltaMessage | None, bool]:
426
427
428
        if current_text is None or current_text == "":
            # if the current text is empty, we cannot parse it
            return None, function_name_returned
429
        try:
430
431
432
433
434
435
            flags = Allow.ALL
            obj, _ = partial_json_loads(current_text, flags)
        except (
            partial_json_parser.core.exceptions.MalformedJSON,
            json.JSONDecodeError,
        ):
436
            logger.debug("not enough tokens to parse into JSON yet")
437
438
439
440
441
442
443
444
445
446
            obj = None

        # check if the current text is a valid array
        # containing a partial tool calling object
        # if not repeat
        if obj is None or not isinstance(obj, list) or not len(obj) > 0:
            function_name_returned = False
            delta_message = None
        else:
            _, finishes_previous_tool = OpenAIServingChat._filter_delta_text(
447
448
                delta_text, previous_text
            )
449
450
451
452
            # take the last tool call from the generated list
            current_tool_call = obj[-1]

            # once parameters have been generated the name is complete as well
453
454
455
            if not finishes_previous_tool and (
                "name" not in current_tool_call or "parameters" not in current_tool_call
            ):
456
457
458
459
460
                function_name_returned = False
                delta_message = None
            else:
                if not function_name_returned:
                    # get partly generated arguments from the latest tool call
461
462
463
                    param_match = re.search(
                        r'.*"parameters":\s*(.*)', current_text, re.DOTALL
                    )
464
465
                    arguments = param_match.group(1) if param_match else ""
                    arguments, _ = OpenAIServingChat._filter_delta_text(
466
467
                        arguments, previous_text
                    )
468
469
470
471

                    # if this iteration finishes a previous tool call but a
                    # new incomplete tool is already generated, take the
                    # previous from the list
472
                    if finishes_previous_tool and "parameters" not in current_tool_call:
473
474
475
                        current_tool_call = obj[-2]

                    function_name_returned = True
476
477
478
                    tool_call_id = make_tool_call_id(
                        id_type=self.tool_call_id_type,
                        func_name=current_tool_call["name"],
479
480
481
482
483
484
485
486
487
488
489
490
491
492
                        idx=tool_call_idx,
                    )
                    delta_message = DeltaMessage(
                        tool_calls=[
                            DeltaToolCall(
                                id=tool_call_id,
                                function=DeltaFunctionCall(
                                    name=current_tool_call["name"], arguments=arguments
                                ),
                                index=len(obj) - 1,
                                type="function",
                            )
                        ]
                    )
493
494
495

                else:
                    delta_text, _ = OpenAIServingChat._filter_delta_text(
496
497
                        delta_text, previous_text
                    )
498
499

                    if delta_text != "":
500
501
502
503
504
505
506
507
508
509
510
511
512
                        delta_message = DeltaMessage(
                            tool_calls=[
                                DeltaToolCall(
                                    function=DeltaFunctionCall(
                                        # OpenAI API returns None
                                        # instead of name every time
                                        name=None,
                                        arguments=delta_text,
                                    ),
                                    index=len(obj) - 1,
                                )
                            ]
                        )
513
514
515
516
517
                    else:
                        delta_message = None

        return delta_message, function_name_returned

518
    async def chat_completion_stream_generator(
519
520
521
522
        self,
        request: ChatCompletionRequest,
        result_generator: AsyncIterator[RequestOutput],
        request_id: str,
523
        model_name: str,
524
        conversation: list[ConversationMessage],
525
        tokenizer: TokenizerLike,
526
        request_metadata: RequestResponseMetadata,
527
        reasoning_parser: ReasoningParser | None = None,
528
        chat_template_kwargs: dict[str, Any] | None = None,
529
    ) -> AsyncGenerator[str, None]:
530
        created_time = int(time.time())
531
        chunk_object_type: Final = "chat.completion.chunk"
532
        first_iteration = True
533
534

        # Send response for each token for each request.n (index)
535
536
537
        num_choices = 1 if request.n is None else request.n
        previous_num_tokens = [0] * num_choices
        finish_reason_sent = [False] * num_choices
538
        num_prompt_tokens = 0
539
        num_cached_tokens = None
540
541
        if self.use_harmony:
            harmony_parsers = [
542
                get_streamable_parser_for_assistant() for _ in range(num_choices)
543
            ]
544
545
            harmony_tools_streamed = [False] * num_choices
        tools_streamed = [False] * num_choices
546

547
548
        is_mistral_grammar_path = request._grammar_from_tool_parser

549
550
551
552
553
554
555
556
        if isinstance(request.tool_choice, ChatCompletionNamedToolChoiceParam):
            tool_choice_function_name = request.tool_choice.function.name
        else:
            tool_choice_function_name = None

        # Determine whether tools are in use with "auto" tool choice
        tool_choice_auto = (
            not tool_choice_function_name
557
558
            and self._should_stream_with_auto_tool_parsing(request)
        )
559

560
561
562
563
564
565
566
567
568
569
570
571
572
573
        # Determine whether required/named tool_choice should fall back to
        # the auto tool_parser path instead of the standard JSON-based parsing.
        # This happens when the parser declares supports_required_and_named=False
        # (e.g. GLM models that output XML instead of JSON).
        tool_choice_uses_parser = (
            self.tool_parser is not None
            and not self.tool_parser.supports_required_and_named
            and request.tools
            and (
                request.tool_choice == "required"
                or isinstance(request.tool_choice, ChatCompletionNamedToolChoiceParam)
            )
        )

574
        all_previous_token_ids: list[list[int]] | None
575
        function_name_returned = [False] * num_choices
576
        if self.tool_call_id_type == "kimi_k2":
577
578
579
            history_tool_call_cnt = get_history_tool_calls_cnt(conversation)
        else:
            history_tool_call_cnt = 0
580

581
582
583
        # Always track previous_texts for comprehensive output logging
        previous_texts = [""] * num_choices

584
585
        # Only one of these will be used, thus previous_texts and
        # all_previous_token_ids will not be used twice in the same iteration.
586
587
588
589
590
591
        if (
            is_mistral_grammar_path
            or tool_choice_auto
            or tool_choice_uses_parser
            or reasoning_parser
        ):
592
            # These are only required in "auto" tool choice case
593
            all_previous_token_ids = [[] for _ in range(num_choices)]
594
            reasoning_end_arr = [False] * num_choices
595
            prompt_is_reasoning_end_arr: list[bool | None] = [None] * num_choices
596
        else:
597
            all_previous_token_ids = None
598

599
        try:
600
            if self.parser_cls is not None:
601
602
603
604
                if tokenizer is None:
                    raise ValueError(
                        "Tokenizer not available when `skip_tokenizer_init=True`"
                    )
605
606
607
608
609
610
                parsers: list[Parser | None] = [
                    self.parser_cls(
                        tokenizer,
                        request.tools,
                        chat_template_kwargs=chat_template_kwargs,
                    )
611
612
                    for _ in range(num_choices)
                ]
613
            else:
614
                parsers = [None] * num_choices
615
        except Exception as e:
616
            logger.exception("Error in parser creation.")
617
            data = self.create_streaming_error_response(e)
618
619
620
621
            yield f"data: {data}\n\n"
            yield "data: [DONE]\n\n"
            return

622
        stream_options = request.stream_options
623
624
625
        include_usage, include_continuous_usage = should_include_usage(
            stream_options, self.enable_force_include_usage
        )
626

627
628
        try:
            async for res in result_generator:
629
630
                if res.prompt_token_ids is not None:
                    num_prompt_tokens = len(res.prompt_token_ids)
631
632
                    if res.encoder_prompt_token_ids is not None:
                        num_prompt_tokens += len(res.encoder_prompt_token_ids)
633

634
635
636
637
                # We need to do it here, because if there are exceptions in
                # the result_generator, it needs to be sent as the FIRST
                # response (by the try...catch).
                if first_iteration:
638
                    num_cached_tokens = res.num_cached_tokens
639
640
                    # Send first response for each request.n (index) with
                    # the role
641
                    role = self.get_chat_request_role(request)
642
643
644

                    # NOTE num_choices defaults to 1 so this usually executes
                    # once per request
645
                    for i in range(num_choices):
646
647
                        choice_data = ChatCompletionResponseStreamChoice(
                            index=i,
648
649
650
651
                            delta=DeltaMessage(
                                role=role,
                                content="",
                            ),
652
                            logprobs=None,
653
654
                            finish_reason=None,
                        )
655
656

                        # return prompt_token_ids at the first chunk ever
657
658
659
660
661
                        chunk = ChatCompletionStreamResponse(
                            id=request_id,
                            object=chunk_object_type,
                            created=created_time,
                            choices=[choice_data],
662
                            model=model_name,
663
664
665
666
667
668
                            prompt_token_ids=(
                                res.prompt_token_ids
                                if request.return_token_ids
                                else None
                            ),
                        )
669

670
671
672
673
674
                        # if continuous usage stats are requested, add it
                        if include_continuous_usage:
                            chunk.usage = UsageInfo(
                                prompt_tokens=num_prompt_tokens,
                                completion_tokens=0,
675
676
                                total_tokens=num_prompt_tokens,
                            )
677

678
679
680
                        data = chunk.model_dump_json(exclude_unset=True)
                        yield f"data: {data}\n\n"

681
682
                    # Send response to echo the input portion of the
                    # last message
683
                    if request.echo:
684
                        last_msg_content: str | list[dict[str, str]] = ""
685
686
687
688
689
                        if (
                            conversation
                            and "content" in conversation[-1]
                            and conversation[-1].get("role") == role
                        ):
690
                            last_msg_content = conversation[-1]["content"] or ""
691
692

                        if last_msg_content:
693
                            for i in range(num_choices):
694
695
696
697
698
699
                                choice_data = ChatCompletionResponseStreamChoice(
                                    index=i,
                                    delta=DeltaMessage(content=last_msg_content),
                                    logprobs=None,
                                    finish_reason=None,
                                )
700
701
702
703
704
                                chunk = ChatCompletionStreamResponse(
                                    id=request_id,
                                    object=chunk_object_type,
                                    created=created_time,
                                    choices=[choice_data],
705
706
                                    model=model_name,
                                )
707
708
709
710
                                if include_continuous_usage:
                                    chunk.usage = UsageInfo(
                                        prompt_tokens=num_prompt_tokens,
                                        completion_tokens=0,
711
712
                                        total_tokens=num_prompt_tokens,
                                    )
713

714
                                data = chunk.model_dump_json(exclude_unset=True)
715
716
717
718
719
                                yield f"data: {data}\n\n"
                    first_iteration = False

                for output in res.outputs:
                    i = output.index
720
721
                    parser = parsers[i]
                    tool_parser = parser.tool_parser if parser is not None else None
722

723
                    if (
724
                        reasoning_parser
725
726
727
728
729
730
731
732
                        and res.prompt_token_ids
                        and prompt_is_reasoning_end_arr[i] is None
                    ):
                        # only check once per choice, because prompt_token_ids
                        # are the same for all deltas in that choice
                        prompt_is_reasoning_end_arr[i] = (
                            reasoning_parser.is_reasoning_end(res.prompt_token_ids)
                        )
733
734
735
                    if finish_reason_sent[i]:
                        continue

736
                    if request.logprobs and request.top_logprobs is not None:
737
                        assert output.logprobs is not None, "Did not output logprobs"
738
                        logprobs = self._create_chat_logprobs(
739
740
                            token_ids=output.token_ids,
                            top_logprobs=output.logprobs,
741
                            tokenizer=tokenizer,
742
                            num_output_top_logprobs=request.top_logprobs,
743
                            return_as_token_id=request.return_tokens_as_token_ids,
744
745
746
747
                        )
                    else:
                        logprobs = None

748
749
                    if self.use_harmony:
                        harmony_parser = harmony_parsers[i]
750
                        prev_recipient = harmony_parser.current_recipient
751
752
753

                        # Track accumulated content per token with their state
                        token_states: list[TokenState] = []
754
755
                        for token_id in output.token_ids:
                            harmony_parser.process(token_id)
756
757
758
759
760
761
762
763
764
                            token_delta = harmony_parser.last_content_delta or ""
                            token_states.append(
                                TokenState(
                                    harmony_parser.current_channel,
                                    harmony_parser.current_recipient,
                                    token_delta,
                                )
                            )
                        delta_text = "".join(delta for _, _, delta in token_states)
765
                        cur_channel = harmony_parser.current_channel
766

767
768
769
770
771
                        # handle the case where several tokens where generated at once
                        # including the final token, leading to a delta in the text
                        # but the current channel to be empty (start state)
                        if not cur_channel and delta_text:
                            cur_channel = "final"
772
773
                    else:
                        delta_text = output.text
774

775
776
777
778
779
                    if (
                        not delta_text
                        and not output.token_ids
                        and not previous_num_tokens[i]
                    ):
780
781
782
                        # Chunked prefill case, don't return empty chunks
                        continue

783
                    delta_message: DeltaMessage | None
784

785
                    # just update previous_texts and previous_token_ids
786
787
788
789
790
791
                    if (
                        is_mistral_grammar_path
                        or tool_choice_auto
                        or tool_choice_uses_parser
                        or reasoning_parser
                    ):
792
793
794
795
796
                        assert previous_texts is not None
                        assert all_previous_token_ids is not None
                        previous_text = previous_texts[i]
                        previous_token_ids = all_previous_token_ids[i]
                        current_text = previous_text + delta_text
797
798
                        # avoid the None + list error.
                        if previous_token_ids:
799
                            current_token_ids = previous_token_ids + as_list(
800
801
                                output.token_ids
                            )
802
                        else:
803
                            current_token_ids = as_list(output.token_ids)
804

805
                    if self.use_harmony:
806
807
808
                        delta_message, tools_streamed_flag = (
                            extract_harmony_streaming_delta(
                                harmony_parser=harmony_parser,
809
                                token_states=token_states,
810
811
812
813
814
                                prev_recipient=prev_recipient,
                                include_reasoning=request.include_reasoning,
                            )
                        )
                        harmony_tools_streamed[i] |= tools_streamed_flag
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
                    # Mistral grammar path: combined reasoning + tool streaming
                    elif is_mistral_grammar_path:
                        assert tool_parser is not None
                        assert isinstance(tool_parser, MistralToolParser)
                        assert reasoning_end_arr is not None
                        output_token_ids = as_list(output.token_ids)
                        result = tool_parser.extract_maybe_reasoning_and_tool_streaming(
                            reasoning_parser=reasoning_parser,
                            previous_text=previous_text,
                            current_text=current_text,
                            delta_text=delta_text,
                            previous_token_ids=previous_token_ids,
                            current_token_ids=current_token_ids,
                            output_token_ids=output_token_ids,
                            reasoning_ended=reasoning_end_arr[i],
                            prompt_is_reasoning_end=(prompt_is_reasoning_end_arr[i]),
                            request=request,
                        )
                        delta_message = result.delta_message
                        reasoning_end_arr[i] = result.reasoning_ended
                        current_text = result.current_text
                        current_token_ids = result.current_token_ids
                        if result.tools_called:
                            tools_streamed[i] = True
839
                    # handle streaming deltas for tools with named tool_choice
840
841
842
                    # Skip when tool_choice_uses_parser so it falls through
                    # to the auto tool_parser branches below.
                    elif tool_choice_function_name and not tool_choice_uses_parser:
843
844
845
846
847
848
849
850
851
852
853
                        # When encountering think end id in prompt_token_ids
                        # i.e {"enable_thinking": False},
                        # check BEFORE calling the parser to avoid a spurious
                        # reasoning delta on the first chunk.
                        if (
                            reasoning_parser
                            and not reasoning_end_arr[i]
                            and prompt_is_reasoning_end_arr[i]
                        ):
                            reasoning_end_arr[i] = True

854
                        if (
855
                            reasoning_parser
856
857
858
859
860
                            and not reasoning_end_arr[i]
                            and not reasoning_parser.is_reasoning_end(
                                previous_token_ids
                            )
                        ):
861
862
                            assert reasoning_parser is not None
                            delta_message = (
863
                                reasoning_parser.extract_reasoning_streaming(
864
865
866
867
868
869
                                    previous_text,
                                    current_text,
                                    delta_text,
                                    previous_token_ids,
                                    current_token_ids,
                                    output.token_ids,
870
871
                                )
                            )
872
                            # When encountering think end id in delta_token_ids,
873
                            # set reasoning status to end.
874
                            # Only keep 'content', remove 'reasoning'.
875
876
                            if reasoning_parser.is_reasoning_end(
                                as_list(output.token_ids)
877
                            ):
878
                                reasoning_end_arr[i] = True
879
880
881
882
883
884
885
                                if delta_message and delta_message.content:
                                    current_text = delta_message.content
                                    delta_message.content = None
                                else:
                                    current_text = ""
                        else:
                            # Just to add remaining `content`
886
                            if reasoning_parser:
887
888
889
                                delta_text = previous_text + delta_text
                                current_text = ""

890
891
                            if function_name_returned[i]:
                                delta_tool_call = DeltaToolCall(
892
893
894
                                    function=DeltaFunctionCall(arguments=delta_text),
                                    index=i,
                                )
895
                            else:
896
                                # Generate ID based on tokenizer type
897
                                if is_mistral_tokenizer(tokenizer):
898
899
900
901
902
903
904
                                    tool_call_id = MistralToolCall.generate_random_id()
                                else:
                                    tool_call_id = make_tool_call_id(
                                        id_type=self.tool_call_id_type,
                                        func_name=tool_choice_function_name,
                                        idx=history_tool_call_cnt,
                                    )
905
                                delta_tool_call = DeltaToolCall(
906
                                    id=tool_call_id,
907
908
909
                                    type="function",
                                    function=DeltaFunctionCall(
                                        name=tool_choice_function_name,
910
911
912
913
                                        arguments=delta_text,
                                    ),
                                    index=i,
                                )
914
                                function_name_returned[i] = True
915
                                history_tool_call_cnt += 1
916

917
918
919
920
921
                            delta_message = DeltaMessage(
                                tool_calls=[
                                    delta_tool_call,
                                ]
                            )
922
                            tools_streamed[i] = True
923

924
925
926
927
928
929
                    # Skip when tool_choice_uses_parser so it falls through
                    # to the auto tool_parser branches below.
                    elif (
                        request.tool_choice == "required"
                        and not tool_choice_uses_parser
                    ):
930
931
932
933
                        assert previous_texts is not None
                        previous_text = previous_texts[i]
                        current_text = previous_text + delta_text
                        fn_name_returned = function_name_returned[i]
934
935
936
                        output_token_ids = as_list(output.token_ids)

                        if (
937
                            reasoning_parser is not None
938
                            and not reasoning_end_arr[i]
939
                            and prompt_is_reasoning_end_arr[i]
940
941
                        ):
                            reasoning_end_arr[i] = True
942

943
                        if reasoning_parser and not reasoning_end_arr[i]:
944
                            delta_message = (
945
                                reasoning_parser.extract_reasoning_streaming(
946
947
948
949
950
951
952
                                    previous_text,
                                    current_text,
                                    delta_text,
                                    previous_token_ids,
                                    current_token_ids,
                                    output_token_ids,
                                )
953
                            )
954
955
956
957
958
959
960
961
962
                            if reasoning_parser.is_reasoning_end(output_token_ids):
                                reasoning_end_arr[i] = True
                                if delta_message and delta_message.content:
                                    current_text = delta_message.content
                                    delta_message.content = None
                                else:
                                    # reasoning ended
                                    current_text = ""

963
                        else:
964
                            # either finished reasoning or no reasoning at all
965
                            content = current_text
966
967
968
969
970
971
972
973
974

                            delta_message, function_name_returned[i] = (
                                self.extract_tool_call_required_streaming(
                                    previous_text=previous_text,
                                    current_text=content,
                                    delta_text=delta_text,
                                    function_name_returned=fn_name_returned,
                                    tool_call_idx=history_tool_call_cnt,
                                )
975
                            )
976
977
978
979
980
981
982
                            if (
                                delta_message
                                and delta_message.tool_calls
                                and delta_message.tool_calls[0].id is not None
                            ):
                                history_tool_call_cnt += 1
                                tools_streamed[i] = True
983

984
985
                    elif parser is not None:
                        delta_message = parser.parse_delta(
986
                            delta_text=delta_text,
987
                            delta_token_ids=as_list(output.token_ids),
988
                            request=request,
989
                            prompt_token_ids=res.prompt_token_ids,
990
                        )
991
992
                        if delta_message and delta_message.tool_calls:
                            tools_streamed[i] = True
993
                    # handle streaming just a content delta (no parsers)
994
995
996
                    else:
                        delta_message = DeltaMessage(content=delta_text)

997
                    # update the previous values for the next iteration
998
                    if (
999
1000
1001
1002
                        is_mistral_grammar_path
                        or tool_choice_auto
                        or tool_choice_uses_parser
                        or reasoning_parser
1003
                    ) and not self.use_harmony:
1004
1005
1006
1007
                        assert previous_texts is not None
                        assert all_previous_token_ids is not None
                        previous_texts[i] = current_text
                        all_previous_token_ids[i] = current_token_ids
1008
1009
1010
1011
                    else:
                        # Update for comprehensive logging even in simple case
                        assert previous_texts is not None
                        previous_texts[i] += delta_text
1012

1013
                    # set the previous values for the next iteration
1014
                    previous_num_tokens[i] += len(output.token_ids)
1015
1016
1017
1018
1019
1020

                    # if the message delta is None (e.g. because it was a
                    # "control token" for tool calls or the parser otherwise
                    # wasn't ready to send a token, then
                    #   get the next token without streaming a chunk
                    if delta_message is None:
1021
1022
1023
1024
1025
1026
1027
                        # NOTE: If return_token_ids is enabled, we still need to
                        # send a chunk with token_ids even if delta_message is None
                        # to ensure all tokens are included in the response
                        if (
                            output.finish_reason is None
                            and not request.return_token_ids
                        ):
1028
                            continue
1029
                        delta_message = DeltaMessage()
1030

1031
1032
                    # Log streaming delta if output logging is enabled
                    if self.enable_log_outputs and self.request_logger:
1033
                        delta_content_parts = []
1034
                        if delta_message.content:
1035
                            delta_content_parts.append(delta_message.content)
1036
1037
                        if delta_message.reasoning:
                            reasoning = delta_message.reasoning
1038
1039
1040
                            delta_content_parts.append(f"[reasoning: {reasoning}]")
                        if delta_message.tool_calls:
                            tool_args = "".join(
1041
1042
                                tc.function.arguments
                                for tc in delta_message.tool_calls
1043
1044
                                if tc.function and tc.function.arguments
                            )
1045
1046
                            if tool_args:
                                delta_content_parts.append(f"[tool_calls: {tool_args}]")
1047

1048
1049
                        if delta_content_parts and self.enable_log_deltas:
                            delta_content = " ".join(delta_content_parts)
1050
1051
1052
                            self.request_logger.log_outputs(
                                request_id=request_id,
                                outputs=delta_content,
1053
                                output_token_ids=as_list(output.token_ids),
1054
1055
1056
1057
1058
                                finish_reason=output.finish_reason,
                                is_streaming=True,
                                delta=True,
                            )

1059
1060
1061
1062
                    if output.finish_reason is None:
                        # Send token-by-token response for each request.n
                        choice_data = ChatCompletionResponseStreamChoice(
                            index=i,
1063
                            delta=delta_message,
1064
                            logprobs=logprobs,
1065
                            finish_reason=None,
1066
1067
1068
1069
1070
1071
                            token_ids=(
                                as_list(output.token_ids)
                                if request.return_token_ids
                                else None
                            ),
                        )
1072
1073

                    # if the model is finished generating
1074
                    else:
1075
1076
1077
1078
                        # check for error finish reason and abort streaming
                        # finish_reason='error' indicates a retryable error
                        self._raise_if_error(output.finish_reason, request_id)

1079
1080
1081
                        # check to make sure we haven't "forgotten" to stream
                        #   any tokens that were generated but previously
                        #   matched by partial json parsing
1082
                        # only happens if we are NOT using structured outputs
1083
                        index = 0
1084
                        auto_tools_called = False
1085
                        if tool_parser:
1086
1087
1088
1089
1090
1091
                            auto_tools_called = len(tool_parser.prev_tool_call_arr) > 0
                            index = (
                                len(tool_parser.prev_tool_call_arr) - 1
                                if auto_tools_called
                                else 0
                            )
1092
                        should_check = (
1093
1094
1095
                            self._should_check_for_unstreamed_tool_arg_tokens(
                                delta_message, output
                            )
1096
1097
1098
1099
                        )
                        # only check if there are any tool calls
                        # detected by partial parsing
                        if should_check and tool_parser and auto_tools_called:
1100
                            latest_delta_len = 0
1101
1102
                            if (
                                isinstance(
1103
                                    delta_message.tool_calls[0].function,
1104
1105
1106
1107
1108
                                    DeltaFunctionCall,
                                )
                            ) and isinstance(
                                delta_message.tool_calls[0].function.arguments, str
                            ):
1109
                                latest_delta_len = len(
1110
1111
                                    delta_message.tool_calls[0].function.arguments
                                )
1112

1113
                            # get the expected call based on partial JSON
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
                            # parsing which "autocompletes" the JSON.
                            # Tool parsers (e.g. Qwen3Coder) store
                            # arguments as a JSON string in
                            # prev_tool_call_arr. Calling json.dumps()
                            # on an already-serialized string would
                            # double-serialize it (e.g. '{"k":1}' becomes
                            # '"{\\"k\\":1}"'), which then causes the
                            # replace() below to fail and append the
                            # entire double-serialized string as a
                            # spurious final delta.
                            args = tool_parser.prev_tool_call_arr[index].get(
                                "arguments", {}
1126
                            )
1127
1128
1129
1130
                            if isinstance(args, str):
                                expected_call = args
                            else:
                                expected_call = json.dumps(args, ensure_ascii=False)
1131

1132
                            # get what we've streamed so far for arguments
1133
                            # for the current tool
1134
1135
                            actual_call = tool_parser.streamed_args_for_tool[index]
                            if latest_delta_len > 0:
1136
                                actual_call = actual_call[:-latest_delta_len]
1137
1138

                            # check to see if there's anything left to stream
1139
                            remaining_call = expected_call.replace(actual_call, "", 1)
1140
                            # set that as a delta message
1141
1142
                            delta_message = self._create_remaining_args_delta(
                                delta_message, remaining_call, index
1143
                            )
1144

1145
                        # Send the finish response for each request.n only once
1146
1147
1148
1149
                        # In OpenAI's API, when a tool is called, the
                        # finish_reason is:
                        # "tool_calls" for "auto" or "required" tool calls,
                        # and "stop" for named tool calls.
1150
1151
                        if (
                            auto_tools_called
1152
                            or (tools_streamed[i] and not tool_choice_function_name)
1153
1154
                            or (self.use_harmony and harmony_tools_streamed[i])
                        ):
1155
1156
                            finish_reason_ = "tool_calls"
                        else:
1157
1158
1159
                            finish_reason_ = (
                                output.finish_reason if output.finish_reason else "stop"
                            )
1160
1161
                        choice_data = ChatCompletionResponseStreamChoice(
                            index=i,
1162
                            delta=delta_message,
1163
                            logprobs=logprobs,
1164
                            finish_reason=finish_reason_,
1165
                            stop_reason=output.stop_reason,
1166
1167
1168
1169
1170
1171
                            token_ids=(
                                as_list(output.token_ids)
                                if request.return_token_ids
                                else None
                            ),
                        )
1172

1173
                        finish_reason_sent[i] = True
1174

1175
                    choice_data = maybe_filter_parallel_tool_calls(choice_data, request)
1176
1177
1178
1179
1180
                    chunk = ChatCompletionStreamResponse(
                        id=request_id,
                        object=chunk_object_type,
                        created=created_time,
                        choices=[choice_data],
1181
1182
                        model=model_name,
                    )
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192

                    # handle usage stats if requested & if continuous
                    if include_continuous_usage:
                        completion_tokens = previous_num_tokens[i]
                        chunk.usage = UsageInfo(
                            prompt_tokens=num_prompt_tokens,
                            completion_tokens=completion_tokens,
                            total_tokens=num_prompt_tokens + completion_tokens,
                        )

1193
                    data = chunk.model_dump_json(exclude_unset=True)
1194
1195
                    yield f"data: {data}\n\n"

1196
1197
            # once the final token is handled, if stream_options.include_usage
            # is sent, send the usage
1198
1199
            if include_usage:
                completion_tokens = sum(previous_num_tokens)
1200
1201
1202
1203
1204
                final_usage = UsageInfo(
                    prompt_tokens=num_prompt_tokens,
                    completion_tokens=completion_tokens,
                    total_tokens=num_prompt_tokens + completion_tokens,
                )
1205
1206
                if self.enable_prompt_tokens_details and num_cached_tokens:
                    final_usage.prompt_tokens_details = PromptTokenUsageInfo(
1207
1208
                        cached_tokens=num_cached_tokens
                    )
1209
1210
1211
1212
1213
1214
1215

                final_usage_chunk = ChatCompletionStreamResponse(
                    id=request_id,
                    object=chunk_object_type,
                    created=created_time,
                    choices=[],
                    model=model_name,
1216
1217
1218
1219
1220
                    usage=final_usage,
                )
                final_usage_data = final_usage_chunk.model_dump_json(
                    exclude_unset=True, exclude_none=True
                )
1221
                yield f"data: {final_usage_data}\n\n"
1222

1223
1224
1225
1226
1227
            # report to FastAPI middleware aggregate usage across all choices
            num_completion_tokens = sum(previous_num_tokens)
            request_metadata.final_usage_info = UsageInfo(
                prompt_tokens=num_prompt_tokens,
                completion_tokens=num_completion_tokens,
1228
1229
1230
1231
1232
1233
1234
1235
1236
                total_tokens=num_prompt_tokens + num_completion_tokens,
            )

            # Log complete streaming response if output logging is enabled
            if self.enable_log_outputs and self.request_logger:
                # Log the complete response for each choice
                for i in range(num_choices):
                    full_text = (
                        previous_texts[i]
1237
1238
                        if previous_texts and i < len(previous_texts)
                        else f"<streaming_complete: {previous_num_tokens[i]} tokens>"
1239
1240
1241
1242
                    )
                    self.request_logger.log_outputs(
                        request_id=request_id,
                        outputs=full_text,
1243
                        output_token_ids=None,  # Consider also logging all token IDs
1244
1245
1246
1247
                        finish_reason="streaming_complete",
                        is_streaming=True,
                        delta=False,
                    )
1248

1249
1250
        except GenerationError as e:
            yield f"data: {self._convert_generation_error_to_streaming_response(e)}\n\n"
1251
        except Exception as e:
1252
            logger.exception("Error in chat completion stream generator.")
1253
            data = self.create_streaming_error_response(e)
1254
            yield f"data: {data}\n\n"
1255
1256
1257
1258
        # Send the final done message after all response.n are finished
        yield "data: [DONE]\n\n"

    async def chat_completion_full_generator(
1259
1260
1261
1262
        self,
        request: ChatCompletionRequest,
        result_generator: AsyncIterator[RequestOutput],
        request_id: str,
1263
        model_name: str,
1264
        conversation: list[ConversationMessage],
1265
        tokenizer: TokenizerLike,
1266
        request_metadata: RequestResponseMetadata,
1267
        reasoning_parser: ReasoningParser | None = None,
1268
    ) -> ErrorResponse | ChatCompletionResponse:
1269
1270
        from vllm.tokenizers.mistral import MistralTokenizer

1271
        created_time = int(time.time())
1272
        final_res: RequestOutput | None = None
1273

1274
1275
1276
1277
1278
1279
        try:
            async for res in result_generator:
                final_res = res
        except asyncio.CancelledError:
            return self.create_error_response("Client disconnected")

1280
1281
1282
1283
1284
1285
        if final_res is None:
            return self.create_error_response(
                "No output received from the engine.",
                err_type="InternalServerError",
                status_code=HTTPStatus.INTERNAL_SERVER_ERROR,
            )
1286

1287
        choices: list[ChatCompletionResponseChoice] = []
1288
        if self.tool_call_id_type == "kimi_k2":
1289
1290
1291
            history_tool_call_cnt = get_history_tool_calls_cnt(conversation)
        else:
            history_tool_call_cnt = 0
1292

1293
1294
        role = self.get_chat_request_role(request)
        for output in final_res.outputs:
1295
1296
1297
            # check for error finish reason and raise GenerationError
            # finish_reason='error' indicates a retryable request-level internal error
            self._raise_if_error(output.finish_reason, request_id)
1298
            token_ids = output.token_ids
1299
            out_logprobs = output.logprobs
1300
            tool_call_info = None
1301

1302
1303
            if request.logprobs and request.top_logprobs is not None:
                assert out_logprobs is not None, "Did not output logprobs"
1304
                logprobs = self._create_chat_logprobs(
1305
                    token_ids=token_ids,
1306
                    top_logprobs=out_logprobs,
1307
                    num_output_top_logprobs=request.top_logprobs,
1308
                    tokenizer=tokenizer,
1309
                    return_as_token_id=request.return_tokens_as_token_ids,
1310
1311
1312
                )
            else:
                logprobs = None
1313
1314

            if self.use_harmony:
1315
                reasoning, content, _ = parse_chat_output(token_ids)
1316
                if not request.include_reasoning:
1317
                    reasoning = None
1318

1319
                if self.tool_parser is not None:
1320
1321
1322
1323
1324
                    if tokenizer is None:
                        raise ValueError(
                            "Tokenizer not available when `skip_tokenizer_init=True`"
                        )

1325
                    tool_parser = self.tool_parser(tokenizer, request.tools)
1326
1327
1328
1329
1330
1331
                    # NOTE: We use token_ids for openai tool parser
                    tool_call_info = tool_parser.extract_tool_calls(
                        "",
                        request=request,
                        token_ids=token_ids,  # type: ignore
                    )
1332
                    content = tool_call_info.content
1333
1334
                    message = ChatMessage(
                        role=role,
1335
                        reasoning=reasoning,
1336
1337
1338
1339
1340
1341
                        content=content,
                        tool_calls=tool_call_info.tool_calls,
                    )
                else:
                    message = ChatMessage(
                        role=role,
1342
                        reasoning=reasoning,
1343
1344
                        content=content,
                    )
1345
1346
1347
1348
1349

                choice_data = ChatCompletionResponseChoice(
                    index=output.index,
                    message=message,
                    logprobs=logprobs,
1350
1351
1352
1353
1354
1355
1356
                    finish_reason=(
                        "tool_calls"
                        if (tool_call_info is not None and tool_call_info.tools_called)
                        else output.finish_reason
                        if output.finish_reason
                        else "stop"
                    ),
1357
                    stop_reason=output.stop_reason,
1358
1359
1360
                    token_ids=(
                        as_list(output.token_ids) if request.return_token_ids else None
                    ),
1361
1362
1363
                )
                choices.append(choice_data)
                continue
1364

1365
            if reasoning_parser:
1366
1367
                # If the reasoning parser is enabled,
                # tool calls are extracted exclusively from the content.
1368
                reasoning, content = reasoning_parser.extract_reasoning(
1369
1370
                    output.text, request=request
                )
1371
                if not request.include_reasoning:
1372
                    reasoning = None
1373
            else:
1374
                reasoning = None
1375
                content = output.text
1376

1377
            auto_tools_called = False
1378
1379
            # if auto tools are not enabled, and a named tool choice using
            #   outlines is not being used
1380
1381
1382
1383
1384
1385
1386
1387
            tool_calls, content = self._parse_tool_calls_from_content(
                request=request,
                tokenizer=tokenizer,
                content=content,
                enable_auto_tools=self.enable_auto_tools,
                tool_parser_cls=self.tool_parser,
            )
            tool_call_class = (
1388
                MistralToolCall if is_mistral_tokenizer(tokenizer) else ToolCall
1389
            )
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407

            use_mistral_tool_parser = request._grammar_from_tool_parser
            if use_mistral_tool_parser:
                tool_call_items = MistralToolParser.build_non_streaming_tool_calls(
                    tool_calls
                )
                if tool_call_items:
                    auto_tools_called = (
                        request.tool_choice is None or request.tool_choice == "auto"
                    )
                message = ChatMessage(
                    role=role,
                    reasoning=reasoning,
                    content=content,
                    tool_calls=tool_call_items,
                )

            elif (not self.enable_auto_tools or not self.tool_parser) and (
1408
1409
1410
                not isinstance(request.tool_choice, ChatCompletionNamedToolChoiceParam)
                and request.tool_choice != "required"
            ):
1411
                message = ChatMessage(role=role, reasoning=reasoning, content=content)
1412

1413
1414
1415
1416
            elif (
                request.tool_choice
                and type(request.tool_choice) is ChatCompletionNamedToolChoiceParam
            ):
1417
                assert tool_calls is not None and len(tool_calls) > 0
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
                tool_call_class_items = []
                for idx, tc in enumerate(tool_calls):
                    # Use native ID if available (e.g., Kimi K2),
                    # otherwise generate ID with correct id_type
                    if tc.id:
                        tool_call_class_items.append(
                            tool_call_class(id=tc.id, function=tc)
                        )
                    else:
                        # Generate ID using the correct format (kimi_k2 or random),
                        # but leave it to the class if it's Mistral to preserve
                        # 9-char IDs
                        if isinstance(tokenizer, MistralTokenizer):
                            tool_call_class_items.append(tool_call_class(function=tc))
                        else:
                            generated_id = make_tool_call_id(
                                id_type=self.tool_call_id_type,
                                func_name=tc.name,
1436
                                idx=history_tool_call_cnt,
1437
1438
1439
1440
1441
                            )
                            tool_call_class_items.append(
                                tool_call_class(id=generated_id, function=tc)
                            )
                    history_tool_call_cnt += 1
1442
1443
                message = ChatMessage(
                    role=role,
1444
                    reasoning=reasoning,
1445
                    content="",
1446
                    tool_calls=tool_call_class_items,
1447
                )
1448

1449
            elif request.tool_choice and request.tool_choice == "required":
1450
                tool_call_class_items = []
1451
                tool_calls = tool_calls or []
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
                for idx, tool_call in enumerate(tool_calls):
                    # Use native ID if available,
                    # otherwise generate ID with correct id_type
                    if tool_call.id:
                        tool_call_class_items.append(
                            tool_call_class(id=tool_call.id, function=tool_call)
                        )
                    else:
                        # Generate ID using the correct format (kimi_k2 or random),
                        # but leave it to the class if it's Mistral to preserve
                        # 9-char IDs
                        if isinstance(tokenizer, MistralTokenizer):
                            tool_call_class_items.append(
                                tool_call_class(function=tool_call)
                            )
                        else:
                            generated_id = make_tool_call_id(
1469
1470
                                id_type=self.tool_call_id_type,
                                func_name=tool_call.name,
1471
                                idx=history_tool_call_cnt,
1472
1473
1474
1475
                            )
                            tool_call_class_items.append(
                                tool_call_class(id=generated_id, function=tool_call)
                            )
1476
                    history_tool_call_cnt += 1
1477
1478
1479
                message = ChatMessage(
                    role=role,
                    content="",
1480
                    tool_calls=tool_call_class_items,
1481
                    reasoning=reasoning,
1482
                )
1483

1484
1485
            # if the request doesn't use tool choice
            # OR specifies to not use a tool
1486
            elif not request.tool_choice or request.tool_choice == "none":
1487
                message = ChatMessage(role=role, reasoning=reasoning, content=content)
1488
1489

            # handle when there are tools and tool choice is auto
1490
1491
1492
1493
1494
1495
            elif (
                request.tools
                and (request.tool_choice == "auto" or request.tool_choice is None)
                and self.enable_auto_tools
                and self.tool_parser
            ):
1496
1497
1498
                # In the OpenAI API the finish_reason is "tools_called"
                # if the tool choice is auto and the model produced a tool
                # call. The same is not true for named function calls
1499
1500
                auto_tools_called = tool_calls is not None and len(tool_calls) > 0
                if tool_calls:
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
                    tool_call_items = []
                    for idx, tc in enumerate(tool_calls):
                        # Use native ID if available (e.g., Kimi K2),
                        # otherwise generate ID with correct id_type
                        if tc.id:
                            tool_call_items.append(
                                tool_call_class(id=tc.id, function=tc)
                            )
                        else:
                            # Generate ID using the correct format (kimi_k2 or random),
                            # but leave it to the class if it's Mistral to preserve
                            # 9-char IDs
                            if isinstance(tokenizer, MistralTokenizer):
                                tool_call_items.append(tool_call_class(function=tc))
                            else:
                                generated_id = make_tool_call_id(
                                    id_type=self.tool_call_id_type,
                                    func_name=tc.name,
1519
                                    idx=history_tool_call_cnt,
1520
1521
1522
1523
1524
                                )
                                tool_call_items.append(
                                    tool_call_class(id=generated_id, function=tc)
                                )
                        history_tool_call_cnt += 1
1525
1526
                    message = ChatMessage(
                        role=role,
1527
                        reasoning=reasoning,
1528
                        content=content,
1529
                        tool_calls=tool_call_items,
1530
                    )
1531
1532
1533
1534

                else:
                    # FOR NOW make it a chat message; we will have to detect
                    # the type to make it later.
1535
1536
1537
1538
                    ret_content = content

                    # try to use content return from tool parser first,
                    # tool parser may do some modify for the content.
1539
1540
                    if content and len(content) > 0:
                        ret_content = content
1541
1542
                    message = ChatMessage(
                        role=role,
1543
                        reasoning=reasoning,
1544
1545
                        content=ret_content,
                    )
1546
1547
1548
1549
1550
1551

            # undetermined case that is still important to handle
            else:
                logger.error(
                    "Error in chat_completion_full_generator - cannot determine"
                    " if tools should be extracted. Returning a standard chat "
1552
1553
                    "completion."
                )
1554
                message = ChatMessage(role=role, reasoning=reasoning, content=content)
1555
1556
1557
1558
1559
1560
1561
1562
            # In OpenAI's API, when a tool is called, the finish_reason is:
            # "tool_calls" for "auto" or "required" tool calls,
            # and "stop" for named tool calls.
            is_finish_reason_tool_calls = auto_tools_called or (
                request.tool_choice
                and request.tool_choice == "required"
                and output.finish_reason == "stop"
            )
1563

1564
1565
            choice_data = ChatCompletionResponseChoice(
                index=output.index,
1566
                message=message,
1567
                logprobs=logprobs,
1568
1569
1570
1571
1572
                finish_reason="tool_calls"
                if is_finish_reason_tool_calls
                else output.finish_reason
                if output.finish_reason
                else "stop",
1573
                stop_reason=output.stop_reason,
1574
1575
1576
                token_ids=(
                    as_list(output.token_ids) if request.return_token_ids else None
                ),
1577
            )
1578
            choice_data = maybe_filter_parallel_tool_calls(choice_data, request)
1579

1580
1581
            choices.append(choice_data)

1582
        if request.echo:
1583
            last_msg_content: str | list[dict[str, str]] = ""
1584
1585
1586
1587
1588
            if (
                conversation
                and "content" in conversation[-1]
                and conversation[-1].get("role") == role
            ):
1589
                last_msg_content = conversation[-1]["content"] or ""
1590
            if isinstance(last_msg_content, list):
1591
                last_msg_content = "\n".join(msg["text"] for msg in last_msg_content)
1592
1593

            for choice in choices:
1594
                full_message = last_msg_content + (choice.message.content or "")
1595
1596
                choice.message.content = full_message

1597
        assert final_res.prompt_token_ids is not None
1598
        num_prompt_tokens = len(final_res.prompt_token_ids)
1599
1600
        if final_res.encoder_prompt_token_ids is not None:
            num_prompt_tokens += len(final_res.encoder_prompt_token_ids)
1601
        num_generated_tokens = sum(
1602
1603
1604
1605
1606
1607
1608
            len(output.token_ids) for output in final_res.outputs
        )
        usage = UsageInfo(
            prompt_tokens=num_prompt_tokens,
            completion_tokens=num_generated_tokens,
            total_tokens=num_prompt_tokens + num_generated_tokens,
        )
1609
1610
        if self.enable_prompt_tokens_details and final_res.num_cached_tokens:
            usage.prompt_tokens_details = PromptTokenUsageInfo(
1611
1612
                cached_tokens=final_res.num_cached_tokens
            )
1613
1614
1615

        request_metadata.final_usage_info = usage

1616
1617
1618
1619
1620
1621
        response = ChatCompletionResponse(
            id=request_id,
            created=created_time,
            model=model_name,
            choices=choices,
            usage=usage,
1622
            prompt_logprobs=clamp_prompt_logprobs(final_res.prompt_logprobs),
1623
1624
1625
            prompt_token_ids=(
                final_res.prompt_token_ids if request.return_token_ids else None
            ),
Robert Shaw's avatar
Robert Shaw committed
1626
            kv_transfer_params=final_res.kv_transfer_params,
1627
1628
        )

1629
1630
1631
1632
1633
1634
1635
1636
1637
        # Log complete response if output logging is enabled
        if self.enable_log_outputs and self.request_logger:
            for choice in choices:
                output_text = ""
                if choice.message.content:
                    output_text = choice.message.content
                elif choice.message.tool_calls:
                    # For tool calls, log the function name and arguments
                    tool_call_descriptions = []
1638
1639
1640
1641
1642
                    for tc in choice.message.tool_calls:  # type: ignore
                        function_call: FunctionCall = tc.function  # type: ignore
                        tool_call_descriptions.append(
                            f"{function_call.name}({function_call.arguments})"
                        )
1643
1644
1645
1646
1647
1648
1649
                    tool_calls_str = ", ".join(tool_call_descriptions)
                    output_text = f"[tool_calls: {tool_calls_str}]"

                if output_text:
                    # Get the corresponding output token IDs
                    output_token_ids = None
                    if choice.index < len(final_res.outputs):
1650
                        output_token_ids = final_res.outputs[choice.index].token_ids
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660

                    self.request_logger.log_outputs(
                        request_id=request_id,
                        outputs=output_text,
                        output_token_ids=output_token_ids,
                        finish_reason=choice.finish_reason,
                        is_streaming=False,
                        delta=False,
                    )

1661
        return response
1662
1663

    def _get_top_logprobs(
1664
1665
        self,
        logprobs: dict[int, Logprob],
1666
        top_logprobs: int | None,
1667
        tokenizer: TokenizerLike | None,
1668
1669
        should_return_as_token_id: bool,
    ) -> list[ChatCompletionLogProb]:
1670
        return [
1671
            ChatCompletionLogProb(
1672
1673
1674
1675
1676
1677
1678
1679
                token=(
                    token := self._get_decoded_token(
                        p[1],
                        p[0],
                        tokenizer,
                        return_as_token_id=should_return_as_token_id,
                    )
                ),
1680
1681
                logprob=max(p[1].logprob, -9999.0),
                bytes=list(token.encode("utf-8", errors="replace")),
1682
1683
            )
            for i, p in enumerate(logprobs.items())
1684
            if (top_logprobs and i < top_logprobs or top_logprobs == -1)
1685
1686
1687
1688
1689
        ]

    def _create_chat_logprobs(
        self,
        token_ids: GenericSequence[int],
1690
        top_logprobs: GenericSequence[dict[int, Logprob] | None],
1691
        tokenizer: TokenizerLike | None,
1692
1693
        num_output_top_logprobs: int | None = None,
        return_as_token_id: bool | None = None,
1694
1695
    ) -> ChatCompletionLogProbs:
        """Create OpenAI-style logprobs."""
1696
        logprobs_content: list[ChatCompletionLogProbsContent] = []
1697

1698
1699
1700
1701
1702
        should_return_as_token_id = (
            return_as_token_id
            if return_as_token_id is not None
            else self.return_tokens_as_token_ids
        )
1703
1704
        for i, token_id in enumerate(token_ids):
            step_top_logprobs = top_logprobs[i]
1705
            if step_top_logprobs is None or step_top_logprobs.get(token_id) is None:
1706
                if should_return_as_token_id:
1707
                    token = f"token_id:{token_id}"
1708
                else:
1709
1710
                    if tokenizer is None:
                        raise ValueError(
1711
                            "Unable to get tokenizer because `skip_tokenizer_init=True`"
1712
1713
                        )

1714
                    token = tokenizer.decode(token_id)
1715

1716
1717
                logprobs_content.append(
                    ChatCompletionLogProbsContent(
1718
                        token=token,
1719
                        bytes=list(token.encode("utf-8", errors="replace")),
1720
1721
                    )
                )
1722
            else:
1723
1724
1725
                step_token = step_top_logprobs[token_id]
                step_decoded = step_token.decoded_token

1726
1727
                logprobs_content.append(
                    ChatCompletionLogProbsContent(
1728
                        token=self._get_decoded_token(
1729
1730
1731
                            step_token,
                            token_id,
                            tokenizer,
1732
                            should_return_as_token_id,
1733
1734
                        ),
                        logprob=max(step_token.logprob, -9999.0),
1735
1736
1737
1738
1739
                        bytes=(
                            None
                            if step_decoded is None
                            else list(step_decoded.encode("utf-8", errors="replace"))
                        ),
1740
                        top_logprobs=self._get_top_logprobs(
1741
1742
1743
1744
1745
1746
1747
                            step_top_logprobs,
                            num_output_top_logprobs,
                            tokenizer,
                            should_return_as_token_id,
                        ),
                    )
                )
1748
1749

        return ChatCompletionLogProbs(content=logprobs_content)
1750

1751
    def _should_stream_with_auto_tool_parsing(self, request: ChatCompletionRequest):
1752
1753
1754
1755
1756
1757
1758
1759
        """
        Utility function to check if streamed tokens should go through the tool
        call parser that was configured.

        We only want to do this IF user-provided tools are set, a tool parser
        is configured, "auto" tool choice is enabled, and the request's tool
        choice field indicates that "auto" tool choice should be used.
        """
1760
1761
1762
1763
1764
1765
        return (
            request.tools
            and self.tool_parser
            and self.enable_auto_tools
            and request.tool_choice in ["auto", None]
        )
1766
1767
1768

    def _should_check_for_unstreamed_tool_arg_tokens(
        self,
1769
        delta_message: DeltaMessage | None,
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
        output: CompletionOutput,
    ) -> bool:
        """
        Check to see if we should check for unstreamed tool arguments tokens.
        This is only applicable when auto tool parsing is enabled, the delta
        is a tool call with arguments.
        """

        return bool(
            # if there is a delta message that includes tool calls which
            # include a function that has arguments
1781
            output.finish_reason is not None
1782
1783
1784
1785
1786
            and self.enable_auto_tools
            and self.tool_parser
            and delta_message
            and delta_message.tool_calls
            and delta_message.tool_calls[0]
1787
1788
1789
            and delta_message.tool_calls[0].function
            and delta_message.tool_calls[0].function.arguments is not None
        )
1790

1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
    @staticmethod
    def _create_remaining_args_delta(
        delta_message: DeltaMessage,
        remaining_call: str,
        index: int,
    ) -> DeltaMessage:
        """
        Create a delta message for remaining tool arguments, preserving
        id/type/name from the original delta.
        """
        original_tc = next(
            (tc for tc in delta_message.tool_calls if tc.index == index),
            None,
        )
        original_fn = original_tc.function if original_tc else None
        return DeltaMessage(
            tool_calls=[
                DeltaToolCall(
                    index=index,
                    id=original_tc.id if original_tc else None,
                    type=original_tc.type if original_tc else None,
                    function=DeltaFunctionCall(
                        name=original_fn.name if original_fn else None,
                        arguments=remaining_call,
                    ),
                )
            ]
        )