serving.py 79.2 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 typing import TYPE_CHECKING, Any, Final
10

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

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

if TYPE_CHECKING:
    from vllm.entrypoints.serve.render.serving import OpenAIServingRender
81
82
83
84
85

logger = init_logger(__name__)


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

115
        self.openai_serving_render = openai_serving_render
116
        self.response_role = response_role
117
118
        self.chat_template = chat_template
        self.chat_template_content_format: Final = chat_template_content_format
119
        self.trust_request_chat_template = trust_request_chat_template
120
        self.default_chat_template_kwargs = default_chat_template_kwargs or {}
121
        self.enable_log_outputs = enable_log_outputs
122
        self.enable_log_deltas = enable_log_deltas
123

124
        # set up reasoning parser
125
        self.reasoning_parser_cls = ParserManager.get_reasoning_parser(
126
127
            reasoning_parser_name=reasoning_parser
        )
128
129
        # set up tool use
        self.enable_auto_tools: bool = enable_auto_tools
130
131
132
133
        self.tool_parser = ParserManager.get_tool_parser(
            tool_parser_name=tool_parser,
            enable_auto_tools=enable_auto_tools,
            model_name=self.model_config.model,
134
135
        )
        self.exclude_tools_when_tool_choice_none = exclude_tools_when_tool_choice_none
136

137
        self.enable_prompt_tokens_details = enable_prompt_tokens_details
138
        self.enable_force_include_usage = enable_force_include_usage
139
        self.default_sampling_params = self.model_config.get_diff_sampling_param()
140
141
142
143
144
145
        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")
        )
146
        self.use_harmony = self.model_config.hf_config.model_type == "gpt_oss"
147
148
149
150
        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(
151
152
                get_stop_tokens_for_assistant_actions()
            )
153

154
155
156
157
158
159
160
161
162
163
        # Handle tool call ID type for Kimi K2 (supporting test mocking via overrides)
        hf_overrides = getattr(self.model_config, "hf_overrides", None)
        if self.model_config.hf_text_config.model_type == "kimi_k2" or (
            isinstance(hf_overrides, dict)
            and hf_overrides.get("model_type") == "kimi_k2"
        ):
            self.tool_call_id_type = "kimi_k2"
        else:
            self.tool_call_id_type = "random"

164
165
166
167
168
169
170
171
172
173
        # 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

174
175
176
177
178
179
    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,
180
            )
181
        )
182

183
    async def render_chat_request(
184
185
        self,
        request: ChatCompletionRequest,
186
    ) -> tuple[list[ConversationMessage], list[ProcessorInputs]] | ErrorResponse:
187
        """
188
189
190
191
        Validate the model and preprocess a chat completion request.

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

193
194
195
        Returns:
            A tuple of (conversation, engine_prompts) on success,
            or an ErrorResponse on failure.
196
197
198
        """
        error_check_ret = await self._check_model(request)
        if error_check_ret is not None:
199
            logger.error("Error with model %s", error_check_ret)
200
201
            return error_check_ret

202
203
204
205
206
207
        # 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

208
        return await self.openai_serving_render.render_chat(request)
209
210
211
212
213
214
215
216
217
218
219
220
221

    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.
        """
222
223
224
225
        # Streaming response
        tokenizer = self.renderer.tokenizer
        assert tokenizer is not None
        reasoning_parser: ReasoningParser | None = None
226
227
228
229
230
231
232
233
234
235
        if self.reasoning_parser_cls:
            # Pass the same chat template kwargs as used in tokenization
            chat_template_kwargs = self._prepare_extra_chat_template_kwargs(
                request.chat_template_kwargs,
                self.default_chat_template_kwargs,
            )
            reasoning_parser = self.reasoning_parser_cls(
                tokenizer,
                chat_template_kwargs=chat_template_kwargs,  # type: ignore[call-arg]
            )
236
237
238
239
240
        result = await self.render_chat_request(request)
        if isinstance(result, ErrorResponse):
            return result

        conversation, engine_prompts = result
241

242
243
244
        request_id = (
            f"chatcmpl-{self._base_request_id(raw_request, request.request_id)}"
        )
245
246
247
248
249

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

250
        lora_request = self._maybe_get_adapters(request, supports_default_mm_loras=True)
251

252
        model_name = self.models.model_name(lora_request)
253

254
255
256
        # Extract data_parallel_rank from header (router can inject it)
        data_parallel_rank = self._get_data_parallel_rank(raw_request)

257
        # Schedule the request and get the result generator.
258
        max_model_len = self.model_config.max_model_len
259
        generators: list[AsyncGenerator[RequestOutput, None]] = []
260
261
262
263
264
265
266
267
        for i, engine_prompt in enumerate(engine_prompts):
            prompt_token_ids = self._extract_prompt_components(engine_prompt).token_ids

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

269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
            max_tokens = get_max_tokens(
                max_model_len,
                request.max_completion_tokens
                if request.max_completion_tokens is not None
                else request.max_tokens,
                self._extract_prompt_len(engine_prompt),
                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,
287
                    self.default_sampling_params,
288
                )
289

290
291
292
293
294
295
            self._log_inputs(
                sub_request_id,
                engine_prompt,
                params=sampling_params,
                lora_request=lora_request,
            )
296

297
298
299
300
301
302
303
304
305
306
            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(
                    prompt=engine_prompt,
                    request_id=sub_request_id,
307
308
                    params=sampling_params,
                    lora_request=lora_request,
309
                    trace_headers=trace_headers,
310
                )
311
312
313
314
315
            else:
                reasoning_ended = (
                    reasoning_parser.is_reasoning_end(prompt_token_ids or [])
                    if reasoning_parser
                    else None
316
                )
317

318
319
320
321
322
323
324
325
326
327
                generator = self.engine_client.generate(
                    engine_prompt,
                    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,
                )
328

329
            generators.append(generator)
330

331
        assert len(generators) == 1
332
        (result_generator,) = generators
333

334
335
        if request.stream:
            return self.chat_completion_stream_generator(
336
337
338
339
340
341
342
                request,
                result_generator,
                request_id,
                model_name,
                conversation,
                tokenizer,
                request_metadata,
343
                reasoning_parser,
344
            )
345

346
347
348
349
350
351
352
353
354
355
        return await self.chat_completion_full_generator(
            request,
            result_generator,
            request_id,
            model_name,
            conversation,
            tokenizer,
            request_metadata,
            reasoning_parser,
        )
356
357
358
359

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

362
    @staticmethod
363
    def _bracket_level(s: str, opening="{", closing="}") -> int:
364
365
366
367
368
369
370
371
372
373
374
375
        """
        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
376
    def _filter_delta_text(delta_text: str, previous_text: str) -> tuple[str, bool]:
377
378
379
380
381
382
383
384
385
        # 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:
386
            if c == "{":
387
388
                bracket_level += 1
                passed_zero = bracket_level == 0
389
            elif c == "}":
390
391
392
393
394
395
396
                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
397
                if c == ",":
398
399
400
401
402
403
                    break
        return updated_delta, passed_zero

    def extract_tool_call_required_streaming(
        self,
        previous_text: str,
404
        current_text: str | None,
405
406
        delta_text: str,
        function_name_returned: bool,
407
408
        tool_call_idx: int | None = None,
    ) -> tuple[DeltaMessage | None, bool]:
409
410
411
        if current_text is None or current_text == "":
            # if the current text is empty, we cannot parse it
            return None, function_name_returned
412
        try:
413
414
415
416
417
418
            flags = Allow.ALL
            obj, _ = partial_json_loads(current_text, flags)
        except (
            partial_json_parser.core.exceptions.MalformedJSON,
            json.JSONDecodeError,
        ):
419
            logger.debug("not enough tokens to parse into JSON yet")
420
421
422
423
424
425
426
427
428
429
            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(
430
431
                delta_text, previous_text
            )
432
433
434
435
            # 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
436
437
438
            if not finishes_previous_tool and (
                "name" not in current_tool_call or "parameters" not in current_tool_call
            ):
439
440
441
442
443
                function_name_returned = False
                delta_message = None
            else:
                if not function_name_returned:
                    # get partly generated arguments from the latest tool call
444
445
446
                    param_match = re.search(
                        r'.*"parameters":\s*(.*)', current_text, re.DOTALL
                    )
447
448
                    arguments = param_match.group(1) if param_match else ""
                    arguments, _ = OpenAIServingChat._filter_delta_text(
449
450
                        arguments, previous_text
                    )
451
452
453
454

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

                    function_name_returned = True
459
460
461
                    tool_call_id = make_tool_call_id(
                        id_type=self.tool_call_id_type,
                        func_name=current_tool_call["name"],
462
463
464
465
466
467
468
469
470
471
472
473
474
475
                        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",
                            )
                        ]
                    )
476
477
478

                else:
                    delta_text, _ = OpenAIServingChat._filter_delta_text(
479
480
                        delta_text, previous_text
                    )
481
482

                    if delta_text != "":
483
484
485
486
487
488
489
490
491
492
493
494
495
                        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,
                                )
                            ]
                        )
496
497
498
499
500
                    else:
                        delta_message = None

        return delta_message, function_name_returned

501
    async def chat_completion_stream_generator(
502
503
504
505
        self,
        request: ChatCompletionRequest,
        result_generator: AsyncIterator[RequestOutput],
        request_id: str,
506
        model_name: str,
507
        conversation: list[ConversationMessage],
508
        tokenizer: TokenizerLike,
509
        request_metadata: RequestResponseMetadata,
510
        reasoning_parser: ReasoningParser | None = None,
511
    ) -> AsyncGenerator[str, None]:
512
        created_time = int(time.time())
513
        chunk_object_type: Final = "chat.completion.chunk"
514
        first_iteration = True
515
516

        # Send response for each token for each request.n (index)
517
518
519
        num_choices = 1 if request.n is None else request.n
        previous_num_tokens = [0] * num_choices
        finish_reason_sent = [False] * num_choices
520
        num_prompt_tokens = 0
521
        num_cached_tokens = None
522
523
        if self.use_harmony:
            harmony_parsers = [
524
                get_streamable_parser_for_assistant() for _ in range(num_choices)
525
            ]
526
527
            harmony_tools_streamed = [False] * num_choices
        tools_streamed = [False] * num_choices
528
529
530
531
532
533
534
535
536

        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
537
538
            and self._should_stream_with_auto_tool_parsing(request)
        )
539

540
        all_previous_token_ids: list[list[int]] | None
541
        function_name_returned = [False] * num_choices
542
        if self.tool_call_id_type == "kimi_k2":
543
544
545
            history_tool_call_cnt = get_history_tool_calls_cnt(conversation)
        else:
            history_tool_call_cnt = 0
546

547
548
549
        # Always track previous_texts for comprehensive output logging
        previous_texts = [""] * num_choices

550
551
        # Only one of these will be used, thus previous_texts and
        # all_previous_token_ids will not be used twice in the same iteration.
552
        if tool_choice_auto or reasoning_parser:
553
554
            # These are only required in "auto" tool choice case
            all_previous_token_ids = [[]] * num_choices
555
556
557
            # For reasoning parser and tool call all enabled
            added_content_delta_arr = [False] * num_choices
            reasoning_end_arr = [False] * num_choices
558
            prompt_is_reasoning_end_arr: list[bool | None] = [None] * num_choices
559
        else:
560
            all_previous_token_ids = None
561

562
563
564
        # Prepare the tool parser if it's needed
        try:
            if tool_choice_auto and self.tool_parser:
565
566
567
568
569
                if tokenizer is None:
                    raise ValueError(
                        "Tokenizer not available when `skip_tokenizer_init=True`"
                    )

570
                tool_parsers: list[ToolParser | None] = [
571
572
573
574
                    self.tool_parser(tokenizer)
                ] * num_choices
            else:
                tool_parsers = [None] * num_choices
575
        except Exception as e:
576
            logger.exception("Error in tool parser creation.")
577
            data = self.create_streaming_error_response(e)
578
579
580
581
            yield f"data: {data}\n\n"
            yield "data: [DONE]\n\n"
            return

582
        stream_options = request.stream_options
583
584
585
        include_usage, include_continuous_usage = should_include_usage(
            stream_options, self.enable_force_include_usage
        )
586

587
588
        try:
            async for res in result_generator:
589
590
                if res.prompt_token_ids is not None:
                    num_prompt_tokens = len(res.prompt_token_ids)
591
592
                    if res.encoder_prompt_token_ids is not None:
                        num_prompt_tokens += len(res.encoder_prompt_token_ids)
593

594
595
596
597
                # 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:
598
                    num_cached_tokens = res.num_cached_tokens
599
600
                    # Send first response for each request.n (index) with
                    # the role
601
                    role = self.get_chat_request_role(request)
602
603
604

                    # NOTE num_choices defaults to 1 so this usually executes
                    # once per request
605
                    for i in range(num_choices):
606
607
                        choice_data = ChatCompletionResponseStreamChoice(
                            index=i,
608
609
610
611
                            delta=DeltaMessage(
                                role=role,
                                content="",
                            ),
612
                            logprobs=None,
613
614
                            finish_reason=None,
                        )
615
616

                        # return prompt_token_ids at the first chunk ever
617
618
619
620
621
                        chunk = ChatCompletionStreamResponse(
                            id=request_id,
                            object=chunk_object_type,
                            created=created_time,
                            choices=[choice_data],
622
                            model=model_name,
623
624
625
626
627
628
                            prompt_token_ids=(
                                res.prompt_token_ids
                                if request.return_token_ids
                                else None
                            ),
                        )
629

630
631
632
633
634
                        # if continuous usage stats are requested, add it
                        if include_continuous_usage:
                            chunk.usage = UsageInfo(
                                prompt_tokens=num_prompt_tokens,
                                completion_tokens=0,
635
636
                                total_tokens=num_prompt_tokens,
                            )
637

638
639
640
                        data = chunk.model_dump_json(exclude_unset=True)
                        yield f"data: {data}\n\n"

641
642
                    # Send response to echo the input portion of the
                    # last message
643
                    if request.echo:
644
                        last_msg_content: str | list[dict[str, str]] = ""
645
646
647
648
649
                        if (
                            conversation
                            and "content" in conversation[-1]
                            and conversation[-1].get("role") == role
                        ):
650
                            last_msg_content = conversation[-1]["content"] or ""
651
652

                        if last_msg_content:
653
                            for i in range(num_choices):
654
655
656
657
658
659
                                choice_data = ChatCompletionResponseStreamChoice(
                                    index=i,
                                    delta=DeltaMessage(content=last_msg_content),
                                    logprobs=None,
                                    finish_reason=None,
                                )
660
661
662
663
664
                                chunk = ChatCompletionStreamResponse(
                                    id=request_id,
                                    object=chunk_object_type,
                                    created=created_time,
                                    choices=[choice_data],
665
666
                                    model=model_name,
                                )
667
668
669
670
                                if include_continuous_usage:
                                    chunk.usage = UsageInfo(
                                        prompt_tokens=num_prompt_tokens,
                                        completion_tokens=0,
671
672
                                        total_tokens=num_prompt_tokens,
                                    )
673

674
                                data = chunk.model_dump_json(exclude_unset=True)
675
676
677
678
679
                                yield f"data: {data}\n\n"
                    first_iteration = False

                for output in res.outputs:
                    i = output.index
680
                    tool_parser = tool_parsers[i]
681

682
                    if (
683
                        reasoning_parser
684
685
686
687
688
689
690
691
                        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)
                        )
692
693
694
                    if finish_reason_sent[i]:
                        continue

695
                    if request.logprobs and request.top_logprobs is not None:
696
                        assert output.logprobs is not None, "Did not output logprobs"
697
                        logprobs = self._create_chat_logprobs(
698
699
                            token_ids=output.token_ids,
                            top_logprobs=output.logprobs,
700
                            tokenizer=tokenizer,
701
                            num_output_top_logprobs=request.top_logprobs,
702
                            return_as_token_id=request.return_tokens_as_token_ids,
703
704
705
706
                        )
                    else:
                        logprobs = None

707
708
                    if self.use_harmony:
                        harmony_parser = harmony_parsers[i]
709
                        prev_recipient = harmony_parser.current_recipient
710
711
712

                        # Track accumulated content per token with their state
                        token_states: list[TokenState] = []
713
714
                        for token_id in output.token_ids:
                            harmony_parser.process(token_id)
715
716
717
718
719
720
721
722
723
                            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)
724
                        cur_channel = harmony_parser.current_channel
725

726
727
728
729
730
                        # 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"
731
732
                    else:
                        delta_text = output.text
733

734
735
736
737
738
                    if (
                        not delta_text
                        and not output.token_ids
                        and not previous_num_tokens[i]
                    ):
739
740
741
                        # Chunked prefill case, don't return empty chunks
                        continue

742
                    delta_message: DeltaMessage | None
743

744
                    # just update previous_texts and previous_token_ids
745
                    if tool_choice_auto or reasoning_parser:
746
747
748
749
750
                        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
751
752
                        # avoid the None + list error.
                        if previous_token_ids:
753
                            current_token_ids = previous_token_ids + as_list(
754
755
                                output.token_ids
                            )
756
                        else:
757
                            current_token_ids = as_list(output.token_ids)
758

759
                    if self.use_harmony:
760
761
762
                        delta_message, tools_streamed_flag = (
                            extract_harmony_streaming_delta(
                                harmony_parser=harmony_parser,
763
                                token_states=token_states,
764
765
766
767
768
                                prev_recipient=prev_recipient,
                                include_reasoning=request.include_reasoning,
                            )
                        )
                        harmony_tools_streamed[i] |= tools_streamed_flag
769
                    # handle streaming deltas for tools with named tool_choice
770
                    elif tool_choice_function_name:
771
772
773
774
775
776
777
778
779
780
781
                        # 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

782
                        if (
783
                            reasoning_parser
784
785
786
787
788
                            and not reasoning_end_arr[i]
                            and not reasoning_parser.is_reasoning_end(
                                previous_token_ids
                            )
                        ):
789
790
                            assert reasoning_parser is not None
                            delta_message = (
791
                                reasoning_parser.extract_reasoning_streaming(
792
793
794
795
796
797
                                    previous_text,
                                    current_text,
                                    delta_text,
                                    previous_token_ids,
                                    current_token_ids,
                                    output.token_ids,
798
799
                                )
                            )
800
                            # When encountering think end id in delta_token_ids,
801
                            # set reasoning status to end.
802
                            # Only keep 'content', remove 'reasoning'.
803
804
                            if reasoning_parser.is_reasoning_end(
                                as_list(output.token_ids)
805
                            ):
806
                                reasoning_end_arr[i] = True
807
808
809
810
811
812
813
814
                                if delta_message and delta_message.content:
                                    # This need to be added to next `delta_text`
                                    current_text = delta_message.content
                                    delta_message.content = None
                                else:
                                    current_text = ""
                        else:
                            # Just to add remaining `content`
815
                            if reasoning_parser:
816
817
818
                                delta_text = previous_text + delta_text
                                current_text = ""

819
820
                            if function_name_returned[i]:
                                delta_tool_call = DeltaToolCall(
821
822
823
                                    function=DeltaFunctionCall(arguments=delta_text),
                                    index=i,
                                )
824
                            else:
825
                                # Generate ID based on tokenizer type
826
                                if is_mistral_tokenizer(tokenizer):
827
828
829
830
831
832
833
                                    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,
                                    )
834
                                delta_tool_call = DeltaToolCall(
835
                                    id=tool_call_id,
836
837
838
                                    type="function",
                                    function=DeltaFunctionCall(
                                        name=tool_choice_function_name,
839
840
841
842
                                        arguments=delta_text,
                                    ),
                                    index=i,
                                )
843
                                function_name_returned[i] = True
844
                                history_tool_call_cnt += 1
845

846
847
848
849
850
                            delta_message = DeltaMessage(
                                tool_calls=[
                                    delta_tool_call,
                                ]
                            )
851
                            tools_streamed[i] = True
852

853
854
855
856
857
                    elif request.tool_choice == "required":
                        assert previous_texts is not None
                        previous_text = previous_texts[i]
                        current_text = previous_text + delta_text
                        fn_name_returned = function_name_returned[i]
858
859
860
                        output_token_ids = as_list(output.token_ids)

                        if (
861
                            reasoning_parser is not None
862
                            and not reasoning_end_arr[i]
863
                            and prompt_is_reasoning_end_arr[i]
864
865
                        ):
                            reasoning_end_arr[i] = True
866

867
                        if reasoning_parser and not reasoning_end_arr[i]:
868
                            delta_message = (
869
                                reasoning_parser.extract_reasoning_streaming(
870
871
872
873
874
875
876
                                    previous_text,
                                    current_text,
                                    delta_text,
                                    previous_token_ids,
                                    current_token_ids,
                                    output_token_ids,
                                )
877
                            )
878
879
880
881
882
883
884
885
886
                            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 = ""

887
                        else:
888
                            # either finished reasoning or no reasoning at all
889
                            content = current_text
890
891
892
893
894
895
896
897
898

                            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,
                                )
899
                            )
900
901
902
903
904
905
906
                            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
907

908
909
                    # handle streaming deltas for tools with "auto" tool choice
                    # and reasoning parser
910
                    elif tool_choice_auto and reasoning_parser:
911
912
913
                        assert tool_parser is not None
                        assert added_content_delta_arr is not None
                        assert reasoning_end_arr is not None
914
                        output_token_ids = as_list(output.token_ids)
915
                        if not reasoning_end_arr[i]:
916
917
918
                            # When encountering think end id in prompt_token_ids
                            # i.e {"enable_thinking": False},
                            # set reasoning status to end.
919
                            if prompt_is_reasoning_end_arr[i]:
920
                                reasoning_end_arr[i] = True
921
                                current_token_ids = output_token_ids
922
923
924
925
926
927
928
929
930
931
                                # Don't update current_text, keep it as is from delta
                            else:
                                delta_message = (
                                    reasoning_parser.extract_reasoning_streaming(
                                        previous_text,
                                        current_text,
                                        delta_text,
                                        previous_token_ids,
                                        current_token_ids,
                                        output_token_ids,
932
933
                                    )
                                )
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950

                                # When encountering think end id in delta_token_ids,
                                # set reasoning status to end.
                                # Remove the text and token ids related
                                # to 'reasoning'.
                                if reasoning_parser.is_reasoning_end(output_token_ids):
                                    reasoning_end_arr[i] = True
                                    current_token_ids = (
                                        reasoning_parser.extract_content_ids(
                                            output_token_ids
                                        )
                                    )
                                    if delta_message and delta_message.content:
                                        current_text = delta_message.content
                                        delta_message.content = None
                                    else:
                                        current_text = ""
951
952

                        # handle tool calls only after reasoning is done,
953
                        if reasoning_end_arr[i]:
954
                            delta_token_ids = output_token_ids
955
956
957
958
959
960
961
962
963
964
                            # First time to tool call,
                            # add the remaining text and token ids
                            # to delta from previous
                            if not added_content_delta_arr[i]:
                                added_content_delta_arr[i] = True
                                previous_text = ""
                                previous_token_ids = []
                                delta_text = current_text
                                delta_token_ids = current_token_ids

965
                            delta_message = tool_parser.extract_tool_calls_streaming(
966
967
                                previous_text=previous_text,
                                current_text=current_text,
968
                                delta_text=delta_text,
969
970
                                previous_token_ids=previous_token_ids,
                                current_token_ids=current_token_ids,
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
                                delta_token_ids=delta_token_ids,
                                request=request,
                            )
                            if delta_message and delta_message.tool_calls:
                                tools_streamed[i] = True
                    # when only tool calls
                    elif tool_choice_auto:
                        assert tool_parser is not None
                        delta_message = tool_parser.extract_tool_calls_streaming(
                            previous_text=previous_text,
                            current_text=current_text,
                            delta_text=delta_text,
                            previous_token_ids=previous_token_ids,
                            current_token_ids=current_token_ids,
                            delta_token_ids=output.token_ids,
                            request=request,
                        )
988
989
                        if delta_message and delta_message.tool_calls:
                            tools_streamed[i] = True
990

991
                    # when only reasoning
992
                    elif reasoning_parser:
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
                        # When encountering think end id in prompt_token_ids
                        # i.e {"enable_thinking": False},
                        # set reasoning status to end.
                        # Route all generated tokens as content directly.
                        if prompt_is_reasoning_end_arr[i]:
                            delta_message = DeltaMessage(content=delta_text)
                        else:
                            delta_message = (
                                reasoning_parser.extract_reasoning_streaming(
                                    previous_text,
                                    current_text,
                                    delta_text,
                                    previous_token_ids,
                                    current_token_ids,
                                    output.token_ids,
                                )
                            )
1010
                    # handle streaming just a content delta
1011
1012
1013
                    else:
                        delta_message = DeltaMessage(content=delta_text)

1014
                    # update the previous values for the next iteration
1015
                    if (tool_choice_auto or reasoning_parser) and not self.use_harmony:
1016
1017
1018
1019
                        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
1020
1021
1022
1023
                    else:
                        # Update for comprehensive logging even in simple case
                        assert previous_texts is not None
                        previous_texts[i] += delta_text
1024

1025
                    # set the previous values for the next iteration
1026
                    previous_num_tokens[i] += len(output.token_ids)
1027
1028
1029
1030
1031
1032

                    # 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:
1033
1034
1035
1036
1037
1038
1039
                        # 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
                        ):
1040
                            continue
1041
                        delta_message = DeltaMessage()
1042

1043
1044
                    # Log streaming delta if output logging is enabled
                    if self.enable_log_outputs and self.request_logger:
1045
                        delta_content_parts = []
1046
                        if delta_message.content:
1047
                            delta_content_parts.append(delta_message.content)
1048
1049
                        if delta_message.reasoning:
                            reasoning = delta_message.reasoning
1050
1051
1052
                            delta_content_parts.append(f"[reasoning: {reasoning}]")
                        if delta_message.tool_calls:
                            tool_args = "".join(
1053
1054
                                tc.function.arguments
                                for tc in delta_message.tool_calls
1055
1056
                                if tc.function and tc.function.arguments
                            )
1057
1058
                            if tool_args:
                                delta_content_parts.append(f"[tool_calls: {tool_args}]")
1059

1060
1061
                        if delta_content_parts and self.enable_log_deltas:
                            delta_content = " ".join(delta_content_parts)
1062
1063
1064
                            self.request_logger.log_outputs(
                                request_id=request_id,
                                outputs=delta_content,
1065
                                output_token_ids=as_list(output.token_ids),
1066
1067
1068
1069
1070
                                finish_reason=output.finish_reason,
                                is_streaming=True,
                                delta=True,
                            )

1071
1072
1073
1074
                    if output.finish_reason is None:
                        # Send token-by-token response for each request.n
                        choice_data = ChatCompletionResponseStreamChoice(
                            index=i,
1075
                            delta=delta_message,
1076
                            logprobs=logprobs,
1077
                            finish_reason=None,
1078
1079
1080
1081
1082
1083
                            token_ids=(
                                as_list(output.token_ids)
                                if request.return_token_ids
                                else None
                            ),
                        )
1084
1085

                    # if the model is finished generating
1086
                    else:
1087
1088
1089
1090
                        # check for error finish reason and abort streaming
                        # finish_reason='error' indicates a retryable error
                        self._raise_if_error(output.finish_reason, request_id)

1091
1092
1093
                        # check to make sure we haven't "forgotten" to stream
                        #   any tokens that were generated but previously
                        #   matched by partial json parsing
1094
                        # only happens if we are NOT using structured outputs
1095
                        auto_tools_called = False
1096
                        if tool_parser:
1097
1098
1099
1100
1101
1102
                            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
                            )
1103
1104
1105
                        else:
                            index = 0

1106
1107
1108
1109
1110
1111
                        if (
                            self._should_check_for_unstreamed_tool_arg_tokens(
                                delta_message, output
                            )
                            and tool_parser
                        ):
1112
                            latest_delta_len = 0
1113
1114
                            if (
                                isinstance(
1115
                                    delta_message.tool_calls[0].function,
1116
1117
1118
1119
1120
                                    DeltaFunctionCall,
                                )
                            ) and isinstance(
                                delta_message.tool_calls[0].function.arguments, str
                            ):
1121
                                latest_delta_len = len(
1122
1123
                                    delta_message.tool_calls[0].function.arguments
                                )
1124

1125
                            # get the expected call based on partial JSON
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
                            # 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", {}
1138
                            )
1139
1140
1141
1142
                            if isinstance(args, str):
                                expected_call = args
                            else:
                                expected_call = json.dumps(args, ensure_ascii=False)
1143

1144
                            # get what we've streamed so far for arguments
1145
                            # for the current tool
1146
1147
                            actual_call = tool_parser.streamed_args_for_tool[index]
                            if latest_delta_len > 0:
1148
                                actual_call = actual_call[:-latest_delta_len]
1149
1150

                            # check to see if there's anything left to stream
1151
                            remaining_call = expected_call.replace(actual_call, "", 1)
1152
                            # set that as a delta message
1153
1154
                            delta_message = self._create_remaining_args_delta(
                                delta_message, remaining_call, index
1155
                            )
1156

1157
                        # Send the finish response for each request.n only once
1158
1159
1160
1161
                        # 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.
1162
1163
                        if (
                            auto_tools_called
1164
                            or (tools_streamed[i] and not tool_choice_function_name)
1165
1166
                            or (self.use_harmony and harmony_tools_streamed[i])
                        ):
1167
1168
                            finish_reason_ = "tool_calls"
                        else:
1169
1170
1171
                            finish_reason_ = (
                                output.finish_reason if output.finish_reason else "stop"
                            )
1172
1173
                        choice_data = ChatCompletionResponseStreamChoice(
                            index=i,
1174
                            delta=delta_message,
1175
                            logprobs=logprobs,
1176
                            finish_reason=finish_reason_,
1177
                            stop_reason=output.stop_reason,
1178
1179
1180
1181
1182
1183
                            token_ids=(
                                as_list(output.token_ids)
                                if request.return_token_ids
                                else None
                            ),
                        )
1184

1185
                        finish_reason_sent[i] = True
1186

1187
                    choice_data = maybe_filter_parallel_tool_calls(choice_data, request)
1188
1189
1190
1191
1192
                    chunk = ChatCompletionStreamResponse(
                        id=request_id,
                        object=chunk_object_type,
                        created=created_time,
                        choices=[choice_data],
1193
1194
                        model=model_name,
                    )
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204

                    # 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,
                        )

1205
                    data = chunk.model_dump_json(exclude_unset=True)
1206
1207
                    yield f"data: {data}\n\n"

1208
1209
            # once the final token is handled, if stream_options.include_usage
            # is sent, send the usage
1210
1211
            if include_usage:
                completion_tokens = sum(previous_num_tokens)
1212
1213
1214
1215
1216
                final_usage = UsageInfo(
                    prompt_tokens=num_prompt_tokens,
                    completion_tokens=completion_tokens,
                    total_tokens=num_prompt_tokens + completion_tokens,
                )
1217
1218
                if self.enable_prompt_tokens_details and num_cached_tokens:
                    final_usage.prompt_tokens_details = PromptTokenUsageInfo(
1219
1220
                        cached_tokens=num_cached_tokens
                    )
1221
1222
1223
1224
1225
1226
1227

                final_usage_chunk = ChatCompletionStreamResponse(
                    id=request_id,
                    object=chunk_object_type,
                    created=created_time,
                    choices=[],
                    model=model_name,
1228
1229
1230
1231
1232
                    usage=final_usage,
                )
                final_usage_data = final_usage_chunk.model_dump_json(
                    exclude_unset=True, exclude_none=True
                )
1233
                yield f"data: {final_usage_data}\n\n"
1234

1235
1236
1237
1238
1239
            # 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,
1240
1241
1242
1243
1244
1245
1246
1247
1248
                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]
1249
1250
                        if previous_texts and i < len(previous_texts)
                        else f"<streaming_complete: {previous_num_tokens[i]} tokens>"
1251
1252
1253
1254
                    )
                    self.request_logger.log_outputs(
                        request_id=request_id,
                        outputs=full_text,
1255
                        output_token_ids=None,  # Consider also logging all token IDs
1256
1257
1258
1259
                        finish_reason="streaming_complete",
                        is_streaming=True,
                        delta=False,
                    )
1260

1261
1262
        except GenerationError as e:
            yield f"data: {self._convert_generation_error_to_streaming_response(e)}\n\n"
1263
        except Exception as e:
1264
            logger.exception("Error in chat completion stream generator.")
1265
            data = self.create_streaming_error_response(e)
1266
            yield f"data: {data}\n\n"
1267
1268
1269
1270
        # Send the final done message after all response.n are finished
        yield "data: [DONE]\n\n"

    async def chat_completion_full_generator(
1271
1272
1273
1274
        self,
        request: ChatCompletionRequest,
        result_generator: AsyncIterator[RequestOutput],
        request_id: str,
1275
        model_name: str,
1276
        conversation: list[ConversationMessage],
1277
        tokenizer: TokenizerLike,
1278
        request_metadata: RequestResponseMetadata,
1279
        reasoning_parser: ReasoningParser | None = None,
1280
    ) -> ErrorResponse | ChatCompletionResponse:
1281
1282
        from vllm.tokenizers.mistral import MistralTokenizer

1283
        created_time = int(time.time())
1284
        final_res: RequestOutput | None = None
1285

1286
1287
1288
1289
1290
1291
        try:
            async for res in result_generator:
                final_res = res
        except asyncio.CancelledError:
            return self.create_error_response("Client disconnected")

1292
1293
        assert final_res is not None

1294
        choices: list[ChatCompletionResponseChoice] = []
1295
        if self.tool_call_id_type == "kimi_k2":
1296
1297
1298
            history_tool_call_cnt = get_history_tool_calls_cnt(conversation)
        else:
            history_tool_call_cnt = 0
1299

1300
1301
        role = self.get_chat_request_role(request)
        for output in final_res.outputs:
1302
1303
1304
            # 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)
1305
            token_ids = output.token_ids
1306
            out_logprobs = output.logprobs
1307
            tool_call_info = None
1308

1309
1310
            if request.logprobs and request.top_logprobs is not None:
                assert out_logprobs is not None, "Did not output logprobs"
1311
                logprobs = self._create_chat_logprobs(
1312
                    token_ids=token_ids,
1313
                    top_logprobs=out_logprobs,
1314
                    num_output_top_logprobs=request.top_logprobs,
1315
                    tokenizer=tokenizer,
1316
                    return_as_token_id=request.return_tokens_as_token_ids,
1317
1318
1319
                )
            else:
                logprobs = None
1320
1321

            if self.use_harmony:
1322
                reasoning, content, _ = parse_chat_output(token_ids)
1323
                if not request.include_reasoning:
1324
                    reasoning = None
1325

1326
                if self.tool_parser is not None:
1327
1328
1329
1330
1331
                    if tokenizer is None:
                        raise ValueError(
                            "Tokenizer not available when `skip_tokenizer_init=True`"
                        )

1332
1333
1334
1335
1336
1337
1338
                    tool_parser = self.tool_parser(tokenizer)
                    # 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
                    )
1339
                    content = tool_call_info.content
1340
1341
                    message = ChatMessage(
                        role=role,
1342
                        reasoning=reasoning,
1343
1344
1345
1346
1347
1348
                        content=content,
                        tool_calls=tool_call_info.tool_calls,
                    )
                else:
                    message = ChatMessage(
                        role=role,
1349
                        reasoning=reasoning,
1350
1351
                        content=content,
                    )
1352
1353
1354
1355
1356

                choice_data = ChatCompletionResponseChoice(
                    index=output.index,
                    message=message,
                    logprobs=logprobs,
1357
1358
1359
1360
1361
1362
1363
                    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"
                    ),
1364
                    stop_reason=output.stop_reason,
1365
1366
1367
                    token_ids=(
                        as_list(output.token_ids) if request.return_token_ids else None
                    ),
1368
1369
1370
                )
                choices.append(choice_data)
                continue
1371

1372
            if reasoning_parser:
1373
1374
                # If the reasoning parser is enabled,
                # tool calls are extracted exclusively from the content.
1375
                reasoning, content = reasoning_parser.extract_reasoning(
1376
1377
                    output.text, request=request
                )
1378
                if not request.include_reasoning:
1379
                    reasoning = None
1380
            else:
1381
                reasoning = None
1382
                content = output.text
1383

1384
            auto_tools_called = False
1385
1386
            # if auto tools are not enabled, and a named tool choice using
            #   outlines is not being used
1387
1388
1389
1390
1391
1392
1393
1394
            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 = (
1395
                MistralToolCall if is_mistral_tokenizer(tokenizer) else ToolCall
1396
            )
1397
            if (not self.enable_auto_tools or not self.tool_parser) and (
1398
1399
1400
                not isinstance(request.tool_choice, ChatCompletionNamedToolChoiceParam)
                and request.tool_choice != "required"
            ):
1401
                message = ChatMessage(role=role, reasoning=reasoning, content=content)
1402

1403
1404
1405
1406
            elif (
                request.tool_choice
                and type(request.tool_choice) is ChatCompletionNamedToolChoiceParam
            ):
1407
                assert tool_calls is not None and len(tool_calls) > 0
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
                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,
1426
                                idx=history_tool_call_cnt,
1427
1428
1429
1430
1431
                            )
                            tool_call_class_items.append(
                                tool_call_class(id=generated_id, function=tc)
                            )
                    history_tool_call_cnt += 1
1432
1433
                message = ChatMessage(
                    role=role,
1434
                    reasoning=reasoning,
1435
                    content="",
1436
                    tool_calls=tool_call_class_items,
1437
                )
1438

1439
            elif request.tool_choice and request.tool_choice == "required":
1440
                tool_call_class_items = []
1441
                tool_calls = tool_calls or []
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
                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(
1459
1460
                                id_type=self.tool_call_id_type,
                                func_name=tool_call.name,
1461
                                idx=history_tool_call_cnt,
1462
1463
1464
1465
                            )
                            tool_call_class_items.append(
                                tool_call_class(id=generated_id, function=tool_call)
                            )
1466
                    history_tool_call_cnt += 1
1467
1468
1469
                message = ChatMessage(
                    role=role,
                    content="",
1470
                    tool_calls=tool_call_class_items,
1471
                    reasoning=reasoning,
1472
                )
1473

1474
1475
            # if the request doesn't use tool choice
            # OR specifies to not use a tool
1476
            elif not request.tool_choice or request.tool_choice == "none":
1477
                message = ChatMessage(role=role, reasoning=reasoning, content=content)
1478
1479

            # handle when there are tools and tool choice is auto
1480
1481
1482
1483
1484
1485
            elif (
                request.tools
                and (request.tool_choice == "auto" or request.tool_choice is None)
                and self.enable_auto_tools
                and self.tool_parser
            ):
1486
1487
1488
                # 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
1489
1490
                auto_tools_called = tool_calls is not None and len(tool_calls) > 0
                if tool_calls:
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
                    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,
1509
                                    idx=history_tool_call_cnt,
1510
1511
1512
1513
1514
                                )
                                tool_call_items.append(
                                    tool_call_class(id=generated_id, function=tc)
                                )
                        history_tool_call_cnt += 1
1515
1516
                    message = ChatMessage(
                        role=role,
1517
                        reasoning=reasoning,
1518
                        content=content,
1519
                        tool_calls=tool_call_items,
1520
                    )
1521
1522
1523
1524

                else:
                    # FOR NOW make it a chat message; we will have to detect
                    # the type to make it later.
1525
1526
1527
1528
                    ret_content = content

                    # try to use content return from tool parser first,
                    # tool parser may do some modify for the content.
1529
1530
                    if content and len(content) > 0:
                        ret_content = content
1531
1532
                    message = ChatMessage(
                        role=role,
1533
                        reasoning=reasoning,
1534
1535
                        content=ret_content,
                    )
1536
1537
1538
1539
1540
1541

            # 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 "
1542
1543
                    "completion."
                )
1544
                message = ChatMessage(role=role, reasoning=reasoning, content=content)
1545
1546
1547
1548
1549
1550
1551
1552
            # 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"
            )
1553

1554
1555
            choice_data = ChatCompletionResponseChoice(
                index=output.index,
1556
                message=message,
1557
                logprobs=logprobs,
1558
1559
1560
1561
1562
                finish_reason="tool_calls"
                if is_finish_reason_tool_calls
                else output.finish_reason
                if output.finish_reason
                else "stop",
1563
                stop_reason=output.stop_reason,
1564
1565
1566
                token_ids=(
                    as_list(output.token_ids) if request.return_token_ids else None
                ),
1567
            )
1568
            choice_data = maybe_filter_parallel_tool_calls(choice_data, request)
1569

1570
1571
            choices.append(choice_data)

1572
        if request.echo:
1573
            last_msg_content: str | list[dict[str, str]] = ""
1574
1575
1576
1577
1578
            if (
                conversation
                and "content" in conversation[-1]
                and conversation[-1].get("role") == role
            ):
1579
                last_msg_content = conversation[-1]["content"] or ""
1580
            if isinstance(last_msg_content, list):
1581
                last_msg_content = "\n".join(msg["text"] for msg in last_msg_content)
1582
1583

            for choice in choices:
1584
                full_message = last_msg_content + (choice.message.content or "")
1585
1586
                choice.message.content = full_message

1587
        assert final_res.prompt_token_ids is not None
1588
        num_prompt_tokens = len(final_res.prompt_token_ids)
1589
1590
        if final_res.encoder_prompt_token_ids is not None:
            num_prompt_tokens += len(final_res.encoder_prompt_token_ids)
1591
        num_generated_tokens = sum(
1592
1593
1594
1595
1596
1597
1598
            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,
        )
1599
1600
        if self.enable_prompt_tokens_details and final_res.num_cached_tokens:
            usage.prompt_tokens_details = PromptTokenUsageInfo(
1601
1602
                cached_tokens=final_res.num_cached_tokens
            )
1603
1604
1605

        request_metadata.final_usage_info = usage

1606
1607
1608
1609
1610
1611
        response = ChatCompletionResponse(
            id=request_id,
            created=created_time,
            model=model_name,
            choices=choices,
            usage=usage,
1612
            prompt_logprobs=clamp_prompt_logprobs(final_res.prompt_logprobs),
1613
1614
1615
            prompt_token_ids=(
                final_res.prompt_token_ids if request.return_token_ids else None
            ),
Robert Shaw's avatar
Robert Shaw committed
1616
            kv_transfer_params=final_res.kv_transfer_params,
1617
1618
        )

1619
1620
1621
1622
1623
1624
1625
1626
1627
        # 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 = []
1628
1629
1630
1631
1632
                    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})"
                        )
1633
1634
1635
1636
1637
1638
1639
                    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):
1640
                        output_token_ids = final_res.outputs[choice.index].token_ids
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650

                    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,
                    )

1651
        return response
1652
1653

    def _get_top_logprobs(
1654
1655
        self,
        logprobs: dict[int, Logprob],
1656
        top_logprobs: int | None,
1657
        tokenizer: TokenizerLike | None,
1658
1659
        should_return_as_token_id: bool,
    ) -> list[ChatCompletionLogProb]:
1660
        return [
1661
            ChatCompletionLogProb(
1662
1663
1664
1665
1666
1667
1668
1669
                token=(
                    token := self._get_decoded_token(
                        p[1],
                        p[0],
                        tokenizer,
                        return_as_token_id=should_return_as_token_id,
                    )
                ),
1670
1671
                logprob=max(p[1].logprob, -9999.0),
                bytes=list(token.encode("utf-8", errors="replace")),
1672
1673
            )
            for i, p in enumerate(logprobs.items())
1674
            if (top_logprobs and i < top_logprobs or top_logprobs == -1)
1675
1676
1677
1678
1679
        ]

    def _create_chat_logprobs(
        self,
        token_ids: GenericSequence[int],
1680
        top_logprobs: GenericSequence[dict[int, Logprob] | None],
1681
        tokenizer: TokenizerLike | None,
1682
1683
        num_output_top_logprobs: int | None = None,
        return_as_token_id: bool | None = None,
1684
1685
    ) -> ChatCompletionLogProbs:
        """Create OpenAI-style logprobs."""
1686
        logprobs_content: list[ChatCompletionLogProbsContent] = []
1687

1688
1689
1690
1691
1692
        should_return_as_token_id = (
            return_as_token_id
            if return_as_token_id is not None
            else self.return_tokens_as_token_ids
        )
1693
1694
        for i, token_id in enumerate(token_ids):
            step_top_logprobs = top_logprobs[i]
1695
            if step_top_logprobs is None or step_top_logprobs.get(token_id) is None:
1696
                if should_return_as_token_id:
1697
                    token = f"token_id:{token_id}"
1698
                else:
1699
1700
                    if tokenizer is None:
                        raise ValueError(
1701
                            "Unable to get tokenizer because `skip_tokenizer_init=True`"
1702
1703
                        )

1704
                    token = tokenizer.decode(token_id)
1705

1706
1707
                logprobs_content.append(
                    ChatCompletionLogProbsContent(
1708
                        token=token,
1709
                        bytes=list(token.encode("utf-8", errors="replace")),
1710
1711
                    )
                )
1712
            else:
1713
1714
1715
                step_token = step_top_logprobs[token_id]
                step_decoded = step_token.decoded_token

1716
1717
                logprobs_content.append(
                    ChatCompletionLogProbsContent(
1718
                        token=self._get_decoded_token(
1719
1720
1721
                            step_token,
                            token_id,
                            tokenizer,
1722
                            should_return_as_token_id,
1723
1724
                        ),
                        logprob=max(step_token.logprob, -9999.0),
1725
1726
1727
1728
1729
                        bytes=(
                            None
                            if step_decoded is None
                            else list(step_decoded.encode("utf-8", errors="replace"))
                        ),
1730
                        top_logprobs=self._get_top_logprobs(
1731
1732
1733
1734
1735
1736
1737
                            step_top_logprobs,
                            num_output_top_logprobs,
                            tokenizer,
                            should_return_as_token_id,
                        ),
                    )
                )
1738
1739

        return ChatCompletionLogProbs(content=logprobs_content)
1740

1741
    def _should_stream_with_auto_tool_parsing(self, request: ChatCompletionRequest):
1742
1743
1744
1745
1746
1747
1748
1749
        """
        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.
        """
1750
1751
1752
1753
1754
1755
        return (
            request.tools
            and self.tool_parser
            and self.enable_auto_tools
            and request.tool_choice in ["auto", None]
        )
1756
1757
1758

    def _should_check_for_unstreamed_tool_arg_tokens(
        self,
1759
        delta_message: DeltaMessage | None,
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
        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
1771
            output.finish_reason is not None
1772
1773
1774
1775
1776
            and self.enable_auto_tools
            and self.tool_parser
            and delta_message
            and delta_message.tool_calls
            and delta_message.tool_calls[0]
1777
1778
1779
            and delta_message.tool_calls[0].function
            and delta_message.tool_calls[0].function.arguments is not None
        )
1780

1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
    @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,
                    ),
                )
            ]
        )