"examples/backends/vllm/launch/agg_omni_video.sh" did not exist on "f242b4552b8ae37d0a3c2a4f0438e57d6f4240f3"
serving_responses.py 78 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, Sequence
10
from contextlib import AsyncExitStack
11
from copy import copy
12
from http import HTTPStatus
13
from typing import Callable, Final, Optional, Union
14
15
16

import jinja2
from fastapi import Request
17
18
19
20
21
22
from openai.types.responses import (
    ResponseCodeInterpreterCallCodeDeltaEvent,
    ResponseCodeInterpreterCallCodeDoneEvent,
    ResponseCodeInterpreterCallCompletedEvent,
    ResponseCodeInterpreterCallInProgressEvent,
    ResponseCodeInterpreterCallInterpretingEvent,
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
    ResponseCodeInterpreterToolCallParam,
    ResponseContentPartAddedEvent,
    ResponseContentPartDoneEvent,
    ResponseFunctionToolCall,
    ResponseFunctionWebSearch,
    ResponseOutputItem,
    ResponseOutputItemAddedEvent,
    ResponseOutputItemDoneEvent,
    ResponseOutputMessage,
    ResponseOutputText,
    ResponseReasoningItem,
    ResponseReasoningTextDeltaEvent,
    ResponseReasoningTextDoneEvent,
    ResponseStatus,
    ResponseTextDeltaEvent,
    ResponseTextDoneEvent,
    ResponseWebSearchCallCompletedEvent,
    ResponseWebSearchCallInProgressEvent,
    ResponseWebSearchCallSearchingEvent,
    response_function_web_search,
    response_text_delta_event,
)
from openai.types.responses.response_output_text import Logprob, LogprobTopLogprob
46
from openai.types.responses.response_reasoning_item import (
47
48
    Content as ResponseReasoningTextContent,
)
49
from openai_harmony import Message as OpenAIHarmonyMessage
50

51
from vllm import envs
52
from vllm.engine.protocol import EngineClient
53
54
55
56
57
58
59
60
61
62
from vllm.entrypoints.chat_utils import (
    ChatCompletionMessageParam,
    ChatTemplateContentFormatOption,
)
from vllm.entrypoints.context import (
    ConversationContext,
    HarmonyContext,
    SimpleContext,
    StreamingHarmonyContext,
)
63
from vllm.entrypoints.harmony_utils import (
64
65
66
67
68
69
70
71
72
73
    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,
)
74
from vllm.entrypoints.logger import RequestLogger
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
from vllm.entrypoints.openai.protocol import (
    DeltaMessage,
    ErrorResponse,
    InputTokensDetails,
    OutputTokensDetails,
    RequestResponseMetadata,
    ResponseCompletedEvent,
    ResponseCreatedEvent,
    ResponseInProgressEvent,
    ResponseReasoningPartAddedEvent,
    ResponseReasoningPartDoneEvent,
    ResponsesRequest,
    ResponsesResponse,
    ResponseUsage,
    StreamingResponsesResponse,
)
91
92
from vllm.entrypoints.openai.serving_engine import OpenAIServing
from vllm.entrypoints.openai.serving_models import OpenAIServingModels
93
from vllm.entrypoints.tool_server import ToolServer
94
from vllm.inputs.data import TokensPrompt as EngineTokensPrompt
95
from vllm.logger import init_logger
96
97
from vllm.logprobs import Logprob as SampleLogprob
from vllm.logprobs import SampleLogprobs
98
from vllm.outputs import CompletionOutput
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
from vllm.reasoning import ReasoningParser, ReasoningParserManager
from vllm.sampling_params import SamplingParams
from vllm.transformers_utils.tokenizer import AnyTokenizer
from vllm.utils import random_uuid

logger = init_logger(__name__)


class OpenAIServingResponses(OpenAIServing):
    def __init__(
        self,
        engine_client: EngineClient,
        models: OpenAIServingModels,
        *,
        request_logger: Optional[RequestLogger],
        chat_template: Optional[str],
        chat_template_content_format: ChatTemplateContentFormatOption,
        return_tokens_as_token_ids: bool = False,
        reasoning_parser: str = "",
        enable_auto_tools: bool = False,
        tool_parser: Optional[str] = None,
120
        tool_server: Optional[ToolServer] = None,
121
122
        enable_prompt_tokens_details: bool = False,
        enable_force_include_usage: bool = False,
123
        enable_log_outputs: bool = False,
124
        log_error_stack: bool = False,
125
126
127
128
129
130
131
    ) -> None:
        super().__init__(
            engine_client=engine_client,
            models=models,
            request_logger=request_logger,
            return_tokens_as_token_ids=return_tokens_as_token_ids,
            enable_force_include_usage=enable_force_include_usage,
132
            log_error_stack=log_error_stack,
133
134
135
136
        )

        self.chat_template = chat_template
        self.chat_template_content_format: Final = chat_template_content_format
137
        self.enable_log_outputs = enable_log_outputs
138

139
140
141
        self.reasoning_parser: Optional[Callable[[AnyTokenizer], ReasoningParser]] = (
            None
        )
142
143
        if reasoning_parser:
            try:
144
145
146
                self.reasoning_parser = ReasoningParserManager.get_reasoning_parser(
                    reasoning_parser
                )
147
148
                assert self.reasoning_parser is not None
            except Exception as e:
149
                raise TypeError(f"{reasoning_parser=} has not been registered") from e
150
151
152

        self.enable_prompt_tokens_details = enable_prompt_tokens_details
        self.enable_force_include_usage = enable_force_include_usage
153
        self.default_sampling_params = self.model_config.get_diff_sampling_param()
154
155
156
        if self.default_sampling_params:
            source = self.model_config.generation_config
            source = "model" if source == "auto" else source
157
158
159
160
161
            logger.info(
                "Using default chat sampling params from %s: %s",
                source,
                self.default_sampling_params,
            )
162

163
164
165
166
167
        # 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.
168
        self.enable_store = envs.VLLM_ENABLE_RESPONSES_API_STORE
169
170
171
172
        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 "
173
174
                "the store."
            )
175

176
        self.use_harmony = self.model_config.hf_config.model_type == "gpt_oss"
177
        if self.use_harmony:
178
179
180
181
            logger.warning(
                "For gpt-oss, we ignore --enable-auto-tool-choice "
                "and always enable tool use."
            )
182
183
184
185
186
            # 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(
187
188
                get_stop_tokens_for_assistant_actions()
            )
189
190
191
192
193

        # set up tool use
        self.enable_auto_tools: bool = enable_auto_tools
        if self.enable_auto_tools:
            logger.info(
194
                '"auto" tool choice has been enabled please note that while'
195
                " the parallel_tool_calls client option is preset for "
196
197
                "compatibility reasons, it will be ignored."
            )
198

199
        # HACK(woosuk): This is a hack. We should use a better store.
200
201
        # FIXME: If enable_store=True, this may cause a memory leak since we
        # never remove responses from the store.
202
203
204
205
        self.response_store: dict[str, ResponsesResponse] = {}
        self.response_store_lock = asyncio.Lock()

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

210
211
212
        # 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.
213
214
215
        self.event_store: dict[
            str, tuple[deque[StreamingResponsesResponse], asyncio.Event]
        ] = {}
216

217
218
        self.background_tasks: dict[str, asyncio.Task] = {}

219
220
        self.tool_server = tool_server

221
    def _validate_generator_input(
222
223
        self, engine_prompt: EngineTokensPrompt
    ) -> Optional[ErrorResponse]:
224
225
226
227
228
229
        """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}. "
230
231
                "Please reduce prompt."
            )
232
233
234
235
236
237
238
            return self.create_error_response(
                err_type="invalid_request_error",
                message=error_message,
                status_code=HTTPStatus.BAD_REQUEST,
            )
        return None

239
240
241
242
    async def create_responses(
        self,
        request: ResponsesRequest,
        raw_request: Optional[Request] = None,
243
244
245
246
247
    ) -> Union[
        AsyncGenerator[StreamingResponsesResponse, None],
        ResponsesResponse,
        ErrorResponse,
    ]:
248
249
250
251
252
253
254
255
256
257
258
        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

        # 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

259
        if request.store and not self.enable_store:
260
261
262
263
264
265
266
267
            if 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 "
268
269
                        "the vLLM server."
                    ),
270
271
272
273
274
275
276
277
278
                    status_code=HTTPStatus.BAD_REQUEST,
                )
            # 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
279
280
281
282
283
284
        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,
            )
285

286
287
288
289
290
291
292
293
294
295
296
        # 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:
297
            lora_request = self._maybe_get_adapters(request)
298
            model_name = self.models.model_name(lora_request)
299
            tokenizer = await self.engine_client.get_tokenizer()
300

301
302
            if self.use_harmony:
                messages, request_prompts, engine_prompts = (
303
304
                    self._make_request_with_harmony(request, prev_response)
                )
305
            else:
306
307
308
                messages, request_prompts, engine_prompts = await self._make_request(
                    request, prev_response, tokenizer
                )
309

310
311
312
313
314
315
316
        except (
            ValueError,
            TypeError,
            RuntimeError,
            jinja2.TemplateError,
            NotImplementedError,
        ) as e:
317
318
319
            logger.exception("Error in preprocessing prompt inputs")
            return self.create_error_response(f"{e} {e.__cause__}")

320
        request_metadata = RequestResponseMetadata(request_id=request.request_id)
321
322
323
324
        if raw_request:
            raw_request.state.request_metadata = request_metadata

        # Schedule the request and get the result generator.
325
        generators: list[AsyncGenerator[ConversationContext, None]] = []
326
327
328
329
330
331
332

        builtin_tool_list: list[str] = []
        if self.use_harmony and self.tool_server is not None:
            if self.tool_server.has_tool("browser"):
                builtin_tool_list.append("browser")
            if self.tool_server.has_tool("python"):
                builtin_tool_list.append("python")
333
334
            if self.tool_server.has_tool("container"):
                builtin_tool_list.append("container")
335

336
337
338
339
340
341
342
        if self.tool_server is not None:
            available_tools = builtin_tool_list
        else:
            assert len(builtin_tool_list) == 0
            available_tools = []
        try:
            for i, engine_prompt in enumerate(engine_prompts):
343
344
345
346
                maybe_error = self._validate_generator_input(engine_prompt)
                if maybe_error is not None:
                    return maybe_error

347
                default_max_tokens = self.max_model_len - len(
348
349
                    engine_prompt["prompt_token_ids"]
                )
350

351
                sampling_params = request.to_sampling_params(
352
353
                    default_max_tokens, self.default_sampling_params
                )
354

355
356
357
358
359
                trace_headers = (
                    None
                    if raw_request is None
                    else await self._get_trace_headers(raw_request.headers)
                )
360
361
362
363

                context: ConversationContext
                if self.use_harmony:
                    if request.stream:
364
                        context = StreamingHarmonyContext(messages, available_tools)
365
366
367
368
369
370
371
372
373
374
375
376
377
                    else:
                        context = HarmonyContext(messages, available_tools)
                else:
                    context = SimpleContext()
                generator = self._generate_with_builtin_tools(
                    request_id=request.request_id,
                    request_prompt=request_prompts[i],
                    engine_prompt=engine_prompt,
                    sampling_params=sampling_params,
                    context=context,
                    lora_request=lora_request,
                    priority=request.priority,
                    trace_headers=trace_headers,
378
                )
379
380
381
382
                generators.append(generator)
        except ValueError as e:
            # TODO: Use a vllm-specific Validation Error
            return self.create_error_response(str(e))
383

384
        assert len(generators) == 1
385
        (result_generator,) = generators
386
387
388
389

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

391
392
393
394
395
396
397
398
399
400
401
402
403
        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
404

405
            # Run the request in the background.
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
            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}",
                )
434

435
436
437
438
            # For cleanup.
            response_id = response.id
            self.background_tasks[response_id] = task
            task.add_done_callback(
439
440
                lambda _: self.background_tasks.pop(response_id, None)
            )
441
442

            if request.stream:
443
                return self.responses_background_stream_generator(request.request_id)
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
            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,
            )
        except Exception as e:
            return self.create_error_response(str(e))
469

470
471
472
473
474
475
    async def _make_request(
        self,
        request: ResponsesRequest,
        prev_response: Optional[ResponsesResponse],
        tokenizer: AnyTokenizer,
    ):
476
477
        if len(request.tools) > 0:
            raise NotImplementedError(
478
479
                "Tool use is not supported in Responses API without Harmony"
            )
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
        # Construct the input messages.
        messages = self._construct_input_messages(request, prev_response)
        _, request_prompts, engine_prompts = await self._preprocess_chat(
            request,
            tokenizer,
            messages,
            chat_template=self.chat_template,
            chat_template_content_format=self.chat_template_content_format,
        )
        return messages, request_prompts, engine_prompts

    def _make_request_with_harmony(
        self,
        request: ResponsesRequest,
        prev_response: Optional[ResponsesResponse],
    ):
        if request.tool_choice != "auto":
            raise NotImplementedError(
498
499
500
                "Only 'auto' tool_choice is supported in response API with Harmony"
            )
        messages = self._construct_input_messages_with_harmony(request, prev_response)
501
502
        prompt_token_ids = render_for_completion(messages)
        engine_prompt = EngineTokensPrompt(prompt_token_ids=prompt_token_ids)
503
504
505
506
507

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

508
509
        return messages, [prompt_token_ids], [engine_prompt]

510
511
512
513
514
515
    async def _initialize_tool_sessions(
        self,
        request: ResponsesRequest,
        context: ConversationContext,
        exit_stack: AsyncExitStack,
    ):
516
517
518
519
        # we should only initialize the tool session if the request needs tools
        if len(request.tools) == 0:
            return
        mcp_tools = {
520
            tool.server_label: tool for tool in request.tools if tool.type == "mcp"
521
        }
522
523
524
        await context.init_tool_sessions(
            self.tool_server, exit_stack, request.request_id, mcp_tools
        )
525

526
527
528
529
    async def responses_full_generator(
        self,
        request: ResponsesRequest,
        sampling_params: SamplingParams,
530
        result_generator: AsyncIterator[ConversationContext],
531
        context: ConversationContext,
532
533
534
535
536
537
538
539
        model_name: str,
        tokenizer: AnyTokenizer,
        request_metadata: RequestResponseMetadata,
        created_time: Optional[int] = None,
    ) -> Union[ErrorResponse, ResponsesResponse]:
        if created_time is None:
            created_time = int(time.time())

540
541
        async with AsyncExitStack() as exit_stack:
            try:
542
                await self._initialize_tool_sessions(request, context, exit_stack)
543
544
545
546
547
548
549
                async for _ in result_generator:
                    pass
            except asyncio.CancelledError:
                return self.create_error_response("Client disconnected")
            except ValueError as e:
                # TODO: Use a vllm-specific Validation Error
                return self.create_error_response(str(e))
550

551
552
553
554
555
        # 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"

556
557
        input_messages = None
        output_messages = None
558
559
560
        if self.use_harmony:
            assert isinstance(context, HarmonyContext)
            output = self._make_response_output_items_with_harmony(context)
561
            if request.enable_response_messages:
562
563
                input_messages = context.messages[: context.num_init_messages]
                output_messages = context.messages[context.num_init_messages :]
564
            num_tool_output_tokens = context.num_tool_output_tokens
565
566
567
568
569
570
571
            if len(output) > 0:
                if context.finish_reason == "length":
                    status = "incomplete"
                elif context.finish_reason == "abort":
                    status = "cancelled"
            else:
                status = "incomplete"
572
        else:
573
574
575
576
577
578
            assert isinstance(context, SimpleContext)
            final_res = context.last_output
            assert final_res is not None
            assert len(final_res.outputs) == 1
            final_output = final_res.outputs[0]

579
            output = self._make_response_output_items(request, final_output, tokenizer)
580

581
582
583
584
            # TODO: context for non-gptoss models doesn't use messages
            # so we can't get them out yet
            if request.enable_response_messages:
                raise NotImplementedError(
585
586
                    "enable_response_messages is currently only supported for gpt-oss"
                )
587
588
            # Calculate usage.
            assert final_res.prompt_token_ids is not None
589
590
            num_tool_output_tokens = 0

591
592
593
594
595
        assert isinstance(context, (SimpleContext, HarmonyContext))
        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
596
597
598
599

        usage = ResponseUsage(
            input_tokens=num_prompt_tokens,
            output_tokens=num_generated_tokens,
600
            total_tokens=num_prompt_tokens + num_generated_tokens,
601
            input_tokens_details=InputTokensDetails(cached_tokens=num_cached_tokens),
602
            output_tokens_details=OutputTokensDetails(
603
                reasoning_tokens=num_reasoning_tokens,
604
605
                tool_output_tokens=num_tool_output_tokens,
            ),
606
607
608
609
        )
        response = ResponsesResponse.from_request(
            request,
            sampling_params,
610
611
            input_messages=input_messages,
            output_messages=output_messages,
612
613
614
            model_name=model_name,
            created_time=created_time,
            output=output,
615
            status=status,
616
617
618
619
620
621
622
            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.
623
                if stored_response is None or stored_response.status != "cancelled":
624
625
626
                    self.response_store[response.id] = response
        return response

627
628
629
630
631
632
    def _topk_logprobs(
        self,
        logprobs: dict[int, SampleLogprob],
        top_logprobs: int,
        tokenizer: AnyTokenizer,
    ) -> list[LogprobTopLogprob]:
633
634
635
636
637
        """Returns the top-k logprobs from the logprobs dictionary."""
        out = []
        for i, (token_id, _logprob) in enumerate(logprobs.items()):
            if i >= top_logprobs:
                break
638
639
640
641
642
            text = (
                _logprob.decoded_token
                if _logprob.decoded_token is not None
                else tokenizer.decode([token_id])
            )
643
644
645
646
647
            out.append(
                LogprobTopLogprob(
                    token=text,
                    logprob=max(_logprob.logprob, -9999.0),
                    bytes=list(text.encode("utf-8", errors="replace")),
648
649
                )
            )
650
651
652
        return out

    def _create_response_logprobs(
653
654
655
656
657
658
        self,
        token_ids: Sequence[int],
        logprobs: Optional[SampleLogprobs],
        tokenizer: AnyTokenizer,
        top_logprobs: Optional[int] = None,
    ) -> list[Logprob]:
659
660
        assert logprobs is not None, "logprobs must be provided"
        assert len(token_ids) == len(logprobs), (
661
662
            "token_ids and logprobs.token_ids must have the same length"
        )
663
664
665
666
        out = []
        for i, token_id in enumerate(token_ids):
            logprob = logprobs[i]
            token_logprob = logprob[token_id]
667
668
669
670
671
            text = (
                token_logprob.decoded_token
                if token_logprob.decoded_token is not None
                else tokenizer.decode([token_id])
            )
672
673
674
675
676
            out.append(
                Logprob(
                    token=text,
                    logprob=max(token_logprob.logprob, -9999.0),
                    bytes=list(text.encode("utf-8", errors="replace")),
677
678
679
680
681
682
683
                    top_logprobs=self._topk_logprobs(
                        logprob, top_logprobs=top_logprobs, tokenizer=tokenizer
                    )
                    if top_logprobs
                    else [],
                )
            )
684
685
        return out

686
687
688
689
690
    def _create_stream_response_logprobs(
        self,
        token_ids: Sequence[int],
        logprobs: Optional[SampleLogprobs],
        tokenizer: AnyTokenizer,
691
        top_logprobs: Optional[int] = None,
692
    ) -> list[response_text_delta_event.Logprob]:
693
694
695
696
697
698
        lgs = self._create_response_logprobs(
            token_ids=token_ids,
            logprobs=logprobs,
            tokenizer=tokenizer,
            top_logprobs=top_logprobs,
        )
699
700
701
702
703
704
        return [
            response_text_delta_event.Logprob(
                token=lg.token,
                logprob=lg.logprob,
                top_logprobs=[
                    response_text_delta_event.LogprobTopLogprob(
705
706
                        token=tl.token, logprob=tl.logprob
                    )
707
                    for tl in lg.top_logprobs
708
709
710
                ],
            )
            for lg in lgs
711
712
        ]

713
714
715
716
717
718
719
720
721
722
723
724
725
    def _make_response_output_items(
        self,
        request: ResponsesRequest,
        final_output: CompletionOutput,
        tokenizer: AnyTokenizer,
    ) -> 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

726
727
728
            reasoning_content, content = reasoning_parser.extract_reasoning_content(
                final_output.text, request=request
            )
729
730
731
732
        else:
            reasoning_content = None
            content = final_output.text

733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
        # Log complete response if output logging is enabled
        if self.enable_log_outputs and self.request_logger:
            output_text = ""
            if content:
                output_text = content
            elif reasoning_content:
                output_text = f"[reasoning: {reasoning_content}]"

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

751
752
753
754
755
756
757
        output = []
        if reasoning_content:
            reasoning_item = ResponseReasoningItem(
                id=f"rs_{random_uuid()}",
                summary=[],
                type="reasoning",
                content=[
758
759
760
                    ResponseReasoningTextContent(
                        text=reasoning_content, type="reasoning_text"
                    )
761
762
763
764
765
766
767
768
769
                ],
                status=None,  # NOTE: Only the last output item has status.
            )
            output.append(reasoning_item)
        if content:
            output_text = ResponseOutputText(
                text=content,
                annotations=[],  # TODO
                type="output_text",
770
771
772
773
774
                logprobs=self._create_response_logprobs(
                    token_ids=final_output.token_ids,
                    logprobs=final_output.logprobs,
                    tokenizer=tokenizer,
                    top_logprobs=request.top_logprobs,
775
776
777
                )
                if request.is_include_output_logprobs()
                else None,
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
            )
            message = ResponseOutputMessage(
                id=f"msg_{random_uuid()}",
                content=[output_text],
                role="assistant",
                status="completed",
                type="message",
            )
            output.append(message)
        return output

    def _make_response_output_items_with_harmony(
        self,
        context: HarmonyContext,
    ) -> list[ResponseOutputItem]:
793
        output_items: list[ResponseOutputItem] = []
794
795
796
797
798
799
800
801
802
        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

803
804
805
806
807
808
809
    def _construct_input_messages(
        self,
        request: ResponsesRequest,
        prev_response: Optional[ResponsesResponse] = None,
    ) -> list[ChatCompletionMessageParam]:
        messages: list[ChatCompletionMessageParam] = []
        if request.instructions:
810
811
812
813
814
815
            messages.append(
                {
                    "role": "system",
                    "content": request.instructions,
                }
            )
816
817
818
819
820
821
822
823
824
825
826
827

        # Prepend the conversation history.
        if prev_response is not None:
            # Add the previous messages.
            prev_msg = self.msg_store[prev_response.id]
            messages.extend(prev_msg)

            # Add the previous output.
            for output_item in prev_response.output:
                # NOTE: We skip the reasoning output.
                if isinstance(output_item, ResponseOutputMessage):
                    for content in output_item.content:
828
829
830
831
832
833
                        messages.append(
                            {
                                "role": "assistant",
                                "content": content.text,
                            }
                        )
834
835

        # Append the new input.
836
        # Responses API supports simple text inputs without chat format.
837
838
839
840
841
842
        if isinstance(request.input, str):
            messages.append({"role": "user", "content": request.input})
        else:
            messages.extend(request.input)  # type: ignore
        return messages

843
844
845
846
847
848
849
850
    def _construct_input_messages_with_harmony(
        self,
        request: ResponsesRequest,
        prev_response: Optional[ResponsesResponse],
    ) -> list[OpenAIHarmonyMessage]:
        messages: list[OpenAIHarmonyMessage] = []
        if prev_response is None:
            # New conversation.
851
            reasoning_effort = request.reasoning.effort if request.reasoning else None
852
            tool_types = [tool.type for tool in request.tools]
853
854
855
856
857
858

            # Allow the MCP Tool type to enable built in tools if the
            # server_label is allowlisted in
            # envs.GPT_OSS_SYSTEM_TOOL_MCP_LABELS
            if envs.GPT_OSS_SYSTEM_TOOL_MCP_LABELS:
                for tool in request.tools:
859
860
861
862
                    if (
                        tool.type == "mcp"
                        and tool.server_label in envs.GPT_OSS_SYSTEM_TOOL_MCP_LABELS
                    ):
863
                        tool_types.append(tool.server_label)
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
            enable_browser = (
                "web_search_preview" in tool_types
                and self.tool_server is not None
                and self.tool_server.has_tool("browser")
            )
            enable_code_interpreter = (
                "code_interpreter" in tool_types
                and self.tool_server is not None
                and self.tool_server.has_tool("python")
            )
            enable_container = (
                "container" in tool_types
                and self.tool_server is not None
                and self.tool_server.has_tool("container")
            )
879
            with_custom_tools = has_custom_tools(tool_types)
880
881
            sys_msg = get_system_message(
                reasoning_effort=reasoning_effort,
882
883
884
885
886
887
888
889
890
                browser_description=self.tool_server.get_tool_description("browser")
                if enable_browser and self.tool_server is not None
                else None,
                python_description=self.tool_server.get_tool_description("python")
                if enable_code_interpreter and self.tool_server is not None
                else None,
                container_description=self.tool_server.get_tool_description("container")
                if enable_container and self.tool_server is not None
                else None,
891
892
                instructions=request.instructions,
                with_custom_tools=with_custom_tools,
893
894
            )
            messages.append(sys_msg)
895
896
            if with_custom_tools:
                dev_msg = get_developer_message(
897
898
                    instructions=request.instructions, tools=request.tools
                )
899
                messages.append(dev_msg)
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
        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
919
920
                    recent_turn_msgs = prev_msgs[prev_final_msg_idx + 1 :]
                    del prev_msgs[prev_final_msg_idx + 1 :]
921
922
923
924
925
926
                    for msg in recent_turn_msgs:
                        assert isinstance(msg, OpenAIHarmonyMessage)
                        if msg.channel != "analysis":
                            prev_msgs.append(msg)
            messages.extend(prev_msgs)
        # Append the new input.
co63oc's avatar
co63oc committed
927
        # Responses API supports simple text inputs without chat format.
928
929
930
931
932
933
934
935
        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:
936
                messages.append(parse_response_input(response_msg, prev_outputs))
937
                # User passes in a tool call request and its output. We need
938
939
940
941
942
943
944
                # 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

945
946
947
948
949
950
    async def _run_background_request_stream(
        self,
        request: ResponsesRequest,
        *args,
        **kwargs,
    ):
951
        event_deque: deque[StreamingResponsesResponse] = deque()
952
953
954
955
        new_event_signal = asyncio.Event()
        self.event_store[request.request_id] = (event_deque, new_event_signal)
        response = None
        try:
956
            generator = self.responses_stream_generator(request, *args, **kwargs)
957
958
959
960
            async for event in generator:
                event_deque.append(event)
                new_event_signal.set()  # Signal new event available
        except Exception as e:
961
            logger.exception("Background request failed for %s", request.request_id)
962
963
964
965
966
967
968
969
970
971
972
973
974
            response = self.create_error_response(str(e))
        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"

975
976
977
978
979
980
981
    async def _run_background_request(
        self,
        request: ResponsesRequest,
        *args,
        **kwargs,
    ):
        try:
982
            response = await self.responses_full_generator(request, *args, **kwargs)
983
        except Exception as e:
984
            logger.exception("Background request failed for %s", request.request_id)
985
986
987
988
989
990
991
992
993
994
995
            response = self.create_error_response(str(e))

        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"

996
997
998
999
    async def responses_background_stream_generator(
        self,
        response_id: str,
        starting_after: Optional[int] = None,
1000
    ) -> AsyncGenerator[StreamingResponsesResponse, None]:
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
        if response_id not in self.event_store:
            raise ValueError(f"Unknown response_id: {response_id}")

        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
1015
                if getattr(event, "type", "unknown") == "response.completed":
1016
                    return
1017
1018
1019
1020
                current_index += 1

            await new_event_signal.wait()

1021
1022
1023
    async def retrieve_responses(
        self,
        response_id: str,
1024
1025
        starting_after: Optional[int],
        stream: Optional[bool],
1026
1027
1028
1029
1030
    ) -> Union[
        ErrorResponse,
        ResponsesResponse,
        AsyncGenerator[StreamingResponsesResponse, None],
    ]:
1031
1032
1033
1034
1035
        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)
1036
1037
1038
1039
1040
1041

        if stream:
            return self.responses_background_stream_generator(
                response_id,
                starting_after,
            )
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
        return response

    async def cancel_responses(
        self,
        response_id: str,
    ) -> Union[ErrorResponse, ResponsesResponse]:
        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.",
                )

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

        # Abort the request.
1064
        if task := self.background_tasks.get(response_id):
1065
1066
1067
1068
            task.cancel()
            try:
                await task
            except asyncio.CancelledError:
1069
                logger.exception("Background task for %s was cancelled", response_id)
1070
1071
1072
1073
1074
1075
1076
1077
        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,
        )
1078
1079
1080
1081

    def _make_store_not_supported_error(self) -> ErrorResponse:
        return self.create_error_response(
            err_type="invalid_request_error",
1082
1083
1084
1085
1086
1087
            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."
            ),
1088
1089
            status_code=HTTPStatus.BAD_REQUEST,
        )
1090

1091
    async def _process_simple_streaming_events(
1092
1093
1094
1095
1096
1097
1098
1099
        self,
        request: ResponsesRequest,
        sampling_params: SamplingParams,
        result_generator: AsyncIterator[Optional[ConversationContext]],
        context: ConversationContext,
        model_name: str,
        tokenizer: AnyTokenizer,
        request_metadata: RequestResponseMetadata,
1100
        created_time: int,
1101
        _increment_sequence_number_and_return: Callable[
1102
1103
            [StreamingResponsesResponse], StreamingResponsesResponse
        ],
1104
    ) -> AsyncGenerator[StreamingResponsesResponse, None]:
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
        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]
                if reasoning_parser:
1122
                    delta_message = (
1123
                        reasoning_parser.extract_reasoning_content_streaming(
1124
1125
1126
1127
1128
1129
1130
                            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,
                        )
1131
1132
                    )
                else:
1133
1134
1135
                    delta_message = DeltaMessage(
                        content=output.text,
                    )
1136
1137
1138
1139
1140
1141
1142
                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())
                    if delta_message.reasoning_content:
1143
                        yield _increment_sequence_number_and_return(
1144
1145
1146
1147
                            ResponseOutputItemAddedEvent(
                                type="response.output_item.added",
                                sequence_number=-1,
                                output_index=current_output_index,
1148
                                item=ResponseReasoningItem(
1149
1150
1151
1152
1153
                                    type="reasoning",
                                    id=current_item_id,
                                    summary=[],
                                    status="in_progress",
                                ),
1154
1155
                            )
                        )
1156
                    else:
1157
                        yield _increment_sequence_number_and_return(
1158
1159
1160
1161
                            ResponseOutputItemAddedEvent(
                                type="response.output_item.added",
                                sequence_number=-1,
                                output_index=current_output_index,
1162
                                item=ResponseOutputMessage(
1163
1164
1165
1166
1167
1168
                                    id=current_item_id,
                                    type="message",
                                    role="assistant",
                                    content=[],
                                    status="in_progress",
                                ),
1169
1170
                            )
                        )
1171
                    yield _increment_sequence_number_and_return(
1172
                        ResponseContentPartAddedEvent(
1173
1174
1175
1176
1177
                            type="response.content_part.added",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
                            content_index=current_content_index,
1178
                            part=ResponseOutputText(
1179
1180
1181
1182
1183
                                type="output_text",
                                text="",
                                annotations=[],
                                logprobs=[],
                            ),
1184
1185
                        )
                    )
1186
1187
1188
1189
1190
1191
                    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
1192
1193
1194
1195
1196
                if (
                    previous_delta_messages
                    and previous_delta_messages[-1].reasoning_content is not None
                    and delta_message.content is not None
                ):
1197
1198
                    # from reasoning to normal content, send done
                    # event for reasoning
1199
1200
1201
1202
1203
                    reason_content = "".join(
                        pm.reasoning_content
                        for pm in previous_delta_messages
                        if pm.reasoning_content is not None
                    )
1204
                    yield _increment_sequence_number_and_return(
1205
1206
1207
1208
1209
1210
1211
                        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,
1212
1213
                        )
                    )
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
                    current_content_index = 0
                    reasoning_item = ResponseReasoningItem(
                        type="reasoning",
                        content=[
                            ResponseReasoningTextContent(
                                text=reason_content,
                                type="reasoning_text",
                            ),
                        ],
                        status="completed",
                        id=current_item_id,
                        summary=[],
                    )
1227
                    yield _increment_sequence_number_and_return(
1228
1229
1230
1231
1232
                        ResponseOutputItemDoneEvent(
                            type="response.output_item.done",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item=reasoning_item,
1233
1234
                        )
                    )
1235
                    yield _increment_sequence_number_and_return(
1236
                        ResponseOutputItemAddedEvent(
1237
1238
1239
                            type="response.output_item.added",
                            sequence_number=-1,
                            output_index=current_output_index,
1240
                            item=ResponseOutputMessage(
1241
1242
1243
1244
1245
1246
                                id=current_item_id,
                                type="message",
                                role="assistant",
                                content=[],
                                status="in_progress",
                            ),
1247
1248
                        )
                    )
1249
1250
                    current_output_index += 1
                    current_item_id = str(uuid.uuid4())
1251
                    yield _increment_sequence_number_and_return(
1252
                        ResponseContentPartAddedEvent(
1253
1254
1255
1256
1257
                            type="response.content_part.added",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
                            content_index=current_content_index,
1258
                            part=ResponseOutputText(
1259
1260
1261
1262
1263
                                type="output_text",
                                text="",
                                annotations=[],
                                logprobs=[],
                            ),
1264
1265
                        )
                    )
1266
1267
1268
                    current_content_index += 1
                    # reset previous delta messages
                    previous_delta_messages = []
1269

1270
                if delta_message.reasoning_content is not None:
1271
                    yield _increment_sequence_number_and_return(
1272
1273
1274
1275
1276
1277
1278
                        ResponseReasoningTextDeltaEvent(
                            type="response.reasoning_text.delta",
                            sequence_number=-1,
                            content_index=current_content_index,
                            output_index=current_output_index,
                            item_id=current_item_id,
                            delta=delta_message.reasoning_content,
1279
1280
                        )
                    )
1281
                elif delta_message.content is not None:
1282
                    yield _increment_sequence_number_and_return(
1283
                        ResponseTextDeltaEvent(
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
                            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,
                            logprobs=self._create_stream_response_logprobs(
                                token_ids=output.token_ids,
                                logprobs=output.logprobs,
                                tokenizer=tokenizer,
                                top_logprobs=request.top_logprobs,
1295
1296
1297
1298
1299
                            )
                            if request.is_include_output_logprobs()
                            else [],
                        )
                    )
1300
1301
1302
1303
1304
                current_content_index += 1

                previous_delta_messages.append(delta_message)
        if previous_delta_messages:
            if previous_delta_messages[-1].reasoning_content is not None:
1305
1306
1307
1308
1309
                reason_content = "".join(
                    pm.reasoning_content
                    for pm in previous_delta_messages
                    if pm.reasoning_content is not None
                )
1310
                yield _increment_sequence_number_and_return(
1311
1312
1313
1314
1315
1316
1317
                    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,
1318
1319
                    )
                )
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
                current_content_index += 1
                reasoning_item = ResponseReasoningItem(
                    type="reasoning",
                    content=[
                        ResponseReasoningTextContent(
                            text=reason_content,
                            type="reasoning_text",
                        ),
                    ],
                    status="completed",
                    id=current_item_id,
                    summary=[],
                )
1333
                yield _increment_sequence_number_and_return(
1334
1335
1336
1337
1338
                    ResponseOutputItemDoneEvent(
                        type="response.output_item.done",
                        sequence_number=-1,
                        output_index=current_output_index,
                        item=reasoning_item,
1339
1340
                    )
                )
1341
            elif previous_delta_messages[-1].content is not None:
1342
1343
1344
1345
1346
                final_content = "".join(
                    pm.content
                    for pm in previous_delta_messages
                    if pm.content is not None
                )
1347
                yield _increment_sequence_number_and_return(
1348
                    ResponseTextDoneEvent(
1349
1350
1351
1352
1353
1354
1355
                        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,
1356
1357
                    )
                )
1358
1359
1360
1361
1362
1363
                current_content_index += 1
                part = ResponseOutputText(
                    text=final_content,
                    type="output_text",
                    annotations=[],
                )
1364
                yield _increment_sequence_number_and_return(
1365
                    ResponseContentPartDoneEvent(
1366
1367
1368
1369
1370
1371
                        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,
1372
1373
                    )
                )
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
                current_content_index += 1
                item = ResponseOutputMessage(
                    type="message",
                    role="assistant",
                    content=[
                        part,
                    ],
                    status="completed",
                    id=current_item_id,
                    summary=[],
                )
1385
                yield _increment_sequence_number_and_return(
1386
1387
1388
1389
1390
                    ResponseOutputItemDoneEvent(
                        type="response.output_item.done",
                        sequence_number=-1,
                        output_index=current_output_index,
                        item=item,
1391
1392
                    )
                )
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403

    async def _process_harmony_streaming_events(
        self,
        request: ResponsesRequest,
        sampling_params: SamplingParams,
        result_generator: AsyncIterator[Optional[ConversationContext]],
        context: ConversationContext,
        model_name: str,
        tokenizer: AnyTokenizer,
        request_metadata: RequestResponseMetadata,
        created_time: int,
1404
        _increment_sequence_number_and_return: Callable[
1405
1406
            [StreamingResponsesResponse], StreamingResponsesResponse
        ],
1407
    ) -> AsyncGenerator[StreamingResponsesResponse, None]:
1408
        current_content_index = -1
1409
        current_output_index = 0
1410
        current_item_id: str = ""
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
        sent_output_item_added = False

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

            if ctx.is_expecting_start():
                current_output_index += 1
                sent_output_item_added = False

                if len(ctx.parser.messages) > 0:
                    previous_item = ctx.parser.messages[-1]
                    if previous_item.recipient is not None:
                        # Deal with tool call here
                        pass
                    elif previous_item.channel == "analysis":
1426
1427
1428
1429
                        content = ResponseReasoningTextContent(
                            text=previous_item.content[0].text,
                            type="reasoning_text",
                        )
1430
1431
                        reasoning_item = ResponseReasoningItem(
                            type="reasoning",
1432
                            content=[content],
1433
                            status="completed",
1434
1435
                            id=current_item_id,
                            summary=[],
1436
                        )
1437
                        yield _increment_sequence_number_and_return(
1438
1439
1440
1441
1442
1443
1444
                            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=previous_item.content[0].text,
1445
1446
                            )
                        )
1447
1448
1449
1450
1451
1452
1453
1454
                        yield _increment_sequence_number_and_return(
                            ResponseReasoningPartDoneEvent(
                                type="response.reasoning_part.done",
                                sequence_number=-1,
                                item_id=current_item_id,
                                output_index=current_output_index,
                                content_index=current_content_index,
                                part=content,
1455
1456
                            )
                        )
1457
                        yield _increment_sequence_number_and_return(
1458
1459
1460
1461
1462
                            ResponseOutputItemDoneEvent(
                                type="response.output_item.done",
                                sequence_number=-1,
                                output_index=current_output_index,
                                item=reasoning_item,
1463
1464
                            )
                        )
1465
1466
1467
1468
1469
1470
                    elif previous_item.channel == "final":
                        text_content = ResponseOutputText(
                            type="output_text",
                            text=previous_item.content[0].text,
                            annotations=[],
                        )
1471
                        yield _increment_sequence_number_and_return(
1472
                            ResponseTextDoneEvent(
1473
1474
1475
1476
1477
1478
1479
                                type="response.output_text.done",
                                sequence_number=-1,
                                output_index=current_output_index,
                                content_index=current_content_index,
                                text=previous_item.content[0].text,
                                logprobs=[],
                                item_id=current_item_id,
1480
1481
                            )
                        )
1482
                        yield _increment_sequence_number_and_return(
1483
1484
1485
1486
1487
1488
1489
                            ResponseContentPartDoneEvent(
                                type="response.content_part.done",
                                sequence_number=-1,
                                item_id=current_item_id,
                                output_index=current_output_index,
                                content_index=current_content_index,
                                part=text_content,
1490
1491
                            )
                        )
1492
                        yield _increment_sequence_number_and_return(
1493
                            ResponseOutputItemDoneEvent(
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
                                type="response.output_item.done",
                                sequence_number=-1,
                                output_index=current_output_index,
                                item=ResponseOutputMessage(
                                    id=current_item_id,
                                    type="message",
                                    role="assistant",
                                    content=[text_content],
                                    status="completed",
                                ),
1504
1505
                            )
                        )
1506

1507
            # stream the output of a harmony message
1508
            if ctx.parser.last_content_delta:
1509
1510
1511
1512
                if (
                    ctx.parser.current_channel == "final"
                    and ctx.parser.current_recipient is None
                ):
1513
1514
                    if not sent_output_item_added:
                        sent_output_item_added = True
1515
                        current_item_id = f"msg_{random_uuid()}"
1516
                        yield _increment_sequence_number_and_return(
1517
1518
1519
1520
                            ResponseOutputItemAddedEvent(
                                type="response.output_item.added",
                                sequence_number=-1,
                                output_index=current_output_index,
1521
                                item=ResponseOutputMessage(
1522
1523
1524
1525
1526
1527
                                    id=current_item_id,
                                    type="message",
                                    role="assistant",
                                    content=[],
                                    status="in_progress",
                                ),
1528
1529
                            )
                        )
1530
                        current_content_index += 1
1531
                        yield _increment_sequence_number_and_return(
1532
1533
1534
1535
1536
1537
                            ResponseContentPartAddedEvent(
                                type="response.content_part.added",
                                sequence_number=-1,
                                output_index=current_output_index,
                                item_id=current_item_id,
                                content_index=current_content_index,
1538
                                part=ResponseOutputText(
1539
1540
1541
1542
1543
                                    type="output_text",
                                    text="",
                                    annotations=[],
                                    logprobs=[],
                                ),
1544
1545
                            )
                        )
1546
                    yield _increment_sequence_number_and_return(
1547
                        ResponseTextDeltaEvent(
1548
1549
1550
1551
1552
1553
1554
1555
                            type="response.output_text.delta",
                            sequence_number=-1,
                            content_index=current_content_index,
                            output_index=current_output_index,
                            item_id=current_item_id,
                            delta=ctx.parser.last_content_delta,
                            # TODO, use logprobs from ctx.last_request_output
                            logprobs=[],
1556
1557
1558
1559
1560
1561
                        )
                    )
                elif (
                    ctx.parser.current_channel == "analysis"
                    and ctx.parser.current_recipient is None
                ):
1562
1563
                    if not sent_output_item_added:
                        sent_output_item_added = True
1564
                        current_item_id = f"msg_{random_uuid()}"
1565
                        yield _increment_sequence_number_and_return(
1566
1567
1568
1569
                            ResponseOutputItemAddedEvent(
                                type="response.output_item.added",
                                sequence_number=-1,
                                output_index=current_output_index,
1570
                                item=ResponseReasoningItem(
1571
1572
1573
1574
1575
                                    type="reasoning",
                                    id=current_item_id,
                                    summary=[],
                                    status="in_progress",
                                ),
1576
1577
                            )
                        )
1578
                        current_content_index += 1
1579
                        yield _increment_sequence_number_and_return(
1580
1581
                            ResponseReasoningPartAddedEvent(
                                type="response.reasoning_part.added",
1582
1583
1584
1585
                                sequence_number=-1,
                                output_index=current_output_index,
                                item_id=current_item_id,
                                content_index=current_content_index,
1586
                                part=ResponseReasoningTextContent(
1587
                                    text="",
1588
                                    type="reasoning_text",
1589
                                ),
1590
1591
                            )
                        )
1592
                    yield _increment_sequence_number_and_return(
1593
1594
1595
1596
1597
1598
1599
                        ResponseReasoningTextDeltaEvent(
                            type="response.reasoning_text.delta",
                            item_id=current_item_id,
                            output_index=current_output_index,
                            content_index=current_content_index,
                            delta=ctx.parser.last_content_delta,
                            sequence_number=-1,
1600
1601
                        )
                    )
1602
1603
1604
                # built-in tools will be triggered on the analysis channel
                # However, occasionally built-in tools will
                # still be output to commentary.
1605
1606
1607
1608
                elif (
                    ctx.parser.current_channel == "commentary"
                    or ctx.parser.current_channel == "analysis"
                ) and ctx.parser.current_recipient == "python":
1609
1610
                    if not sent_output_item_added:
                        sent_output_item_added = True
1611
                        current_item_id = f"tool_{random_uuid()}"
1612
                        yield _increment_sequence_number_and_return(
1613
1614
1615
1616
                            ResponseOutputItemAddedEvent(
                                type="response.output_item.added",
                                sequence_number=-1,
                                output_index=current_output_index,
1617
                                item=ResponseCodeInterpreterToolCallParam(
1618
1619
1620
1621
1622
1623
1624
                                    type="code_interpreter_call",
                                    id=current_item_id,
                                    code=None,
                                    container_id="auto",
                                    outputs=None,
                                    status="in_progress",
                                ),
1625
1626
                            )
                        )
1627
                        yield _increment_sequence_number_and_return(
1628
                            ResponseCodeInterpreterCallInProgressEvent(
1629
                                type="response.code_interpreter_call.in_progress",
1630
1631
1632
                                sequence_number=-1,
                                output_index=current_output_index,
                                item_id=current_item_id,
1633
1634
                            )
                        )
1635
                    yield _increment_sequence_number_and_return(
1636
1637
1638
1639
1640
1641
                        ResponseCodeInterpreterCallCodeDeltaEvent(
                            type="response.code_interpreter_call_code.delta",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
                            delta=ctx.parser.last_content_delta,
1642
1643
                        )
                    )
1644
1645

            # stream tool call outputs
1646
1647
            if ctx.is_assistant_action_turn() and len(ctx.parser.messages) > 0:
                previous_item = ctx.parser.messages[-1]
1648
1649
1650
1651
1652
1653
1654
                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.")
                ):
                    function_name = previous_item.recipient[len("browser.") :]
1655
1656
1657
                    action = None
                    parsed_args = json.loads(previous_item.content[0].text)
                    if function_name == "search":
1658
                        action = response_function_web_search.ActionSearch(
1659
1660
                            type="search",
                            query=parsed_args["query"],
1661
                        )
1662
                    elif function_name == "open":
1663
1664
1665
1666
1667
                        action = response_function_web_search.ActionOpenPage(
                            type="open_page",
                            # TODO: translate to url
                            url=f"cursor:{parsed_args.get('cursor', '')}",
                        )
1668
                    elif function_name == "find":
1669
1670
1671
1672
1673
1674
                        action = response_function_web_search.ActionFind(
                            type="find",
                            pattern=parsed_args["pattern"],
                            # TODO: translate to url
                            url=f"cursor:{parsed_args.get('cursor', '')}",
                        )
1675
                    else:
1676
                        raise ValueError(f"Unknown function name: {function_name}")
1677

1678
                    current_item_id = f"tool_{random_uuid()}"
1679
                    yield _increment_sequence_number_and_return(
1680
                        ResponseOutputItemAddedEvent(
1681
1682
1683
                            type="response.output_item.added",
                            sequence_number=-1,
                            output_index=current_output_index,
1684
                            item=response_function_web_search.ResponseFunctionWebSearch(
1685
1686
1687
1688
1689
1690
                                # TODO: generate a unique id for web search call
                                type="web_search_call",
                                id=current_item_id,
                                action=action,
                                status="in_progress",
                            ),
1691
1692
                        )
                    )
1693
                    yield _increment_sequence_number_and_return(
1694
1695
1696
1697
1698
                        ResponseWebSearchCallInProgressEvent(
                            type="response.web_search_call.in_progress",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
1699
1700
                        )
                    )
1701
                    yield _increment_sequence_number_and_return(
1702
1703
1704
1705
1706
                        ResponseWebSearchCallSearchingEvent(
                            type="response.web_search_call.searching",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
1707
1708
                        )
                    )
1709
1710

                    # enqueue
1711
                    yield _increment_sequence_number_and_return(
1712
1713
1714
1715
1716
                        ResponseWebSearchCallCompletedEvent(
                            type="response.web_search_call.completed",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
1717
1718
                        )
                    )
1719
                    yield _increment_sequence_number_and_return(
1720
                        ResponseOutputItemDoneEvent(
1721
1722
1723
                            type="response.output_item.done",
                            sequence_number=-1,
                            output_index=current_output_index,
1724
                            item=ResponseFunctionWebSearch(
1725
1726
1727
1728
1729
                                type="web_search_call",
                                id=current_item_id,
                                action=action,
                                status="completed",
                            ),
1730
1731
                        )
                    )
1732

1733
1734
1735
1736
1737
1738
                if (
                    self.tool_server is not None
                    and self.tool_server.has_tool("python")
                    and previous_item.recipient is not None
                    and previous_item.recipient.startswith("python")
                ):
1739
                    yield _increment_sequence_number_and_return(
1740
1741
1742
1743
1744
                        ResponseCodeInterpreterCallCodeDoneEvent(
                            type="response.code_interpreter_call_code.done",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
1745
                            code=previous_item.content[0].text,
1746
1747
                        )
                    )
1748
                    yield _increment_sequence_number_and_return(
1749
1750
1751
1752
1753
                        ResponseCodeInterpreterCallInterpretingEvent(
                            type="response.code_interpreter_call.interpreting",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
1754
1755
                        )
                    )
1756
                    yield _increment_sequence_number_and_return(
1757
1758
1759
1760
1761
                        ResponseCodeInterpreterCallCompletedEvent(
                            type="response.code_interpreter_call.completed",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
1762
1763
                        )
                    )
1764
                    yield _increment_sequence_number_and_return(
1765
                        ResponseOutputItemDoneEvent(
1766
1767
1768
                            type="response.output_item.done",
                            sequence_number=-1,
                            output_index=current_output_index,
1769
                            item=ResponseCodeInterpreterToolCallParam(
1770
1771
1772
1773
1774
1775
1776
1777
                                type="code_interpreter_call",
                                id=current_item_id,
                                code=previous_item.content[0].text,
                                container_id="auto",
                                # TODO: add outputs here
                                outputs=[],
                                status="completed",
                            ),
1778
1779
                        )
                    )
1780

1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
    async def responses_stream_generator(
        self,
        request: ResponsesRequest,
        sampling_params: SamplingParams,
        result_generator: AsyncIterator[Optional[ConversationContext]],
        context: ConversationContext,
        model_name: str,
        tokenizer: AnyTokenizer,
        request_metadata: RequestResponseMetadata,
        created_time: Optional[int] = None,
1791
    ) -> AsyncGenerator[StreamingResponsesResponse, None]:
1792
1793
1794
1795
1796
        # TODO:
        # 1. Handle disconnect

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

1797
1798
        sequence_number = 0

1799
        def _increment_sequence_number_and_return(
1800
            event: StreamingResponsesResponse,
1801
        ) -> StreamingResponsesResponse:
1802
1803
            nonlocal sequence_number
            # Set sequence_number if the event has this attribute
1804
            if hasattr(event, "sequence_number"):
1805
1806
                event.sequence_number = sequence_number
            sequence_number += 1
1807
            return event
1808

1809
        async with AsyncExitStack() as exit_stack:
1810
1811
            processer = None
            if self.use_harmony:
1812
1813
                # TODO: in streaming, we noticed this bug:
                # https://github.com/vllm-project/vllm/issues/25697
1814
                await self._initialize_tool_sessions(request, context, exit_stack)
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
                processer = self._process_harmony_streaming_events
            else:
                processer = self._process_simple_streaming_events

            initial_response = ResponsesResponse.from_request(
                request,
                sampling_params,
                model_name=model_name,
                created_time=created_time,
                output=[],
                status="in_progress",
                usage=None,
            ).model_dump()
1828
            yield _increment_sequence_number_and_return(
1829
1830
1831
1832
                ResponseCreatedEvent(
                    type="response.created",
                    sequence_number=-1,
                    response=initial_response,
1833
1834
                )
            )
1835
            yield _increment_sequence_number_and_return(
1836
1837
1838
1839
                ResponseInProgressEvent(
                    type="response.in_progress",
                    sequence_number=-1,
                    response=initial_response,
1840
1841
                )
            )
1842

1843
            async for event_data in processer(
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
                request,
                sampling_params,
                result_generator,
                context,
                model_name,
                tokenizer,
                request_metadata,
                created_time,
                _increment_sequence_number_and_return,
            ):
1854
                yield event_data
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871

            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,
            )
1872
            yield _increment_sequence_number_and_return(
1873
                ResponseCompletedEvent(
1874
1875
                    type="response.completed",
                    sequence_number=-1,
1876
                    response=final_response,
1877
1878
                )
            )