"deploy/helm/charts/chrek/Chart.yaml" did not exist on "7436e3bc030322225434bca7fd9d897fd40a170a"
serving_responses.py 98.7 KB
Newer Older
1
2
3
4
# SPDX-License-Identifier: Apache-2.0
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project

import asyncio
5
import json
6
import time
7
import uuid
8
from collections import deque
9
from collections.abc import AsyncGenerator, AsyncIterator, Callable, Sequence
10
from contextlib import AsyncExitStack
11
from copy import copy
12
from dataclasses import dataclass
13
from http import HTTPStatus
14
from typing import Final
15
16
17

import jinja2
from fastapi import Request
18
19
20
21
22
23
from openai.types.responses import (
    ResponseCodeInterpreterCallCodeDeltaEvent,
    ResponseCodeInterpreterCallCodeDoneEvent,
    ResponseCodeInterpreterCallCompletedEvent,
    ResponseCodeInterpreterCallInProgressEvent,
    ResponseCodeInterpreterCallInterpretingEvent,
24
25
26
    ResponseCodeInterpreterToolCallParam,
    ResponseContentPartAddedEvent,
    ResponseContentPartDoneEvent,
27
28
    ResponseFunctionCallArgumentsDeltaEvent,
    ResponseFunctionCallArgumentsDoneEvent,
29
30
    ResponseFunctionToolCall,
    ResponseFunctionWebSearch,
31
32
33
34
    ResponseMcpCallArgumentsDeltaEvent,
    ResponseMcpCallArgumentsDoneEvent,
    ResponseMcpCallCompletedEvent,
    ResponseMcpCallInProgressEvent,
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
    ResponseOutputItem,
    ResponseOutputItemAddedEvent,
    ResponseOutputItemDoneEvent,
    ResponseOutputMessage,
    ResponseOutputText,
    ResponseReasoningItem,
    ResponseReasoningTextDeltaEvent,
    ResponseReasoningTextDoneEvent,
    ResponseStatus,
    ResponseTextDeltaEvent,
    ResponseTextDoneEvent,
    ResponseWebSearchCallCompletedEvent,
    ResponseWebSearchCallInProgressEvent,
    ResponseWebSearchCallSearchingEvent,
    response_function_web_search,
    response_text_delta_event,
)
52
from openai.types.responses.response_output_item import McpCall
53
from openai.types.responses.response_output_text import Logprob, LogprobTopLogprob
54
from openai.types.responses.response_reasoning_item import (
55
56
    Content as ResponseReasoningTextContent,
)
57
from openai.types.responses.tool import Mcp, Tool
58
from openai_harmony import Message as OpenAIHarmonyMessage
59
from pydantic import TypeAdapter
60

61
from vllm import envs
62
from vllm.engine.protocol import EngineClient
63
64
65
66
67
68
69
from vllm.entrypoints.chat_utils import (
    ChatCompletionMessageParam,
    ChatTemplateContentFormatOption,
)
from vllm.entrypoints.context import (
    ConversationContext,
    HarmonyContext,
70
    ParsableContext,
71
72
73
    SimpleContext,
    StreamingHarmonyContext,
)
74
from vllm.entrypoints.logger import RequestLogger
75
from vllm.entrypoints.openai.engine.protocol import (
76
77
78
79
80
81
82
83
    DeltaMessage,
    ErrorResponse,
    InputTokensDetails,
    OutputTokensDetails,
    RequestResponseMetadata,
    ResponseCompletedEvent,
    ResponseCreatedEvent,
    ResponseInProgressEvent,
84
    ResponseInputOutputMessage,
85
86
87
88
89
90
    ResponseReasoningPartAddedEvent,
    ResponseReasoningPartDoneEvent,
    ResponsesRequest,
    ResponsesResponse,
    ResponseUsage,
    StreamingResponsesResponse,
91
    VLLMValidationError,
92
)
93
from vllm.entrypoints.openai.engine.serving import (
94
95
96
    GenerationError,
    OpenAIServing,
)
97
98
99
100
101
102
103
104
105
106
107
108
from vllm.entrypoints.openai.parser.harmony_utils import (
    construct_harmony_previous_input_messages,
    get_developer_message,
    get_stop_tokens_for_assistant_actions,
    get_system_message,
    get_user_message,
    has_custom_tools,
    parse_output_message,
    parse_remaining_state,
    parse_response_input,
    render_for_completion,
)
109
from vllm.entrypoints.openai.serving_models import OpenAIServingModels
110
from vllm.entrypoints.responses_utils import (
111
    construct_input_messages,
112
    construct_tool_dicts,
113
    extract_tool_types,
114
    should_continue_final_message,
115
)
116
from vllm.entrypoints.tool_server import ToolServer
117
from vllm.inputs.data import TokensPrompt
118
from vllm.logger import init_logger
119
120
from vllm.logprobs import Logprob as SampleLogprob
from vllm.logprobs import SampleLogprobs
121
from vllm.outputs import CompletionOutput
122
from vllm.sampling_params import SamplingParams, StructuredOutputsParams
123
from vllm.tokenizers import TokenizerLike
124
125
126
127
128
from vllm.utils import random_uuid

logger = init_logger(__name__)


129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
@dataclass
class HarmonyStreamingState:
    """Mutable state for harmony streaming event processing."""

    current_content_index: int = -1
    current_output_index: int = 0
    current_item_id: str = ""
    sent_output_item_added: bool = False
    is_first_function_call_delta: bool = False

    def reset_for_new_item(self) -> None:
        """Reset state when expecting a new output item."""
        self.current_output_index += 1
        self.sent_output_item_added = False
        self.is_first_function_call_delta = False


146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
def _extract_allowed_tools_from_mcp_requests(
    tools: list[Tool],
) -> dict[str, list[str] | None]:
    """
    Extract allowed_tools mapping from MCP tool requests.

    Returns a dictionary mapping server_label to allowed_tools list.
    Handles both list format and McpAllowedToolsMcpToolFilter object format.

    Special handling:
    - If allowed_tools is None, returns None (allows all tools)
    - If allowed_tools contains "*", returns None (allows all tools)
    - Otherwise, returns the list of specific tool names

    This function can be reused for both harmony and non-harmony MCP calls.
    """
    allowed_tools_map: dict[str, list[str] | None] = {}
    for tool in tools:
        if not isinstance(tool, Mcp):
            continue

        # allowed_tools can be a list or an object with tool_names
        # Extract the actual list of tool names
        allowed_tools_val = None
        if tool.allowed_tools is not None:
            if isinstance(tool.allowed_tools, list):
                allowed_tools_val = tool.allowed_tools
            elif hasattr(tool.allowed_tools, "tool_names"):
                # It's an McpAllowedToolsMcpToolFilter object
                allowed_tools_val = tool.allowed_tools.tool_names

        # Normalize "*" to None (both mean "allow all tools")
        if allowed_tools_val is not None and "*" in allowed_tools_val:
            allowed_tools_val = None

        allowed_tools_map[tool.server_label] = allowed_tools_val
    return allowed_tools_map


185
186
187
188
189
190
class OpenAIServingResponses(OpenAIServing):
    def __init__(
        self,
        engine_client: EngineClient,
        models: OpenAIServingModels,
        *,
191
192
        request_logger: RequestLogger | None,
        chat_template: str | None,
193
194
195
196
        chat_template_content_format: ChatTemplateContentFormatOption,
        return_tokens_as_token_ids: bool = False,
        reasoning_parser: str = "",
        enable_auto_tools: bool = False,
197
198
        tool_parser: str | None = None,
        tool_server: ToolServer | None = None,
199
200
        enable_prompt_tokens_details: bool = False,
        enable_force_include_usage: bool = False,
201
        enable_log_outputs: bool = False,
202
        log_error_stack: bool = False,
203
204
205
206
207
208
    ) -> None:
        super().__init__(
            engine_client=engine_client,
            models=models,
            request_logger=request_logger,
            return_tokens_as_token_ids=return_tokens_as_token_ids,
209
            log_error_stack=log_error_stack,
210
211
212
213
        )

        self.chat_template = chat_template
        self.chat_template_content_format: Final = chat_template_content_format
214
        self.enable_log_outputs = enable_log_outputs
215

216
217
        self.reasoning_parser = self._get_reasoning_parser(
            reasoning_parser_name=reasoning_parser
218
        )
219
220
        self.enable_prompt_tokens_details = enable_prompt_tokens_details
        self.enable_force_include_usage = enable_force_include_usage
221
        self.default_sampling_params = self.model_config.get_diff_sampling_param()
222
223
224
        if self.default_sampling_params:
            source = self.model_config.generation_config
            source = "model" if source == "auto" else source
225
226
227
228
229
            logger.info(
                "Using default chat sampling params from %s: %s",
                source,
                self.default_sampling_params,
            )
230

231
232
233
234
235
        # If False (default), the "store" option is (silently) ignored and the
        # response is not stored. If True, the response is stored in memory.
        # NOTE(woosuk): This may not be intuitive for users, as the default
        # behavior in OpenAI's Responses API is to store the response, but
        # vLLM's default behavior is not.
236
        self.enable_store = envs.VLLM_ENABLE_RESPONSES_API_STORE
237
238
239
240
        if self.enable_store:
            logger.warning_once(
                "`VLLM_ENABLE_RESPONSES_API_STORE` is enabled. This may "
                "cause a memory leak since we never remove responses from "
241
242
                "the store."
            )
243

244
        self.use_harmony = self.model_config.hf_config.model_type == "gpt_oss"
245
        if self.use_harmony:
246
247
248
249
            logger.warning(
                "For gpt-oss, we ignore --enable-auto-tool-choice "
                "and always enable tool use."
            )
250
251
252
253
254
            # OpenAI models have two EOS-like tokens: <|return|> and <|call|>.
            # We need to add them to the stop token ids.
            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(
255
256
                get_stop_tokens_for_assistant_actions()
            )
257
        self.enable_auto_tools = enable_auto_tools
258
        # set up tool use
259
260
261
        self.tool_parser = self._get_tool_parser(
            tool_parser_name=tool_parser, enable_auto_tools=enable_auto_tools
        )
262
        # HACK(woosuk): This is a hack. We should use a better store.
263
264
        # FIXME: If enable_store=True, this may cause a memory leak since we
        # never remove responses from the store.
265
266
267
268
        self.response_store: dict[str, ResponsesResponse] = {}
        self.response_store_lock = asyncio.Lock()

        # HACK(woosuk): This is a hack. We should use a better store.
269
270
        # FIXME: If enable_store=True, this may cause a memory leak since we
        # never remove messages from the store.
271
272
        self.msg_store: dict[str, list[ChatCompletionMessageParam]] = {}

273
274
275
        # HACK(wuhang): This is a hack. We should use a better store.
        # FIXME: If enable_store=True, this may cause a memory leak since we
        # never remove events from the store.
276
277
278
        self.event_store: dict[
            str, tuple[deque[StreamingResponsesResponse], asyncio.Event]
        ] = {}
279

280
281
        self.background_tasks: dict[str, asyncio.Task] = {}

282
283
        self.tool_server = tool_server

284
    def _validate_generator_input(
285
        self, engine_prompt: TokensPrompt
286
    ) -> ErrorResponse | None:
287
288
289
290
291
292
        """Add validations to the input to the generator here."""
        if self.max_model_len <= len(engine_prompt["prompt_token_ids"]):
            error_message = (
                "The engine prompt length"
                f" {len(engine_prompt['prompt_token_ids'])} "
                f"exceeds the max_model_len {self.max_model_len}. "
293
294
                "Please reduce prompt."
            )
295
296
297
298
            return self.create_error_response(
                err_type="invalid_request_error",
                message=error_message,
                status_code=HTTPStatus.BAD_REQUEST,
299
                param="input",
300
301
302
            )
        return None

303
304
305
306
307
308
309
310
    def _validate_create_responses_input(
        self, request: ResponsesRequest
    ) -> ErrorResponse | None:
        if self.use_harmony and request.is_include_output_logprobs():
            return self.create_error_response(
                err_type="invalid_request_error",
                message="logprobs are not supported with gpt-oss models",
                status_code=HTTPStatus.BAD_REQUEST,
311
                param="logprobs",
312
313
314
315
316
317
318
319
320
321
322
323
            )
        if request.store and not self.enable_store and request.background:
            return self.create_error_response(
                err_type="invalid_request_error",
                message=(
                    "This vLLM engine does not support `store=True` and "
                    "therefore does not support the background mode. To "
                    "enable these features, set the environment variable "
                    "`VLLM_ENABLE_RESPONSES_API_STORE=1` when launching "
                    "the vLLM server."
                ),
                status_code=HTTPStatus.BAD_REQUEST,
324
                param="background",
325
            )
326
327
328
329
330
331
        if request.previous_input_messages and request.previous_response_id:
            return self.create_error_response(
                err_type="invalid_request_error",
                message="Only one of `previous_input_messages` and "
                "`previous_response_id` can be set.",
                status_code=HTTPStatus.BAD_REQUEST,
332
                param="previous_response_id",
333
            )
334
335
        return None

336
337
338
    async def create_responses(
        self,
        request: ResponsesRequest,
339
340
341
342
343
344
        raw_request: Request | None = None,
    ) -> (
        AsyncGenerator[StreamingResponsesResponse, None]
        | ResponsesResponse
        | ErrorResponse
    ):
345
346
347
348
        error_check_ret = await self._check_model(request)
        if error_check_ret is not None:
            logger.error("Error with model %s", error_check_ret)
            return error_check_ret
349
350
351
        maybe_validation_error = self._validate_create_responses_input(request)
        if maybe_validation_error is not None:
            return maybe_validation_error
352
353
354
355
356
357
358

        # 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

359
        if request.store and not self.enable_store:
360
361
362
363
364
365
366
            # Disable the store option.
            # NOTE(woosuk): Although returning an error is possible, we opted
            # to implicitly disable store and process the request anyway, as
            # we assume most users do not intend to actually store the response
            # (i.e., their request's `store=True` just because it's the default
            # value).
            request.store = False
367

368
369
370
371
372
373
374
375
376
377
378
        # Handle the previous response ID.
        prev_response_id = request.previous_response_id
        if prev_response_id is not None:
            async with self.response_store_lock:
                prev_response = self.response_store.get(prev_response_id)
            if prev_response is None:
                return self._make_not_found_error(prev_response_id)
        else:
            prev_response = None

        try:
379
            lora_request = self._maybe_get_adapters(request)
380
            model_name = self.models.model_name(lora_request)
381
            tokenizer = await self.engine_client.get_tokenizer()
382

383
            if self.use_harmony:
384
385
                messages, engine_prompts = self._make_request_with_harmony(
                    request, prev_response
386
                )
387
            else:
388
                messages, engine_prompts = await self._make_request(
389
390
                    request, prev_response, tokenizer
                )
391

392
393
394
395
396
397
398
        except (
            ValueError,
            TypeError,
            RuntimeError,
            jinja2.TemplateError,
            NotImplementedError,
        ) as e:
399
            logger.exception("Error in preprocessing prompt inputs")
400
            return self.create_error_response(e)
401

402
        request_metadata = RequestResponseMetadata(request_id=request.request_id)
403
404
405
406
        if raw_request:
            raw_request.state.request_metadata = request_metadata

        # Schedule the request and get the result generator.
407
        generators: list[AsyncGenerator[ConversationContext, None]] = []
408
409

        builtin_tool_list: list[str] = []
410
        if self.tool_server is not None:
411
412
413
414
            if self.tool_server.has_tool("browser"):
                builtin_tool_list.append("browser")
            if self.tool_server.has_tool("python"):
                builtin_tool_list.append("python")
415
416
            if self.tool_server.has_tool("container"):
                builtin_tool_list.append("container")
417

418
419
420
421
422
423
        if self.tool_server is not None:
            available_tools = builtin_tool_list
        else:
            assert len(builtin_tool_list) == 0
            available_tools = []
        try:
424
            for engine_prompt in engine_prompts:
425
426
427
428
                maybe_error = self._validate_generator_input(engine_prompt)
                if maybe_error is not None:
                    return maybe_error

429
                default_max_tokens = self.max_model_len - len(
430
431
                    engine_prompt["prompt_token_ids"]
                )
432

433
                sampling_params = request.to_sampling_params(
434
435
                    default_max_tokens, self.default_sampling_params
                )
436

437
438
439
440
441
                trace_headers = (
                    None
                    if raw_request is None
                    else await self._get_trace_headers(raw_request.headers)
                )
442
443
444
445

                context: ConversationContext
                if self.use_harmony:
                    if request.stream:
446
                        context = StreamingHarmonyContext(messages, available_tools)
447
448
449
                    else:
                        context = HarmonyContext(messages, available_tools)
                else:
450
                    if envs.VLLM_USE_EXPERIMENTAL_PARSER_CONTEXT:
451
                        # This is a feature in development for parsing
452
453
454
455
456
457
                        # tokens during generation instead of at the end
                        context = ParsableContext(
                            response_messages=messages,
                            tokenizer=tokenizer,
                            reasoning_parser_cls=self.reasoning_parser,
                            request=request,
458
459
460
461
                            tool_parser_cls=self.tool_parser,
                            available_tools=available_tools,
                            chat_template=self.chat_template,
                            chat_template_content_format=self.chat_template_content_format,
462
463
464
                        )
                    else:
                        context = SimpleContext()
465
466
467
468
469
470
471
472
473
474
475
476
477

                if self.reasoning_parser is not None:
                    reasoning_parser = self.reasoning_parser(tokenizer)
                    if sampling_params.structured_outputs is None:
                        sampling_params.structured_outputs = StructuredOutputsParams()
                    struct_out = sampling_params.structured_outputs
                    if struct_out.all_non_structural_tag_constraints_none():
                        sampling_params.structured_outputs.structural_tag = (
                            reasoning_parser.prepare_structured_tag(
                                sampling_params.structured_outputs.structural_tag,
                                self.tool_server,
                            )
                        )
478
479
480
481
482
483
484
485
                generator = self._generate_with_builtin_tools(
                    request_id=request.request_id,
                    engine_prompt=engine_prompt,
                    sampling_params=sampling_params,
                    context=context,
                    lora_request=lora_request,
                    priority=request.priority,
                    trace_headers=trace_headers,
486
                )
487
488
                generators.append(generator)
        except ValueError as e:
489
            return self.create_error_response(e)
490

491
        assert len(generators) == 1
492
        (result_generator,) = generators
493
494
495
496

        # Store the input messages.
        if request.store:
            self.msg_store[request.request_id] = messages
497

498
499
500
501
502
503
504
505
506
507
508
509
510
        if request.background:
            created_time = int(time.time())
            response = ResponsesResponse.from_request(
                request,
                sampling_params,
                model_name=model_name,
                created_time=created_time,
                output=[],
                status="queued",
                usage=None,
            )
            async with self.response_store_lock:
                self.response_store[response.id] = response
511

512
            # Run the request in the background.
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
            if request.stream:
                task = asyncio.create_task(
                    self._run_background_request_stream(
                        request,
                        sampling_params,
                        result_generator,
                        context,
                        model_name,
                        tokenizer,
                        request_metadata,
                        created_time,
                    ),
                    name=f"create_{request.request_id}",
                )
            else:
                task = asyncio.create_task(
                    self._run_background_request(
                        request,
                        sampling_params,
                        result_generator,
                        context,
                        model_name,
                        tokenizer,
                        request_metadata,
                        created_time,
                    ),
                    name=f"create_{response.id}",
                )
541

542
543
544
545
            # For cleanup.
            response_id = response.id
            self.background_tasks[response_id] = task
            task.add_done_callback(
546
547
                lambda _: self.background_tasks.pop(response_id, None)
            )
548
549

            if request.stream:
550
                return self.responses_background_stream_generator(request.request_id)
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
            return response

        if request.stream:
            return self.responses_stream_generator(
                request,
                sampling_params,
                result_generator,
                context,
                model_name,
                tokenizer,
                request_metadata,
            )

        try:
            return await self.responses_full_generator(
                request,
                sampling_params,
                result_generator,
                context,
                model_name,
                tokenizer,
                request_metadata,
            )
574
575
        except GenerationError as e:
            return self._convert_generation_error_to_response(e)
576
        except Exception as e:
577
            return self.create_error_response(e)
578

579
580
581
    async def _make_request(
        self,
        request: ResponsesRequest,
582
        prev_response: ResponsesResponse | None,
583
        tokenizer: TokenizerLike,
584
    ):
585
        tool_dicts = construct_tool_dicts(request.tools, request.tool_choice)
586
        # Construct the input messages.
587
588
589
590
591
592
        messages = construct_input_messages(
            request_instructions=request.instructions,
            request_input=request.input,
            prev_msg=self.msg_store.get(prev_response.id) if prev_response else None,
            prev_response_output=prev_response.output if prev_response else None,
        )
593

594
595
596
597
        # Check if we should continue the final message (partial completion)
        # This enables Anthropic-style partial message completion where the
        # user provides an incomplete assistant message to continue from.
        continue_final = should_continue_final_message(request.input)
598
599
600
601
602
603
        chat_template_kwargs = dict(
            reasoning_effort=None
            if request.reasoning is None
            else request.reasoning.effort
        )

604
        _, engine_prompts = await self._preprocess_chat(
605
606
607
            request,
            tokenizer,
            messages,
608
609
            tool_dicts=tool_dicts,
            tool_parser=self.tool_parser,
610
611
            chat_template=self.chat_template,
            chat_template_content_format=self.chat_template_content_format,
612
613
614
615
616
            # When continuing a partial message, we set continue_final_message=True
            # and add_generation_prompt=False so the model continues the message
            # rather than starting a new one.
            add_generation_prompt=not continue_final,
            continue_final_message=continue_final,
617
            chat_template_kwargs=chat_template_kwargs,
618
        )
619
        return messages, engine_prompts
620
621
622
623

    def _make_request_with_harmony(
        self,
        request: ResponsesRequest,
624
        prev_response: ResponsesResponse | None,
625
626
627
    ):
        if request.tool_choice != "auto":
            raise NotImplementedError(
628
629
630
                "Only 'auto' tool_choice is supported in response API with Harmony"
            )
        messages = self._construct_input_messages_with_harmony(request, prev_response)
631
        prompt_token_ids = render_for_completion(messages)
632
        engine_prompt = TokensPrompt(prompt_token_ids=prompt_token_ids)
633
634
635
636
637

        # Add cache_salt if provided in the request
        if request.cache_salt is not None:
            engine_prompt["cache_salt"] = request.cache_salt

638
        return messages, [engine_prompt]
639

640
641
642
643
644
645
    async def _initialize_tool_sessions(
        self,
        request: ResponsesRequest,
        context: ConversationContext,
        exit_stack: AsyncExitStack,
    ):
646
647
648
649
        # we should only initialize the tool session if the request needs tools
        if len(request.tools) == 0:
            return
        mcp_tools = {
650
            tool.server_label: tool for tool in request.tools if tool.type == "mcp"
651
        }
652
653
654
        await context.init_tool_sessions(
            self.tool_server, exit_stack, request.request_id, mcp_tools
        )
655

656
657
658
659
    async def responses_full_generator(
        self,
        request: ResponsesRequest,
        sampling_params: SamplingParams,
660
        result_generator: AsyncIterator[ConversationContext],
661
        context: ConversationContext,
662
        model_name: str,
663
        tokenizer: TokenizerLike,
664
        request_metadata: RequestResponseMetadata,
665
666
        created_time: int | None = None,
    ) -> ErrorResponse | ResponsesResponse:
667
668
669
        if created_time is None:
            created_time = int(time.time())

670
671
        async with AsyncExitStack() as exit_stack:
            try:
672
                await self._initialize_tool_sessions(request, context, exit_stack)
673
674
675
676
677
                async for _ in result_generator:
                    pass
            except asyncio.CancelledError:
                return self.create_error_response("Client disconnected")
            except ValueError as e:
678
                return self.create_error_response(e)
679

680
681
682
683
684
        # NOTE: Implementation of stauts is still WIP, but for now
        # we guarantee that if the status is not "completed", it is accurate.
        # "completed" is implemented as the "catch-all" for now.
        status: ResponseStatus = "completed"

685
686
        input_messages: ResponseInputOutputMessage | None = None
        output_messages: ResponseInputOutputMessage | None = None
687
688
689
        if self.use_harmony:
            assert isinstance(context, HarmonyContext)
            output = self._make_response_output_items_with_harmony(context)
690
            if request.enable_response_messages:
691
692
                input_messages = context.messages[: context.num_init_messages]
                output_messages = context.messages[context.num_init_messages :]
693
            num_tool_output_tokens = context.num_tool_output_tokens
694
695
696
697
698
            if len(output) > 0:
                if context.finish_reason == "length":
                    status = "incomplete"
                elif context.finish_reason == "abort":
                    status = "cancelled"
699
700
                else:
                    self._raise_if_error(context.finish_reason, request.request_id)
701
702
            else:
                status = "incomplete"
703
        elif isinstance(context, ParsableContext):
704
            output = context.parser.make_response_output_items_from_parsable_context()
705
706

            if request.enable_response_messages:
707
708
                input_messages = context.input_messages
                output_messages = context.output_messages
709
710
711
712

            # TODO: Calculate usage.
            # assert final_res.prompt_token_ids is not None
            num_tool_output_tokens = 0
713
714
715
716

            # Check finish reason from the parser
            if context.parser.finish_reason == "length":
                status = "incomplete"
717
        else:
718
            assert isinstance(context, SimpleContext)
719
720
            # Use final_output which has accumulated text/token_ids/logprobs
            final_res = context.final_output
721
722
723
724
            assert final_res is not None
            assert len(final_res.outputs) == 1
            final_output = final_res.outputs[0]

725
726
727
            # finish_reason='error' indicates retryable internal error
            self._raise_if_error(final_output.finish_reason, request.request_id)

728
729
730
731
            # Check if generation was stopped due to max_tokens
            if final_output.finish_reason == "length":
                status = "incomplete"

732
            output = self._make_response_output_items(request, final_output, tokenizer)
733

734
            if request.enable_response_messages:
735
736
737
                input_messages = context.input_messages
                output_messages = context.output_messages

738
739
            # Calculate usage.
            assert final_res.prompt_token_ids is not None
740
741
            num_tool_output_tokens = 0

742
        assert isinstance(context, (SimpleContext, HarmonyContext, ParsableContext))
743
744
745
746
        num_prompt_tokens = context.num_prompt_tokens
        num_generated_tokens = context.num_output_tokens
        num_cached_tokens = context.num_cached_tokens
        num_reasoning_tokens = context.num_reasoning_tokens
747
748
749
750

        usage = ResponseUsage(
            input_tokens=num_prompt_tokens,
            output_tokens=num_generated_tokens,
751
            total_tokens=num_prompt_tokens + num_generated_tokens,
752
753
754
755
756
757
758
759
760
            input_tokens_details=InputTokensDetails(
                cached_tokens=num_cached_tokens,
                input_tokens_per_turn=[
                    turn.input_tokens for turn in context.all_turn_metrics
                ],
                cached_tokens_per_turn=[
                    turn.cached_input_tokens for turn in context.all_turn_metrics
                ],
            ),
761
            output_tokens_details=OutputTokensDetails(
762
                reasoning_tokens=num_reasoning_tokens,
763
                tool_output_tokens=num_tool_output_tokens,
764
765
766
767
768
769
                output_tokens_per_turn=[
                    turn.output_tokens for turn in context.all_turn_metrics
                ],
                tool_output_tokens_per_turn=[
                    turn.tool_output_tokens for turn in context.all_turn_metrics
                ],
770
            ),
771
772
773
774
        )
        response = ResponsesResponse.from_request(
            request,
            sampling_params,
775
776
            input_messages=input_messages,
            output_messages=output_messages,
777
778
779
            model_name=model_name,
            created_time=created_time,
            output=output,
780
            status=status,
781
782
783
784
785
786
787
            usage=usage,
        )

        if request.store:
            async with self.response_store_lock:
                stored_response = self.response_store.get(response.id)
                # If the response is already cancelled, don't update it.
788
                if stored_response is None or stored_response.status != "cancelled":
789
790
791
                    self.response_store[response.id] = response
        return response

792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
    def _is_mcp_tool_by_namespace(self, recipient: str | None) -> bool:
        """
        Determine if a tool call is an MCP tool based on recipient prefix.

        - Tools starting with "functions." are function calls
        - Everything else is an MCP tool
        """
        if recipient is None:
            return False

        # Function calls have "functions." prefix
        # Everything else is an MCP tool
        return not recipient.startswith("functions.")

    _TOOL_NAME_TO_MCP_SERVER_LABEL: Final[dict[str, str]] = {
        "python": "code_interpreter",
        "container": "container",
        "browser": "web_search_preview",
    }

812
813
814
815
    def _topk_logprobs(
        self,
        logprobs: dict[int, SampleLogprob],
        top_logprobs: int,
816
        tokenizer: TokenizerLike,
817
    ) -> list[LogprobTopLogprob]:
818
819
820
821
822
        """Returns the top-k logprobs from the logprobs dictionary."""
        out = []
        for i, (token_id, _logprob) in enumerate(logprobs.items()):
            if i >= top_logprobs:
                break
823
824
825
826
827
            text = (
                _logprob.decoded_token
                if _logprob.decoded_token is not None
                else tokenizer.decode([token_id])
            )
828
829
830
831
832
            out.append(
                LogprobTopLogprob(
                    token=text,
                    logprob=max(_logprob.logprob, -9999.0),
                    bytes=list(text.encode("utf-8", errors="replace")),
833
834
                )
            )
835
836
837
        return out

    def _create_response_logprobs(
838
839
        self,
        token_ids: Sequence[int],
840
        logprobs: SampleLogprobs | None,
841
        tokenizer: TokenizerLike,
842
        top_logprobs: int | None = None,
843
    ) -> list[Logprob]:
844
845
        assert logprobs is not None, "logprobs must be provided"
        assert len(token_ids) == len(logprobs), (
846
847
            "token_ids and logprobs.token_ids must have the same length"
        )
848
849
850
851
        out = []
        for i, token_id in enumerate(token_ids):
            logprob = logprobs[i]
            token_logprob = logprob[token_id]
852
853
854
855
856
            text = (
                token_logprob.decoded_token
                if token_logprob.decoded_token is not None
                else tokenizer.decode([token_id])
            )
857
858
859
860
861
            out.append(
                Logprob(
                    token=text,
                    logprob=max(token_logprob.logprob, -9999.0),
                    bytes=list(text.encode("utf-8", errors="replace")),
862
863
864
865
866
867
868
                    top_logprobs=(
                        self._topk_logprobs(
                            logprob, top_logprobs=top_logprobs, tokenizer=tokenizer
                        )
                        if top_logprobs
                        else []
                    ),
869
870
                )
            )
871
872
        return out

873
874
875
    def _create_stream_response_logprobs(
        self,
        token_ids: Sequence[int],
876
        logprobs: SampleLogprobs | None,
877
        tokenizer: TokenizerLike,
878
        top_logprobs: int | None = None,
879
    ) -> list[response_text_delta_event.Logprob]:
880
881
882
883
884
885
        lgs = self._create_response_logprobs(
            token_ids=token_ids,
            logprobs=logprobs,
            tokenizer=tokenizer,
            top_logprobs=top_logprobs,
        )
886
887
888
889
890
891
        return [
            response_text_delta_event.Logprob(
                token=lg.token,
                logprob=lg.logprob,
                top_logprobs=[
                    response_text_delta_event.LogprobTopLogprob(
892
893
                        token=tl.token, logprob=tl.logprob
                    )
894
                    for tl in lg.top_logprobs
895
896
897
                ],
            )
            for lg in lgs
898
899
        ]

900
901
902
903
    def _make_response_output_items(
        self,
        request: ResponsesRequest,
        final_output: CompletionOutput,
904
        tokenizer: TokenizerLike,
905
906
907
908
909
910
911
912
    ) -> list[ResponseOutputItem]:
        if self.reasoning_parser:
            try:
                reasoning_parser = self.reasoning_parser(tokenizer)
            except RuntimeError as e:
                logger.exception("Error in reasoning parser creation.")
                raise e

913
            reasoning, content = reasoning_parser.extract_reasoning(
914
915
                final_output.text, request=request
            )
916
        else:
917
            reasoning = None
918
919
            content = final_output.text

920
921
922
923
924
        # Log complete response if output logging is enabled
        if self.enable_log_outputs and self.request_logger:
            output_text = ""
            if content:
                output_text = content
925
926
            elif reasoning:
                output_text = f"[reasoning: {reasoning}]"
927
928
929
930
931
932
933
934
935
936
937

            if output_text:
                self.request_logger.log_outputs(
                    request_id=request.request_id,
                    outputs=output_text,
                    output_token_ids=final_output.token_ids,
                    finish_reason=final_output.finish_reason,
                    is_streaming=False,
                    delta=False,
                )

938
939
        reasoning_item = None
        message_item = None
940
        if reasoning:
941
942
943
944
945
            reasoning_item = ResponseReasoningItem(
                id=f"rs_{random_uuid()}",
                summary=[],
                type="reasoning",
                content=[
946
                    ResponseReasoningTextContent(text=reasoning, type="reasoning_text")
947
948
949
                ],
                status=None,  # NOTE: Only the last output item has status.
            )
950
951
952
953
954
955
956
        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,
        )
957
958
959
960
961
        if content:
            output_text = ResponseOutputText(
                text=content,
                annotations=[],  # TODO
                type="output_text",
962
963
964
965
966
967
968
969
970
971
                logprobs=(
                    self._create_response_logprobs(
                        token_ids=final_output.token_ids,
                        logprobs=final_output.logprobs,
                        tokenizer=tokenizer,
                        top_logprobs=request.top_logprobs,
                    )
                    if request.is_include_output_logprobs()
                    else None
                ),
972
            )
973
            message_item = ResponseOutputMessage(
974
975
976
977
978
979
                id=f"msg_{random_uuid()}",
                content=[output_text],
                role="assistant",
                status="completed",
                type="message",
            )
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
        outputs = []

        if reasoning_item:
            outputs.append(reasoning_item)
        if message_item:
            outputs.append(message_item)
        if tool_calls:
            tool_call_items = [
                ResponseFunctionToolCall(
                    id=f"fc_{random_uuid()}",
                    call_id=f"call_{random_uuid()}",
                    type="function_call",
                    status="completed",
                    name=tool_call.name,
                    arguments=tool_call.arguments,
                )
                for tool_call in tool_calls
            ]
            outputs.extend(tool_call_items)
        return outputs
1000
1001
1002
1003
1004

    def _make_response_output_items_with_harmony(
        self,
        context: HarmonyContext,
    ) -> list[ResponseOutputItem]:
1005
        output_items: list[ResponseOutputItem] = []
1006
1007
1008
1009
1010
1011
1012
1013
1014
        num_init_messages = context.num_init_messages
        for msg in context.messages[num_init_messages:]:
            output_items.extend(parse_output_message(msg))
        # Handle the generation stopped in the middle (if any).
        last_items = parse_remaining_state(context.parser)
        if last_items:
            output_items.extend(last_items)
        return output_items

1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
    def _extract_system_message_from_request(self, request) -> str | None:
        system_msg = None
        if not isinstance(request.input, str):
            for response_msg in request.input:
                if (
                    isinstance(response_msg, dict)
                    and response_msg.get("role") == "system"
                ):
                    system_msg = response_msg.get("content")
                    break
        return system_msg

1027
    def _construct_harmony_system_input_message(
1028
        self, request: ResponsesRequest, with_custom_tools: bool, tool_types: set[str]
1029
    ) -> OpenAIHarmonyMessage:
1030
1031
        model_identity = self._extract_system_message_from_request(request)

1032
        reasoning_effort = request.reasoning.effort if request.reasoning else None
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043

        # Extract allowed_tools from MCP tool requests
        allowed_tools_map = _extract_allowed_tools_from_mcp_requests(request.tools)

        # Get filtered tool descriptions first.
        # If get_tool_description returns None (due to filtering), the tool is disabled.
        browser_description = (
            self.tool_server.get_tool_description(
                "browser", allowed_tools_map.get("web_search_preview")
            )
            if "web_search_preview" in tool_types
1044
1045
            and self.tool_server is not None
            and self.tool_server.has_tool("browser")
1046
            else None
1047
        )
1048
1049
1050
1051
1052
        python_description = (
            self.tool_server.get_tool_description(
                "python", allowed_tools_map.get("code_interpreter")
            )
            if "code_interpreter" in tool_types
1053
1054
            and self.tool_server is not None
            and self.tool_server.has_tool("python")
1055
            else None
1056
        )
1057
1058
1059
1060
1061
        container_description = (
            self.tool_server.get_tool_description(
                "container", allowed_tools_map.get("container")
            )
            if "container" in tool_types
1062
1063
            and self.tool_server is not None
            and self.tool_server.has_tool("container")
1064
            else None
1065
        )
1066

1067
        sys_msg = get_system_message(
1068
            model_identity=model_identity,
1069
            reasoning_effort=reasoning_effort,
1070
1071
1072
            browser_description=browser_description,
            python_description=python_description,
            container_description=container_description,
1073
1074
1075
1076
1077
            instructions=request.instructions,
            with_custom_tools=with_custom_tools,
        )
        return sys_msg

1078
1079
1080
    def _construct_input_messages_with_harmony(
        self,
        request: ResponsesRequest,
1081
        prev_response: ResponsesResponse | None,
1082
1083
1084
1085
    ) -> list[OpenAIHarmonyMessage]:
        messages: list[OpenAIHarmonyMessage] = []
        if prev_response is None:
            # New conversation.
1086
            tool_types = extract_tool_types(request.tools)
1087
            with_custom_tools = has_custom_tools(tool_types)
1088
1089
1090

            sys_msg = self._construct_harmony_system_input_message(
                request, with_custom_tools, tool_types
1091
1092
            )
            messages.append(sys_msg)
1093
1094
            if with_custom_tools:
                dev_msg = get_developer_message(
1095
1096
                    instructions=request.instructions, tools=request.tools
                )
1097
                messages.append(dev_msg)
1098
1099
            messages += construct_harmony_previous_input_messages(request)

1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
        else:
            # Continue the previous conversation.
            # FIXME(woosuk): Currently, request params like reasoning and
            # instructions are ignored.
            prev_msgs = self.msg_store[prev_response.id]
            # Remove the previous chain-of-thoughts if there is a new "final"
            # message. Note that this also removes these messages from the
            # msg_store.
            if len(prev_msgs) > 0:
                last_msg = prev_msgs[-1]
                assert isinstance(last_msg, OpenAIHarmonyMessage)
                if last_msg.channel == "final":
                    prev_final_msg_idx = -1
                    for i in range(len(prev_msgs) - 2, -1, -1):
                        prev_msg_i = prev_msgs[i]
                        assert isinstance(prev_msg_i, OpenAIHarmonyMessage)
                        if prev_msg_i.channel == "final":
                            prev_final_msg_idx = i
                            break
1119
1120
                    recent_turn_msgs = prev_msgs[prev_final_msg_idx + 1 :]
                    del prev_msgs[prev_final_msg_idx + 1 :]
1121
1122
                    for msg in recent_turn_msgs:
                        assert isinstance(msg, OpenAIHarmonyMessage)
1123
                        prev_msgs.append(msg)
1124
1125
            messages.extend(prev_msgs)
        # Append the new input.
co63oc's avatar
co63oc committed
1126
        # Responses API supports simple text inputs without chat format.
1127
1128
1129
1130
1131
1132
1133
1134
        if isinstance(request.input, str):
            messages.append(get_user_message(request.input))
        else:
            if prev_response is not None:
                prev_outputs = copy(prev_response.output)
            else:
                prev_outputs = []
            for response_msg in request.input:
1135
1136
1137
1138
                new_msg = parse_response_input(response_msg, prev_outputs)
                if new_msg.author.role != "system":
                    messages.append(new_msg)

1139
                # User passes in a tool call request and its output. We need
1140
1141
1142
1143
1144
1145
1146
                # to add the tool call request to prev_outputs so that the
                # parse_response_input can find the tool call request when
                # parsing the tool call output.
                if isinstance(response_msg, ResponseFunctionToolCall):
                    prev_outputs.append(response_msg)
        return messages

1147
1148
1149
1150
1151
1152
    async def _run_background_request_stream(
        self,
        request: ResponsesRequest,
        *args,
        **kwargs,
    ):
1153
        event_deque: deque[StreamingResponsesResponse] = deque()
1154
1155
1156
1157
        new_event_signal = asyncio.Event()
        self.event_store[request.request_id] = (event_deque, new_event_signal)
        response = None
        try:
1158
            generator = self.responses_stream_generator(request, *args, **kwargs)
1159
1160
1161
            async for event in generator:
                event_deque.append(event)
                new_event_signal.set()  # Signal new event available
1162
1163
        except GenerationError as e:
            response = self._convert_generation_error_to_response(e)
1164
        except Exception as e:
1165
            logger.exception("Background request failed for %s", request.request_id)
1166
            response = self.create_error_response(e)
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
        finally:
            new_event_signal.set()

        if response is not None and isinstance(response, ErrorResponse):
            # If the request has failed, update the status to "failed".
            response_id = request.request_id
            async with self.response_store_lock:
                stored_response = self.response_store.get(response_id)
                assert stored_response is not None
                if stored_response.status not in ("completed", "cancelled"):
                    stored_response.status = "failed"

1179
1180
1181
1182
1183
1184
1185
    async def _run_background_request(
        self,
        request: ResponsesRequest,
        *args,
        **kwargs,
    ):
        try:
1186
            response = await self.responses_full_generator(request, *args, **kwargs)
1187
1188
        except GenerationError as e:
            response = self._convert_generation_error_to_response(e)
1189
        except Exception as e:
1190
            logger.exception("Background request failed for %s", request.request_id)
1191
            response = self.create_error_response(e)
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201

        if isinstance(response, ErrorResponse):
            # If the request has failed, update the status to "failed".
            response_id = request.request_id
            async with self.response_store_lock:
                stored_response = self.response_store.get(response_id)
                assert stored_response is not None
                if stored_response.status not in ("completed", "cancelled"):
                    stored_response.status = "failed"

1202
1203
1204
    async def responses_background_stream_generator(
        self,
        response_id: str,
1205
        starting_after: int | None = None,
1206
    ) -> AsyncGenerator[StreamingResponsesResponse, None]:
1207
        if response_id not in self.event_store:
1208
1209
1210
1211
1212
            raise VLLMValidationError(
                f"Unknown response_id: {response_id}",
                parameter="response_id",
                value=response_id,
            )
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224

        event_deque, new_event_signal = self.event_store[response_id]
        start_index = 0 if starting_after is None else starting_after + 1
        current_index = start_index

        while True:
            new_event_signal.clear()

            # Yield existing events from start_index
            while current_index < len(event_deque):
                event = event_deque[current_index]
                yield event
1225
                if getattr(event, "type", "unknown") == "response.completed":
1226
                    return
1227
1228
1229
1230
                current_index += 1

            await new_event_signal.wait()

1231
1232
1233
    async def retrieve_responses(
        self,
        response_id: str,
1234
1235
1236
1237
1238
1239
1240
        starting_after: int | None,
        stream: bool | None,
    ) -> (
        ErrorResponse
        | ResponsesResponse
        | AsyncGenerator[StreamingResponsesResponse, None]
    ):
1241
1242
1243
1244
1245
        async with self.response_store_lock:
            response = self.response_store.get(response_id)

        if response is None:
            return self._make_not_found_error(response_id)
1246
1247
1248
1249
1250
1251

        if stream:
            return self.responses_background_stream_generator(
                response_id,
                starting_after,
            )
1252
1253
1254
1255
1256
        return response

    async def cancel_responses(
        self,
        response_id: str,
1257
    ) -> ErrorResponse | ResponsesResponse:
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
        async with self.response_store_lock:
            response = self.response_store.get(response_id)
            if response is None:
                return self._make_not_found_error(response_id)

            prev_status = response.status
            if prev_status not in ("queued", "in_progress"):
                return self.create_error_response(
                    err_type="invalid_request_error",
                    message="Cannot cancel a synchronous response.",
1268
                    param="response_id",
1269
1270
1271
1272
1273
1274
                )

            # Update the status to "cancelled".
            response.status = "cancelled"

        # Abort the request.
1275
        if task := self.background_tasks.get(response_id):
1276
1277
1278
1279
            task.cancel()
            try:
                await task
            except asyncio.CancelledError:
1280
                logger.exception("Background task for %s was cancelled", response_id)
1281
1282
1283
1284
1285
1286
1287
        return response

    def _make_not_found_error(self, response_id: str) -> ErrorResponse:
        return self.create_error_response(
            err_type="invalid_request_error",
            message=f"Response with id '{response_id}' not found.",
            status_code=HTTPStatus.NOT_FOUND,
1288
            param="response_id",
1289
        )
1290
1291
1292
1293

    def _make_store_not_supported_error(self) -> ErrorResponse:
        return self.create_error_response(
            err_type="invalid_request_error",
1294
1295
1296
1297
1298
1299
            message=(
                "`store=True` (default) is not supported. Please set "
                "`store=False` in Responses API or set "
                "`VLLM_ENABLE_RESPONSES_API_STORE=1` in the env var when "
                "starting the vLLM server."
            ),
1300
            status_code=HTTPStatus.BAD_REQUEST,
1301
            param="store",
1302
        )
1303

1304
    async def _process_simple_streaming_events(
1305
1306
1307
        self,
        request: ResponsesRequest,
        sampling_params: SamplingParams,
1308
        result_generator: AsyncIterator[ConversationContext | None],
1309
1310
        context: ConversationContext,
        model_name: str,
1311
        tokenizer: TokenizerLike,
1312
        request_metadata: RequestResponseMetadata,
1313
        created_time: int,
1314
        _increment_sequence_number_and_return: Callable[
1315
1316
            [StreamingResponsesResponse], StreamingResponsesResponse
        ],
1317
    ) -> AsyncGenerator[StreamingResponsesResponse, None]:
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
        current_content_index = 0
        current_output_index = 0
        current_item_id = ""
        reasoning_parser = None
        if self.reasoning_parser:
            reasoning_parser = self.reasoning_parser(tokenizer)
        previous_text = ""
        previous_token_ids: list[int] = []
        first_delta_sent = False
        previous_delta_messages: list[DeltaMessage] = []
        async for ctx in result_generator:
            assert isinstance(ctx, SimpleContext)
            if ctx.last_output is None:
                continue
            if ctx.last_output.outputs:
                output = ctx.last_output.outputs[0]
1334
1335
                # finish_reason='error' indicates a retryable error
                self._raise_if_error(output.finish_reason, request.request_id)
1336
                if reasoning_parser:
1337
1338
1339
1340
1341
1342
1343
                    delta_message = reasoning_parser.extract_reasoning_streaming(
                        previous_text=previous_text,
                        current_text=previous_text + output.text,
                        delta_text=output.text,
                        previous_token_ids=previous_token_ids,
                        current_token_ids=previous_token_ids + output.token_ids,
                        delta_token_ids=output.token_ids,
1344
1345
                    )
                else:
1346
1347
1348
                    delta_message = DeltaMessage(
                        content=output.text,
                    )
1349
1350
1351
1352
1353
1354
                previous_text += output.text
                previous_token_ids += output.token_ids
                if not delta_message:
                    continue
                if not first_delta_sent:
                    current_item_id = str(uuid.uuid4())
1355
                    if delta_message.reasoning:
1356
                        yield _increment_sequence_number_and_return(
1357
1358
1359
1360
                            ResponseOutputItemAddedEvent(
                                type="response.output_item.added",
                                sequence_number=-1,
                                output_index=current_output_index,
1361
                                item=ResponseReasoningItem(
1362
1363
1364
1365
1366
                                    type="reasoning",
                                    id=current_item_id,
                                    summary=[],
                                    status="in_progress",
                                ),
1367
1368
                            )
                        )
1369
                    else:
1370
                        yield _increment_sequence_number_and_return(
1371
1372
1373
1374
                            ResponseOutputItemAddedEvent(
                                type="response.output_item.added",
                                sequence_number=-1,
                                output_index=current_output_index,
1375
                                item=ResponseOutputMessage(
1376
1377
1378
1379
1380
1381
                                    id=current_item_id,
                                    type="message",
                                    role="assistant",
                                    content=[],
                                    status="in_progress",
                                ),
1382
1383
                            )
                        )
1384
                    yield _increment_sequence_number_and_return(
1385
                        ResponseContentPartAddedEvent(
1386
1387
1388
1389
1390
                            type="response.content_part.added",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
                            content_index=current_content_index,
1391
                            part=ResponseOutputText(
1392
1393
1394
1395
1396
                                type="output_text",
                                text="",
                                annotations=[],
                                logprobs=[],
                            ),
1397
1398
                        )
                    )
1399
1400
1401
1402
1403
1404
                    current_content_index += 1
                    first_delta_sent = True
                # todo(kebe7jun) tool call support

                # check delta message and previous delta message are
                # same as content or reasoning content
1405
1406
                if (
                    previous_delta_messages
1407
                    and previous_delta_messages[-1].reasoning is not None
1408
1409
                    and delta_message.content is not None
                ):
1410
1411
                    # from reasoning to normal content, send done
                    # event for reasoning
1412
                    reason_content = "".join(
1413
                        pm.reasoning
1414
                        for pm in previous_delta_messages
1415
                        if pm.reasoning is not None
1416
                    )
1417
                    yield _increment_sequence_number_and_return(
1418
1419
1420
1421
1422
1423
1424
                        ResponseReasoningTextDoneEvent(
                            type="response.reasoning_text.done",
                            item_id=current_item_id,
                            sequence_number=-1,
                            output_index=current_output_index,
                            content_index=current_content_index,
                            text=reason_content,
1425
1426
                        )
                    )
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
                    current_content_index = 0
                    reasoning_item = ResponseReasoningItem(
                        type="reasoning",
                        content=[
                            ResponseReasoningTextContent(
                                text=reason_content,
                                type="reasoning_text",
                            ),
                        ],
                        status="completed",
                        id=current_item_id,
                        summary=[],
                    )
1440
                    yield _increment_sequence_number_and_return(
1441
1442
1443
1444
1445
                        ResponseOutputItemDoneEvent(
                            type="response.output_item.done",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item=reasoning_item,
1446
1447
                        )
                    )
1448
                    yield _increment_sequence_number_and_return(
1449
                        ResponseOutputItemAddedEvent(
1450
1451
1452
                            type="response.output_item.added",
                            sequence_number=-1,
                            output_index=current_output_index,
1453
                            item=ResponseOutputMessage(
1454
1455
1456
1457
1458
1459
                                id=current_item_id,
                                type="message",
                                role="assistant",
                                content=[],
                                status="in_progress",
                            ),
1460
1461
                        )
                    )
1462
1463
                    current_output_index += 1
                    current_item_id = str(uuid.uuid4())
1464
                    yield _increment_sequence_number_and_return(
1465
                        ResponseContentPartAddedEvent(
1466
1467
1468
1469
1470
                            type="response.content_part.added",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
                            content_index=current_content_index,
1471
                            part=ResponseOutputText(
1472
1473
1474
1475
1476
                                type="output_text",
                                text="",
                                annotations=[],
                                logprobs=[],
                            ),
1477
1478
                        )
                    )
1479
1480
1481
                    current_content_index += 1
                    # reset previous delta messages
                    previous_delta_messages = []
1482

1483
                if delta_message.reasoning is not None:
1484
                    yield _increment_sequence_number_and_return(
1485
1486
1487
1488
1489
1490
                        ResponseReasoningTextDeltaEvent(
                            type="response.reasoning_text.delta",
                            sequence_number=-1,
                            content_index=current_content_index,
                            output_index=current_output_index,
                            item_id=current_item_id,
1491
                            delta=delta_message.reasoning,
1492
1493
                        )
                    )
1494
                elif delta_message.content is not None:
1495
                    yield _increment_sequence_number_and_return(
1496
                        ResponseTextDeltaEvent(
1497
1498
1499
1500
1501
1502
                            type="response.output_text.delta",
                            sequence_number=-1,
                            content_index=current_content_index,
                            output_index=current_output_index,
                            item_id=current_item_id,
                            delta=delta_message.content,
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
                            logprobs=(
                                self._create_stream_response_logprobs(
                                    token_ids=output.token_ids,
                                    logprobs=output.logprobs,
                                    tokenizer=tokenizer,
                                    top_logprobs=request.top_logprobs,
                                )
                                if request.is_include_output_logprobs()
                                else []
                            ),
1513
1514
                        )
                    )
1515
1516
1517
1518
                current_content_index += 1

                previous_delta_messages.append(delta_message)
        if previous_delta_messages:
1519
            if previous_delta_messages[-1].reasoning is not None:
1520
                reason_content = "".join(
1521
                    pm.reasoning
1522
                    for pm in previous_delta_messages
1523
                    if pm.reasoning is not None
1524
                )
1525
                yield _increment_sequence_number_and_return(
1526
1527
1528
1529
1530
1531
1532
                    ResponseReasoningTextDoneEvent(
                        type="response.reasoning_text.done",
                        item_id=current_item_id,
                        sequence_number=-1,
                        output_index=current_output_index,
                        content_index=current_content_index,
                        text=reason_content,
1533
1534
                    )
                )
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
                current_content_index += 1
                reasoning_item = ResponseReasoningItem(
                    type="reasoning",
                    content=[
                        ResponseReasoningTextContent(
                            text=reason_content,
                            type="reasoning_text",
                        ),
                    ],
                    status="completed",
                    id=current_item_id,
                    summary=[],
                )
1548
                yield _increment_sequence_number_and_return(
1549
1550
1551
1552
1553
                    ResponseOutputItemDoneEvent(
                        type="response.output_item.done",
                        sequence_number=-1,
                        output_index=current_output_index,
                        item=reasoning_item,
1554
1555
                    )
                )
1556
            elif previous_delta_messages[-1].content is not None:
1557
1558
1559
1560
1561
                final_content = "".join(
                    pm.content
                    for pm in previous_delta_messages
                    if pm.content is not None
                )
1562
                yield _increment_sequence_number_and_return(
1563
                    ResponseTextDoneEvent(
1564
1565
1566
1567
1568
1569
1570
                        type="response.output_text.done",
                        sequence_number=-1,
                        output_index=current_output_index,
                        content_index=current_content_index,
                        text=final_content,
                        logprobs=[],
                        item_id=current_item_id,
1571
1572
                    )
                )
1573
1574
1575
1576
1577
1578
                current_content_index += 1
                part = ResponseOutputText(
                    text=final_content,
                    type="output_text",
                    annotations=[],
                )
1579
                yield _increment_sequence_number_and_return(
1580
                    ResponseContentPartDoneEvent(
1581
1582
1583
1584
1585
1586
                        type="response.content_part.done",
                        sequence_number=-1,
                        item_id=current_item_id,
                        output_index=current_output_index,
                        content_index=current_content_index,
                        part=part,
1587
1588
                    )
                )
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
                current_content_index += 1
                item = ResponseOutputMessage(
                    type="message",
                    role="assistant",
                    content=[
                        part,
                    ],
                    status="completed",
                    id=current_item_id,
                    summary=[],
                )
1600
                yield _increment_sequence_number_and_return(
1601
1602
1603
1604
1605
                    ResponseOutputItemDoneEvent(
                        type="response.output_item.done",
                        sequence_number=-1,
                        output_index=current_output_index,
                        item=item,
1606
1607
                    )
                )
1608

1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
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
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
    def _emit_function_call_done_events(
        self,
        previous_item,
        state: HarmonyStreamingState,
    ) -> list[StreamingResponsesResponse]:
        """Emit events when a function call completes."""
        function_name = previous_item.recipient[len("functions.") :]
        events = []
        events.append(
            ResponseFunctionCallArgumentsDoneEvent(
                type="response.function_call_arguments.done",
                arguments=previous_item.content[0].text,
                name=function_name,
                item_id=state.current_item_id,
                output_index=state.current_output_index,
                sequence_number=-1,
            )
        )
        function_call_item = ResponseFunctionToolCall(
            type="function_call",
            arguments=previous_item.content[0].text,
            name=function_name,
            item_id=state.current_item_id,
            output_index=state.current_output_index,
            sequence_number=-1,
            call_id=f"fc_{random_uuid()}",
            status="completed",
        )
        events.append(
            ResponseOutputItemDoneEvent(
                type="response.output_item.done",
                sequence_number=-1,
                output_index=state.current_output_index,
                item=function_call_item,
            )
        )
        return events

    def _emit_mcp_call_done_events(
        self,
        previous_item,
        state: HarmonyStreamingState,
    ) -> list[StreamingResponsesResponse]:
        """Emit events when an MCP tool call completes."""
        server_label = self._TOOL_NAME_TO_MCP_SERVER_LABEL.get(
            previous_item.recipient, previous_item.recipient
        )
        events = []
        events.append(
            ResponseMcpCallArgumentsDoneEvent(
                type="response.mcp_call_arguments.done",
                arguments=previous_item.content[0].text,
                name=previous_item.recipient,
                item_id=state.current_item_id,
                output_index=state.current_output_index,
                sequence_number=-1,
            )
        )
        events.append(
            ResponseMcpCallCompletedEvent(
                type="response.mcp_call.completed",
                sequence_number=-1,
                output_index=state.current_output_index,
                item_id=state.current_item_id,
            )
        )
        events.append(
            ResponseOutputItemDoneEvent(
                type="response.output_item.done",
                sequence_number=-1,
                output_index=state.current_output_index,
                item=McpCall(
                    type="mcp_call",
                    arguments=previous_item.content[0].text,
                    name=previous_item.recipient,
                    id=state.current_item_id,
                    server_label=server_label,
                    status="completed",
                ),
            )
        )
        return events

    def _emit_reasoning_done_events(
        self,
        previous_item,
        state: HarmonyStreamingState,
    ) -> list[StreamingResponsesResponse]:
        """Emit events when a reasoning (analysis) item completes."""
        content = ResponseReasoningTextContent(
            text=previous_item.content[0].text,
            type="reasoning_text",
        )
        reasoning_item = ResponseReasoningItem(
            type="reasoning",
            content=[content],
            status="completed",
            id=state.current_item_id,
            summary=[],
        )
        events = []
        events.append(
            ResponseReasoningTextDoneEvent(
                type="response.reasoning_text.done",
                item_id=state.current_item_id,
                sequence_number=-1,
                output_index=state.current_output_index,
                content_index=state.current_content_index,
                text=previous_item.content[0].text,
            )
        )
        events.append(
            ResponseReasoningPartDoneEvent(
                type="response.reasoning_part.done",
                sequence_number=-1,
                item_id=state.current_item_id,
                output_index=state.current_output_index,
                content_index=state.current_content_index,
                part=content,
            )
        )
        events.append(
            ResponseOutputItemDoneEvent(
                type="response.output_item.done",
                sequence_number=-1,
                output_index=state.current_output_index,
                item=reasoning_item,
            )
        )
        return events

    def _emit_text_output_done_events(
        self,
        previous_item,
        state: HarmonyStreamingState,
    ) -> list[StreamingResponsesResponse]:
        """Emit events when a final text output item completes."""
        text_content = ResponseOutputText(
            type="output_text",
            text=previous_item.content[0].text,
            annotations=[],
        )
        events = []
        events.append(
            ResponseTextDoneEvent(
                type="response.output_text.done",
                sequence_number=-1,
                output_index=state.current_output_index,
                content_index=state.current_content_index,
                text=previous_item.content[0].text,
                logprobs=[],
                item_id=state.current_item_id,
            )
        )
        events.append(
            ResponseContentPartDoneEvent(
                type="response.content_part.done",
                sequence_number=-1,
                item_id=state.current_item_id,
                output_index=state.current_output_index,
                content_index=state.current_content_index,
                part=text_content,
            )
        )
        events.append(
            ResponseOutputItemDoneEvent(
                type="response.output_item.done",
                sequence_number=-1,
                output_index=state.current_output_index,
                item=ResponseOutputMessage(
                    id=state.current_item_id,
                    type="message",
                    role="assistant",
                    content=[text_content],
                    status="completed",
                ),
            )
        )
        return events

    def _emit_previous_item_done_events(
        self,
        previous_item,
        state: HarmonyStreamingState,
    ) -> list[StreamingResponsesResponse]:
        """Emit done events for the previous item when expecting a new start."""
        if previous_item.recipient is not None:
            # Deal with tool call
            if previous_item.recipient.startswith("functions."):
                return self._emit_function_call_done_events(previous_item, state)
            elif (
                self._is_mcp_tool_by_namespace(previous_item.recipient)
                and state.current_item_id is not None
                and state.current_item_id.startswith("mcp_")
            ):
                return self._emit_mcp_call_done_events(previous_item, state)
        elif previous_item.channel == "analysis":
            return self._emit_reasoning_done_events(previous_item, state)
        elif previous_item.channel == "final":
            return self._emit_text_output_done_events(previous_item, state)
        return []

    def _emit_final_channel_delta_events(
        self,
        ctx: StreamingHarmonyContext,
        state: HarmonyStreamingState,
    ) -> list[StreamingResponsesResponse]:
        """Emit events for final channel text delta streaming."""
        events = []
        if not state.sent_output_item_added:
            state.sent_output_item_added = True
            state.current_item_id = f"msg_{random_uuid()}"
            events.append(
                ResponseOutputItemAddedEvent(
                    type="response.output_item.added",
                    sequence_number=-1,
                    output_index=state.current_output_index,
                    item=ResponseOutputMessage(
                        id=state.current_item_id,
                        type="message",
                        role="assistant",
                        content=[],
                        status="in_progress",
                    ),
                )
            )
            state.current_content_index += 1
            events.append(
                ResponseContentPartAddedEvent(
                    type="response.content_part.added",
                    sequence_number=-1,
                    output_index=state.current_output_index,
                    item_id=state.current_item_id,
                    content_index=state.current_content_index,
                    part=ResponseOutputText(
                        type="output_text",
                        text="",
                        annotations=[],
                        logprobs=[],
                    ),
                )
            )
        events.append(
            ResponseTextDeltaEvent(
                type="response.output_text.delta",
                sequence_number=-1,
                content_index=state.current_content_index,
                output_index=state.current_output_index,
                item_id=state.current_item_id,
1858
                delta=ctx.last_content_delta,
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
                # TODO, use logprobs from ctx.last_request_output
                logprobs=[],
            )
        )
        return events

    def _emit_analysis_channel_delta_events(
        self,
        ctx: StreamingHarmonyContext,
        state: HarmonyStreamingState,
    ) -> list[StreamingResponsesResponse]:
        """Emit events for analysis channel reasoning delta streaming."""
        events = []
        if not state.sent_output_item_added:
            state.sent_output_item_added = True
            state.current_item_id = f"msg_{random_uuid()}"
            events.append(
                ResponseOutputItemAddedEvent(
                    type="response.output_item.added",
                    sequence_number=-1,
                    output_index=state.current_output_index,
                    item=ResponseReasoningItem(
                        type="reasoning",
                        id=state.current_item_id,
                        summary=[],
                        status="in_progress",
                    ),
                )
            )
            state.current_content_index += 1
            events.append(
                ResponseReasoningPartAddedEvent(
                    type="response.reasoning_part.added",
                    sequence_number=-1,
                    output_index=state.current_output_index,
                    item_id=state.current_item_id,
                    content_index=state.current_content_index,
                    part=ResponseReasoningTextContent(
                        text="",
                        type="reasoning_text",
                    ),
                )
            )
        events.append(
            ResponseReasoningTextDeltaEvent(
                type="response.reasoning_text.delta",
                item_id=state.current_item_id,
                output_index=state.current_output_index,
                content_index=state.current_content_index,
1908
                delta=ctx.last_content_delta,
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
                sequence_number=-1,
            )
        )
        return events

    def _emit_mcp_tool_delta_events(
        self,
        ctx: StreamingHarmonyContext,
        state: HarmonyStreamingState,
        recipient: str,
    ) -> list[StreamingResponsesResponse]:
        """Emit events for MCP tool delta streaming."""
        server_label = self._TOOL_NAME_TO_MCP_SERVER_LABEL.get(recipient, recipient)
        events = []
        if not state.sent_output_item_added:
            state.sent_output_item_added = True
            state.current_item_id = f"mcp_{random_uuid()}"
            events.append(
                ResponseOutputItemAddedEvent(
                    type="response.output_item.added",
                    sequence_number=-1,
                    output_index=state.current_output_index,
                    item=McpCall(
                        type="mcp_call",
                        id=state.current_item_id,
                        name=recipient,
                        arguments="",
                        server_label=server_label,
                        status="in_progress",
                    ),
                )
            )
            events.append(
                ResponseMcpCallInProgressEvent(
                    type="response.mcp_call.in_progress",
                    sequence_number=-1,
                    output_index=state.current_output_index,
                    item_id=state.current_item_id,
                )
            )
        events.append(
            ResponseMcpCallArgumentsDeltaEvent(
                type="response.mcp_call_arguments.delta",
                sequence_number=-1,
                output_index=state.current_output_index,
                item_id=state.current_item_id,
1955
                delta=ctx.last_content_delta,
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
            )
        )
        return events

    def _emit_code_interpreter_delta_events(
        self,
        ctx: StreamingHarmonyContext,
        state: HarmonyStreamingState,
    ) -> list[StreamingResponsesResponse]:
        """Emit events for code interpreter delta streaming."""
        events = []
        if not state.sent_output_item_added:
            state.sent_output_item_added = True
            state.current_item_id = f"tool_{random_uuid()}"
            events.append(
                ResponseOutputItemAddedEvent(
                    type="response.output_item.added",
                    sequence_number=-1,
                    output_index=state.current_output_index,
                    item=ResponseCodeInterpreterToolCallParam(
                        type="code_interpreter_call",
                        id=state.current_item_id,
                        code=None,
                        container_id="auto",
                        outputs=None,
                        status="in_progress",
                    ),
                )
            )
            events.append(
                ResponseCodeInterpreterCallInProgressEvent(
                    type="response.code_interpreter_call.in_progress",
                    sequence_number=-1,
                    output_index=state.current_output_index,
                    item_id=state.current_item_id,
                )
            )
        events.append(
            ResponseCodeInterpreterCallCodeDeltaEvent(
                type="response.code_interpreter_call_code.delta",
                sequence_number=-1,
                output_index=state.current_output_index,
                item_id=state.current_item_id,
1999
                delta=ctx.last_content_delta,
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
            )
        )
        return events

    def _emit_mcp_prefix_delta_events(
        self,
        ctx: StreamingHarmonyContext,
        state: HarmonyStreamingState,
    ) -> list[StreamingResponsesResponse]:
        """Emit events for MCP prefix (mcp.*) delta streaming."""
        events = []
        if not state.sent_output_item_added:
            state.sent_output_item_added = True
            state.current_item_id = f"mcp_{random_uuid()}"
            mcp_name = ctx.parser.current_recipient[len("mcp.") :]

            events.append(
                ResponseOutputItemAddedEvent(
                    type="response.output_item.added",
                    sequence_number=-1,
                    output_index=state.current_output_index,
                    item=McpCall(
                        type="mcp_call",
                        id=state.current_item_id,
                        name=mcp_name,
                        arguments="",
                        server_label=mcp_name,
                        status="in_progress",
                    ),
                )
            )
            events.append(
                ResponseMcpCallInProgressEvent(
                    type="response.mcp_call.in_progress",
                    sequence_number=-1,
                    output_index=state.current_output_index,
                    item_id=state.current_item_id,
                )
            )

        events.append(
            ResponseMcpCallArgumentsDeltaEvent(
                type="response.mcp_call_arguments.delta",
                sequence_number=-1,
                output_index=state.current_output_index,
                item_id=state.current_item_id,
2046
                delta=ctx.last_content_delta,
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
            )
        )
        return events

    def _emit_content_delta_events(
        self,
        ctx: StreamingHarmonyContext,
        state: HarmonyStreamingState,
    ) -> list[StreamingResponsesResponse]:
        """Emit events for content delta streaming based on channel type."""
2057
        if not ctx.last_content_delta:
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
            return []

        if (
            ctx.parser.current_channel == "final"
            and ctx.parser.current_recipient is None
        ):
            return self._emit_final_channel_delta_events(ctx, state)
        elif (
            ctx.parser.current_channel == "analysis"
            and ctx.parser.current_recipient is None
        ):
            return self._emit_analysis_channel_delta_events(ctx, state)
        # built-in tools will be triggered on the analysis channel
        # However, occasionally built-in tools will
        # still be output to commentary.
        elif (
            ctx.parser.current_channel == "commentary"
            or ctx.parser.current_channel == "analysis"
        ) and ctx.parser.current_recipient is not None:
            recipient = ctx.parser.current_recipient
            # Check for function calls first - they have their own event handling
            if recipient.startswith("functions."):
                return self._emit_function_call_delta_events(ctx, state)
            is_mcp_tool = self._is_mcp_tool_by_namespace(recipient)
            if is_mcp_tool:
                return self._emit_mcp_tool_delta_events(ctx, state, recipient)
            else:
                return self._emit_code_interpreter_delta_events(ctx, state)
        elif (
            (
                ctx.parser.current_channel == "commentary"
                or ctx.parser.current_channel == "analysis"
            )
            and ctx.parser.current_recipient is not None
            and ctx.parser.current_recipient.startswith("mcp.")
        ):
            return self._emit_mcp_prefix_delta_events(ctx, state)

        return []

    def _emit_browser_tool_events(
        self,
        previous_item,
        state: HarmonyStreamingState,
    ) -> list[StreamingResponsesResponse]:
        """Emit events for browser tool calls (web search)."""
        function_name = previous_item.recipient[len("browser.") :]
        parsed_args = json.loads(previous_item.content[0].text)
        action = None

        if function_name == "search":
            action = response_function_web_search.ActionSearch(
                type="search",
                query=parsed_args["query"],
            )
        elif function_name == "open":
            action = response_function_web_search.ActionOpenPage(
                type="open_page",
                # TODO: translate to url
                url=f"cursor:{parsed_args.get('cursor', '')}",
            )
        elif function_name == "find":
            action = response_function_web_search.ActionFind(
                type="find",
                pattern=parsed_args["pattern"],
                # TODO: translate to url
                url=f"cursor:{parsed_args.get('cursor', '')}",
            )
        else:
            raise ValueError(f"Unknown function name: {function_name}")

        state.current_item_id = f"tool_{random_uuid()}"
        events = []
        events.append(
            ResponseOutputItemAddedEvent(
                type="response.output_item.added",
                sequence_number=-1,
                output_index=state.current_output_index,
                item=response_function_web_search.ResponseFunctionWebSearch(
                    # TODO: generate a unique id for web search call
                    type="web_search_call",
                    id=state.current_item_id,
                    action=action,
                    status="in_progress",
                ),
            )
        )
        events.append(
            ResponseWebSearchCallInProgressEvent(
                type="response.web_search_call.in_progress",
                sequence_number=-1,
                output_index=state.current_output_index,
                item_id=state.current_item_id,
            )
        )
        events.append(
            ResponseWebSearchCallSearchingEvent(
                type="response.web_search_call.searching",
                sequence_number=-1,
                output_index=state.current_output_index,
                item_id=state.current_item_id,
            )
        )
        # enqueue
        events.append(
            ResponseWebSearchCallCompletedEvent(
                type="response.web_search_call.completed",
                sequence_number=-1,
                output_index=state.current_output_index,
                item_id=state.current_item_id,
            )
        )
        events.append(
            ResponseOutputItemDoneEvent(
                type="response.output_item.done",
                sequence_number=-1,
                output_index=state.current_output_index,
                item=ResponseFunctionWebSearch(
                    type="web_search_call",
                    id=state.current_item_id,
                    action=action,
                    status="completed",
                ),
            )
        )
        return events

    def _emit_mcp_tool_completion_events(
        self,
        previous_item,
        state: HarmonyStreamingState,
    ) -> list[StreamingResponsesResponse]:
        """Emit events when an MCP tool completes during assistant action turn."""
        recipient = previous_item.recipient
        server_label = self._TOOL_NAME_TO_MCP_SERVER_LABEL.get(recipient, recipient)
        events = []
        events.append(
            ResponseMcpCallArgumentsDoneEvent(
                type="response.mcp_call_arguments.done",
                sequence_number=-1,
                output_index=state.current_output_index,
                item_id=state.current_item_id,
                arguments=previous_item.content[0].text,
                name=recipient,
            )
        )
        events.append(
            ResponseMcpCallCompletedEvent(
                type="response.mcp_call.completed",
                sequence_number=-1,
                output_index=state.current_output_index,
                item_id=state.current_item_id,
            )
        )
        events.append(
            ResponseOutputItemDoneEvent(
                type="response.output_item.done",
                sequence_number=-1,
                output_index=state.current_output_index,
                item=McpCall(
                    type="mcp_call",
                    id=state.current_item_id,
                    name=recipient,
                    arguments=previous_item.content[0].text,
                    server_label=server_label,
                    status="completed",
                ),
            )
        )
        return events

    def _emit_code_interpreter_completion_events(
        self,
        previous_item,
        state: HarmonyStreamingState,
    ) -> list[StreamingResponsesResponse]:
        """Emit events when code interpreter completes."""
        events = []
        events.append(
            ResponseCodeInterpreterCallCodeDoneEvent(
                type="response.code_interpreter_call_code.done",
                sequence_number=-1,
                output_index=state.current_output_index,
                item_id=state.current_item_id,
                code=previous_item.content[0].text,
            )
        )
        events.append(
            ResponseCodeInterpreterCallInterpretingEvent(
                type="response.code_interpreter_call.interpreting",
                sequence_number=-1,
                output_index=state.current_output_index,
                item_id=state.current_item_id,
            )
        )
        events.append(
            ResponseCodeInterpreterCallCompletedEvent(
                type="response.code_interpreter_call.completed",
                sequence_number=-1,
                output_index=state.current_output_index,
                item_id=state.current_item_id,
            )
        )
        events.append(
            ResponseOutputItemDoneEvent(
                type="response.output_item.done",
                sequence_number=-1,
                output_index=state.current_output_index,
                item=ResponseCodeInterpreterToolCallParam(
                    type="code_interpreter_call",
                    id=state.current_item_id,
                    code=previous_item.content[0].text,
                    container_id="auto",
                    outputs=[],
                    status="completed",
                ),
            )
        )
        return events

    def _emit_mcp_prefix_completion_events(
        self,
        previous_item,
        state: HarmonyStreamingState,
    ) -> list[StreamingResponsesResponse]:
        """Emit events when an MCP prefix tool (mcp.*) completes."""
        mcp_name = previous_item.recipient[len("mcp.") :]
        events = []
        events.append(
            ResponseMcpCallArgumentsDoneEvent(
                type="response.mcp_call_arguments.done",
                sequence_number=-1,
                output_index=state.current_output_index,
                item_id=state.current_item_id,
                arguments=previous_item.content[0].text,
                name=mcp_name,
            )
        )
        events.append(
            ResponseMcpCallCompletedEvent(
                type="response.mcp_call.completed",
                sequence_number=-1,
                output_index=state.current_output_index,
                item_id=state.current_item_id,
            )
        )
        events.append(
            ResponseOutputItemDoneEvent(
                type="response.output_item.done",
                sequence_number=-1,
                output_index=state.current_output_index,
                item=McpCall(
                    type="mcp_call",
                    id=state.current_item_id,
                    name=mcp_name,
                    arguments=previous_item.content[0].text,
                    server_label=mcp_name,
                    status="completed",
                ),
            )
        )
        return events

    def _emit_tool_action_events(
        self,
        ctx: StreamingHarmonyContext,
        state: HarmonyStreamingState,
    ) -> list[StreamingResponsesResponse]:
        """Emit events for tool action turn."""
        if not ctx.is_assistant_action_turn() or len(ctx.parser.messages) == 0:
            return []

        events = []
        previous_item = ctx.parser.messages[-1]

        # Handle browser tool
        if (
            self.tool_server is not None
            and self.tool_server.has_tool("browser")
            and previous_item.recipient is not None
            and previous_item.recipient.startswith("browser.")
        ):
            events.extend(self._emit_browser_tool_events(previous_item, state))

        # Handle tool completion
        if (
            self.tool_server is not None
            and previous_item.recipient is not None
            and state.current_item_id is not None
            and state.sent_output_item_added
        ):
            recipient = previous_item.recipient
            # Handle MCP prefix tool completion first
            if recipient.startswith("mcp."):
                events.extend(
                    self._emit_mcp_prefix_completion_events(previous_item, state)
                )
            else:
                # Handle other MCP tool and code interpreter completion
                is_mcp_tool = self._is_mcp_tool_by_namespace(
                    recipient
                ) and state.current_item_id.startswith("mcp_")
                if is_mcp_tool:
                    events.extend(
                        self._emit_mcp_tool_completion_events(previous_item, state)
                    )
                else:
                    events.extend(
                        self._emit_code_interpreter_completion_events(
                            previous_item, state
                        )
                    )

        return events

    def _emit_function_call_delta_events(
        self,
        ctx: StreamingHarmonyContext,
        state: HarmonyStreamingState,
    ) -> list[StreamingResponsesResponse]:
        """Emit events for developer function calls on commentary channel."""
        if not (
            ctx.parser.current_channel == "commentary"
            and ctx.parser.current_recipient
            and ctx.parser.current_recipient.startswith("functions.")
        ):
            return []

        events = []
        if state.is_first_function_call_delta is False:
            state.is_first_function_call_delta = True
            fc_name = ctx.parser.current_recipient[len("functions.") :]
            state.current_item_id = f"fc_{random_uuid()}"
            tool_call_item = ResponseFunctionToolCall(
                name=fc_name,
                type="function_call",
                id=state.current_item_id,
                call_id=f"call_{random_uuid()}",
                arguments="",
                status="in_progress",
            )
            events.append(
                ResponseOutputItemAddedEvent(
                    type="response.output_item.added",
                    sequence_number=-1,
                    output_index=state.current_output_index,
                    item=tool_call_item,
                )
            )
        # Always emit the delta (including on first call)
        events.append(
            ResponseFunctionCallArgumentsDeltaEvent(
                item_id=state.current_item_id,
2411
                delta=ctx.last_content_delta,
2412
2413
2414
2415
2416
2417
2418
                output_index=state.current_output_index,
                sequence_number=-1,
                type="response.function_call_arguments.delta",
            )
        )
        return events

2419
2420
2421
2422
    async def _process_harmony_streaming_events(
        self,
        request: ResponsesRequest,
        sampling_params: SamplingParams,
2423
        result_generator: AsyncIterator[ConversationContext | None],
2424
2425
        context: ConversationContext,
        model_name: str,
2426
        tokenizer: TokenizerLike,
2427
2428
        request_metadata: RequestResponseMetadata,
        created_time: int,
2429
        _increment_sequence_number_and_return: Callable[
2430
2431
            [StreamingResponsesResponse], StreamingResponsesResponse
        ],
2432
    ) -> AsyncGenerator[StreamingResponsesResponse, None]:
2433
2434
        state = HarmonyStreamingState()

2435
2436
2437
        async for ctx in result_generator:
            assert isinstance(ctx, StreamingHarmonyContext)

2438
2439
2440
            # finish_reason='error' indicates a retryable error
            self._raise_if_error(ctx.finish_reason, request.request_id)

2441
2442
2443
            if ctx.is_expecting_start():
                if len(ctx.parser.messages) > 0:
                    previous_item = ctx.parser.messages[-1]
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
                    for event in self._emit_previous_item_done_events(
                        previous_item, state
                    ):
                        yield _increment_sequence_number_and_return(event)
                state.reset_for_new_item()

            # Stream the output of a harmony message
            for event in self._emit_content_delta_events(ctx, state):
                yield _increment_sequence_number_and_return(event)

            # Stream tool call outputs
            for event in self._emit_tool_action_events(ctx, state):
                yield _increment_sequence_number_and_return(event)
2457

2458
2459
2460
2461
    async def responses_stream_generator(
        self,
        request: ResponsesRequest,
        sampling_params: SamplingParams,
2462
        result_generator: AsyncIterator[ConversationContext | None],
2463
2464
        context: ConversationContext,
        model_name: str,
2465
        tokenizer: TokenizerLike,
2466
        request_metadata: RequestResponseMetadata,
2467
        created_time: int | None = None,
2468
    ) -> AsyncGenerator[StreamingResponsesResponse, None]:
2469
2470
2471
2472
2473
        # TODO:
        # 1. Handle disconnect

        created_time = created_time or int(time.time())

2474
2475
        sequence_number = 0

2476
        def _increment_sequence_number_and_return(
2477
            event: StreamingResponsesResponse,
2478
        ) -> StreamingResponsesResponse:
2479
2480
            nonlocal sequence_number
            # Set sequence_number if the event has this attribute
2481
            if hasattr(event, "sequence_number"):
2482
2483
                event.sequence_number = sequence_number
            sequence_number += 1
2484
            return event
2485

2486
        async with AsyncExitStack() as exit_stack:
2487
            if self.use_harmony:
2488
2489
                # TODO: in streaming, we noticed this bug:
                # https://github.com/vllm-project/vllm/issues/25697
2490
                await self._initialize_tool_sessions(request, context, exit_stack)
2491
2492
2493
                processer = self._process_harmony_streaming_events
            else:
                processer = self._process_simple_streaming_events
2494
            # TODO Hanchen make sampling params to include the structural tag
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504

            initial_response = ResponsesResponse.from_request(
                request,
                sampling_params,
                model_name=model_name,
                created_time=created_time,
                output=[],
                status="in_progress",
                usage=None,
            ).model_dump()
2505
            yield _increment_sequence_number_and_return(
2506
2507
2508
2509
                ResponseCreatedEvent(
                    type="response.created",
                    sequence_number=-1,
                    response=initial_response,
2510
2511
                )
            )
2512
            yield _increment_sequence_number_and_return(
2513
2514
2515
2516
                ResponseInProgressEvent(
                    type="response.in_progress",
                    sequence_number=-1,
                    response=initial_response,
2517
2518
                )
            )
2519

2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
            try:
                async for event_data in processer(
                    request,
                    sampling_params,
                    result_generator,
                    context,
                    model_name,
                    tokenizer,
                    request_metadata,
                    created_time,
                    _increment_sequence_number_and_return,
                ):
                    yield event_data
            except GenerationError as e:
                error_json = self._convert_generation_error_to_streaming_response(e)
                yield _increment_sequence_number_and_return(
                    TypeAdapter(StreamingResponsesResponse).validate_json(error_json)
                )
                return
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555

            async def empty_async_generator():
                # A hack to trick Python to think this is a generator but
                # in fact it immediately returns.
                if False:
                    yield

            final_response = await self.responses_full_generator(
                request,
                sampling_params,
                empty_async_generator(),
                context,
                model_name,
                tokenizer,
                request_metadata,
                created_time=created_time,
            )
2556
            yield _increment_sequence_number_and_return(
2557
                ResponseCompletedEvent(
2558
2559
                    type="response.completed",
                    sequence_number=-1,
2560
                    response=final_response,
2561
2562
                )
            )