serving_responses.py 77.5 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
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,
119
        tool_server: Optional[ToolServer] = None,
120
121
        enable_prompt_tokens_details: bool = False,
        enable_force_include_usage: bool = False,
122
        enable_log_outputs: bool = False,
123
        log_error_stack: bool = False,
124
125
126
127
128
129
130
    ) -> 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,
131
            log_error_stack=log_error_stack,
132
133
134
135
        )

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

138
139
        self.reasoning_parser = self._get_reasoning_parser(
            reasoning_parser_name=reasoning_parser
140
        )
141
142
        self.enable_prompt_tokens_details = enable_prompt_tokens_details
        self.enable_force_include_usage = enable_force_include_usage
143
        self.default_sampling_params = self.model_config.get_diff_sampling_param()
144
145
146
        if self.default_sampling_params:
            source = self.model_config.generation_config
            source = "model" if source == "auto" else source
147
148
149
150
151
            logger.info(
                "Using default chat sampling params from %s: %s",
                source,
                self.default_sampling_params,
            )
152

153
154
155
156
157
        # 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.
158
        self.enable_store = envs.VLLM_ENABLE_RESPONSES_API_STORE
159
160
161
162
        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 "
163
164
                "the store."
            )
165

166
        self.use_harmony = self.model_config.hf_config.model_type == "gpt_oss"
167
        if self.use_harmony:
168
169
170
171
            logger.warning(
                "For gpt-oss, we ignore --enable-auto-tool-choice "
                "and always enable tool use."
            )
172
173
174
175
176
            # 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(
177
178
                get_stop_tokens_for_assistant_actions()
            )
179
180
181
182
183

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

189
        # HACK(woosuk): This is a hack. We should use a better store.
190
191
        # FIXME: If enable_store=True, this may cause a memory leak since we
        # never remove responses from the store.
192
193
194
195
        self.response_store: dict[str, ResponsesResponse] = {}
        self.response_store_lock = asyncio.Lock()

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

200
201
202
        # 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.
203
204
205
        self.event_store: dict[
            str, tuple[deque[StreamingResponsesResponse], asyncio.Event]
        ] = {}
206

207
208
        self.background_tasks: dict[str, asyncio.Task] = {}

209
210
        self.tool_server = tool_server

211
    def _validate_generator_input(
212
213
        self, engine_prompt: EngineTokensPrompt
    ) -> Optional[ErrorResponse]:
214
215
216
217
218
219
        """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}. "
220
221
                "Please reduce prompt."
            )
222
223
224
225
226
227
228
            return self.create_error_response(
                err_type="invalid_request_error",
                message=error_message,
                status_code=HTTPStatus.BAD_REQUEST,
            )
        return None

229
230
231
232
    async def create_responses(
        self,
        request: ResponsesRequest,
        raw_request: Optional[Request] = None,
233
234
235
236
237
    ) -> Union[
        AsyncGenerator[StreamingResponsesResponse, None],
        ResponsesResponse,
        ErrorResponse,
    ]:
238
239
240
241
242
243
244
245
246
247
248
        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

249
        if request.store and not self.enable_store:
250
251
252
253
254
255
256
257
            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 "
258
259
                        "the vLLM server."
                    ),
260
261
262
263
264
265
266
267
268
                    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
269
270
271
272
273
274
        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,
            )
275

276
277
278
279
280
281
282
283
284
285
286
        # 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:
287
            lora_request = self._maybe_get_adapters(request)
288
            model_name = self.models.model_name(lora_request)
289
            tokenizer = await self.engine_client.get_tokenizer()
290

291
292
            if self.use_harmony:
                messages, request_prompts, engine_prompts = (
293
294
                    self._make_request_with_harmony(request, prev_response)
                )
295
            else:
296
297
298
                messages, request_prompts, engine_prompts = await self._make_request(
                    request, prev_response, tokenizer
                )
299

300
301
302
303
304
305
306
        except (
            ValueError,
            TypeError,
            RuntimeError,
            jinja2.TemplateError,
            NotImplementedError,
        ) as e:
307
308
309
            logger.exception("Error in preprocessing prompt inputs")
            return self.create_error_response(f"{e} {e.__cause__}")

310
        request_metadata = RequestResponseMetadata(request_id=request.request_id)
311
312
313
314
        if raw_request:
            raw_request.state.request_metadata = request_metadata

        # Schedule the request and get the result generator.
315
        generators: list[AsyncGenerator[ConversationContext, None]] = []
316
317
318
319
320
321
322

        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")
323
324
            if self.tool_server.has_tool("container"):
                builtin_tool_list.append("container")
325

326
327
328
329
330
331
332
        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):
333
334
335
336
                maybe_error = self._validate_generator_input(engine_prompt)
                if maybe_error is not None:
                    return maybe_error

337
                default_max_tokens = self.max_model_len - len(
338
339
                    engine_prompt["prompt_token_ids"]
                )
340

341
                sampling_params = request.to_sampling_params(
342
343
                    default_max_tokens, self.default_sampling_params
                )
344

345
346
347
348
349
                trace_headers = (
                    None
                    if raw_request is None
                    else await self._get_trace_headers(raw_request.headers)
                )
350
351
352
353

                context: ConversationContext
                if self.use_harmony:
                    if request.stream:
354
                        context = StreamingHarmonyContext(messages, available_tools)
355
356
357
358
359
360
361
362
363
364
365
366
367
                    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,
368
                )
369
370
371
372
                generators.append(generator)
        except ValueError as e:
            # TODO: Use a vllm-specific Validation Error
            return self.create_error_response(str(e))
373

374
        assert len(generators) == 1
375
        (result_generator,) = generators
376
377
378
379

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

381
382
383
384
385
386
387
388
389
390
391
392
393
        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
394

395
            # Run the request in the background.
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
            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}",
                )
424

425
426
427
428
            # For cleanup.
            response_id = response.id
            self.background_tasks[response_id] = task
            task.add_done_callback(
429
430
                lambda _: self.background_tasks.pop(response_id, None)
            )
431
432

            if request.stream:
433
                return self.responses_background_stream_generator(request.request_id)
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
            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))
459

460
461
462
463
464
465
    async def _make_request(
        self,
        request: ResponsesRequest,
        prev_response: Optional[ResponsesResponse],
        tokenizer: AnyTokenizer,
    ):
466
467
        if len(request.tools) > 0:
            raise NotImplementedError(
468
469
                "Tool use is not supported in Responses API without Harmony"
            )
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
        # 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(
488
489
490
                "Only 'auto' tool_choice is supported in response API with Harmony"
            )
        messages = self._construct_input_messages_with_harmony(request, prev_response)
491
492
        prompt_token_ids = render_for_completion(messages)
        engine_prompt = EngineTokensPrompt(prompt_token_ids=prompt_token_ids)
493
494
495
496
497

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

498
499
        return messages, [prompt_token_ids], [engine_prompt]

500
501
502
503
504
505
    async def _initialize_tool_sessions(
        self,
        request: ResponsesRequest,
        context: ConversationContext,
        exit_stack: AsyncExitStack,
    ):
506
507
508
509
        # we should only initialize the tool session if the request needs tools
        if len(request.tools) == 0:
            return
        mcp_tools = {
510
            tool.server_label: tool for tool in request.tools if tool.type == "mcp"
511
        }
512
513
514
        await context.init_tool_sessions(
            self.tool_server, exit_stack, request.request_id, mcp_tools
        )
515

516
517
518
519
    async def responses_full_generator(
        self,
        request: ResponsesRequest,
        sampling_params: SamplingParams,
520
        result_generator: AsyncIterator[ConversationContext],
521
        context: ConversationContext,
522
523
524
525
526
527
528
529
        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())

530
531
        async with AsyncExitStack() as exit_stack:
            try:
532
                await self._initialize_tool_sessions(request, context, exit_stack)
533
534
535
536
537
538
539
                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))
540

541
542
543
544
545
        # 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"

546
547
        input_messages = None
        output_messages = None
548
549
550
        if self.use_harmony:
            assert isinstance(context, HarmonyContext)
            output = self._make_response_output_items_with_harmony(context)
551
            if request.enable_response_messages:
552
553
                input_messages = context.messages[: context.num_init_messages]
                output_messages = context.messages[context.num_init_messages :]
554
            num_tool_output_tokens = context.num_tool_output_tokens
555
556
557
558
559
560
561
            if len(output) > 0:
                if context.finish_reason == "length":
                    status = "incomplete"
                elif context.finish_reason == "abort":
                    status = "cancelled"
            else:
                status = "incomplete"
562
        else:
563
564
565
566
567
568
            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]

569
            output = self._make_response_output_items(request, final_output, tokenizer)
570

571
572
573
574
            # 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(
575
576
                    "enable_response_messages is currently only supported for gpt-oss"
                )
577
578
            # Calculate usage.
            assert final_res.prompt_token_ids is not None
579
580
            num_tool_output_tokens = 0

581
582
583
584
585
        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
586
587
588
589

        usage = ResponseUsage(
            input_tokens=num_prompt_tokens,
            output_tokens=num_generated_tokens,
590
            total_tokens=num_prompt_tokens + num_generated_tokens,
591
            input_tokens_details=InputTokensDetails(cached_tokens=num_cached_tokens),
592
            output_tokens_details=OutputTokensDetails(
593
                reasoning_tokens=num_reasoning_tokens,
594
595
                tool_output_tokens=num_tool_output_tokens,
            ),
596
597
598
599
        )
        response = ResponsesResponse.from_request(
            request,
            sampling_params,
600
601
            input_messages=input_messages,
            output_messages=output_messages,
602
603
604
            model_name=model_name,
            created_time=created_time,
            output=output,
605
            status=status,
606
607
608
609
610
611
612
            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.
613
                if stored_response is None or stored_response.status != "cancelled":
614
615
616
                    self.response_store[response.id] = response
        return response

617
618
619
620
621
622
    def _topk_logprobs(
        self,
        logprobs: dict[int, SampleLogprob],
        top_logprobs: int,
        tokenizer: AnyTokenizer,
    ) -> list[LogprobTopLogprob]:
623
624
625
626
627
        """Returns the top-k logprobs from the logprobs dictionary."""
        out = []
        for i, (token_id, _logprob) in enumerate(logprobs.items()):
            if i >= top_logprobs:
                break
628
629
630
631
632
            text = (
                _logprob.decoded_token
                if _logprob.decoded_token is not None
                else tokenizer.decode([token_id])
            )
633
634
635
636
637
            out.append(
                LogprobTopLogprob(
                    token=text,
                    logprob=max(_logprob.logprob, -9999.0),
                    bytes=list(text.encode("utf-8", errors="replace")),
638
639
                )
            )
640
641
642
        return out

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

676
677
678
679
680
    def _create_stream_response_logprobs(
        self,
        token_ids: Sequence[int],
        logprobs: Optional[SampleLogprobs],
        tokenizer: AnyTokenizer,
681
        top_logprobs: Optional[int] = None,
682
    ) -> list[response_text_delta_event.Logprob]:
683
684
685
686
687
688
        lgs = self._create_response_logprobs(
            token_ids=token_ids,
            logprobs=logprobs,
            tokenizer=tokenizer,
            top_logprobs=top_logprobs,
        )
689
690
691
692
693
694
        return [
            response_text_delta_event.Logprob(
                token=lg.token,
                logprob=lg.logprob,
                top_logprobs=[
                    response_text_delta_event.LogprobTopLogprob(
695
696
                        token=tl.token, logprob=tl.logprob
                    )
697
                    for tl in lg.top_logprobs
698
699
700
                ],
            )
            for lg in lgs
701
702
        ]

703
704
705
706
707
708
709
710
711
712
713
714
715
    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

716
717
718
            reasoning_content, content = reasoning_parser.extract_reasoning_content(
                final_output.text, request=request
            )
719
720
721
722
        else:
            reasoning_content = None
            content = final_output.text

723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
        # 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,
                )

741
742
743
744
745
746
747
        output = []
        if reasoning_content:
            reasoning_item = ResponseReasoningItem(
                id=f"rs_{random_uuid()}",
                summary=[],
                type="reasoning",
                content=[
748
749
750
                    ResponseReasoningTextContent(
                        text=reasoning_content, type="reasoning_text"
                    )
751
752
753
754
755
756
757
758
759
                ],
                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",
760
761
762
763
764
                logprobs=self._create_response_logprobs(
                    token_ids=final_output.token_ids,
                    logprobs=final_output.logprobs,
                    tokenizer=tokenizer,
                    top_logprobs=request.top_logprobs,
765
766
767
                )
                if request.is_include_output_logprobs()
                else None,
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
            )
            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]:
783
        output_items: list[ResponseOutputItem] = []
784
785
786
787
788
789
790
791
792
        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

793
794
795
796
797
798
799
    def _construct_input_messages(
        self,
        request: ResponsesRequest,
        prev_response: Optional[ResponsesResponse] = None,
    ) -> list[ChatCompletionMessageParam]:
        messages: list[ChatCompletionMessageParam] = []
        if request.instructions:
800
801
802
803
804
805
            messages.append(
                {
                    "role": "system",
                    "content": request.instructions,
                }
            )
806
807
808
809
810
811
812
813
814
815
816
817

        # 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:
818
819
820
821
822
823
                        messages.append(
                            {
                                "role": "assistant",
                                "content": content.text,
                            }
                        )
824
825

        # Append the new input.
826
        # Responses API supports simple text inputs without chat format.
827
828
829
830
831
832
        if isinstance(request.input, str):
            messages.append({"role": "user", "content": request.input})
        else:
            messages.extend(request.input)  # type: ignore
        return messages

833
834
835
836
837
838
839
840
    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.
841
            reasoning_effort = request.reasoning.effort if request.reasoning else None
842
            tool_types = [tool.type for tool in request.tools]
843
844
845
846
847
848

            # 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:
849
850
851
852
                    if (
                        tool.type == "mcp"
                        and tool.server_label in envs.GPT_OSS_SYSTEM_TOOL_MCP_LABELS
                    ):
853
                        tool_types.append(tool.server_label)
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
            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")
            )
869
            with_custom_tools = has_custom_tools(tool_types)
870
871
            sys_msg = get_system_message(
                reasoning_effort=reasoning_effort,
872
873
874
875
876
877
878
879
880
                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,
881
882
                instructions=request.instructions,
                with_custom_tools=with_custom_tools,
883
884
            )
            messages.append(sys_msg)
885
886
            if with_custom_tools:
                dev_msg = get_developer_message(
887
888
                    instructions=request.instructions, tools=request.tools
                )
889
                messages.append(dev_msg)
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
        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
909
910
                    recent_turn_msgs = prev_msgs[prev_final_msg_idx + 1 :]
                    del prev_msgs[prev_final_msg_idx + 1 :]
911
912
913
914
915
916
                    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
917
        # Responses API supports simple text inputs without chat format.
918
919
920
921
922
923
924
925
        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:
926
                messages.append(parse_response_input(response_msg, prev_outputs))
927
                # User passes in a tool call request and its output. We need
928
929
930
931
932
933
934
                # 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

935
936
937
938
939
940
    async def _run_background_request_stream(
        self,
        request: ResponsesRequest,
        *args,
        **kwargs,
    ):
941
        event_deque: deque[StreamingResponsesResponse] = deque()
942
943
944
945
        new_event_signal = asyncio.Event()
        self.event_store[request.request_id] = (event_deque, new_event_signal)
        response = None
        try:
946
            generator = self.responses_stream_generator(request, *args, **kwargs)
947
948
949
950
            async for event in generator:
                event_deque.append(event)
                new_event_signal.set()  # Signal new event available
        except Exception as e:
951
            logger.exception("Background request failed for %s", request.request_id)
952
953
954
955
956
957
958
959
960
961
962
963
964
            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"

965
966
967
968
969
970
971
    async def _run_background_request(
        self,
        request: ResponsesRequest,
        *args,
        **kwargs,
    ):
        try:
972
            response = await self.responses_full_generator(request, *args, **kwargs)
973
        except Exception as e:
974
            logger.exception("Background request failed for %s", request.request_id)
975
976
977
978
979
980
981
982
983
984
985
            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"

986
987
988
989
    async def responses_background_stream_generator(
        self,
        response_id: str,
        starting_after: Optional[int] = None,
990
    ) -> AsyncGenerator[StreamingResponsesResponse, None]:
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
        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
1005
                if getattr(event, "type", "unknown") == "response.completed":
1006
                    return
1007
1008
1009
1010
                current_index += 1

            await new_event_signal.wait()

1011
1012
1013
    async def retrieve_responses(
        self,
        response_id: str,
1014
1015
        starting_after: Optional[int],
        stream: Optional[bool],
1016
1017
1018
1019
1020
    ) -> Union[
        ErrorResponse,
        ResponsesResponse,
        AsyncGenerator[StreamingResponsesResponse, None],
    ]:
1021
1022
1023
1024
1025
        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)
1026
1027
1028
1029
1030
1031

        if stream:
            return self.responses_background_stream_generator(
                response_id,
                starting_after,
            )
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
        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.
1054
        if task := self.background_tasks.get(response_id):
1055
1056
1057
1058
            task.cancel()
            try:
                await task
            except asyncio.CancelledError:
1059
                logger.exception("Background task for %s was cancelled", response_id)
1060
1061
1062
1063
1064
1065
1066
1067
        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,
        )
1068
1069
1070
1071

    def _make_store_not_supported_error(self) -> ErrorResponse:
        return self.create_error_response(
            err_type="invalid_request_error",
1072
1073
1074
1075
1076
1077
            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."
            ),
1078
1079
            status_code=HTTPStatus.BAD_REQUEST,
        )
1080

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

1260
                if delta_message.reasoning_content is not None:
1261
                    yield _increment_sequence_number_and_return(
1262
1263
1264
1265
1266
1267
1268
                        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,
1269
1270
                        )
                    )
1271
                elif delta_message.content is not None:
1272
                    yield _increment_sequence_number_and_return(
1273
                        ResponseTextDeltaEvent(
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
                            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,
1285
1286
1287
1288
1289
                            )
                            if request.is_include_output_logprobs()
                            else [],
                        )
                    )
1290
1291
1292
1293
1294
                current_content_index += 1

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

    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,
1394
        _increment_sequence_number_and_return: Callable[
1395
1396
            [StreamingResponsesResponse], StreamingResponsesResponse
        ],
1397
    ) -> AsyncGenerator[StreamingResponsesResponse, None]:
1398
        current_content_index = -1
1399
        current_output_index = 0
1400
        current_item_id: str = ""
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
        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":
1416
1417
1418
1419
                        content = ResponseReasoningTextContent(
                            text=previous_item.content[0].text,
                            type="reasoning_text",
                        )
1420
1421
                        reasoning_item = ResponseReasoningItem(
                            type="reasoning",
1422
                            content=[content],
1423
                            status="completed",
1424
1425
                            id=current_item_id,
                            summary=[],
1426
                        )
1427
                        yield _increment_sequence_number_and_return(
1428
1429
1430
1431
1432
1433
1434
                            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,
1435
1436
                            )
                        )
1437
1438
1439
1440
1441
1442
1443
1444
                        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,
1445
1446
                            )
                        )
1447
                        yield _increment_sequence_number_and_return(
1448
1449
1450
1451
1452
                            ResponseOutputItemDoneEvent(
                                type="response.output_item.done",
                                sequence_number=-1,
                                output_index=current_output_index,
                                item=reasoning_item,
1453
1454
                            )
                        )
1455
1456
1457
1458
1459
1460
                    elif previous_item.channel == "final":
                        text_content = ResponseOutputText(
                            type="output_text",
                            text=previous_item.content[0].text,
                            annotations=[],
                        )
1461
                        yield _increment_sequence_number_and_return(
1462
                            ResponseTextDoneEvent(
1463
1464
1465
1466
1467
1468
1469
                                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,
1470
1471
                            )
                        )
1472
                        yield _increment_sequence_number_and_return(
1473
1474
1475
1476
1477
1478
1479
                            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,
1480
1481
                            )
                        )
1482
                        yield _increment_sequence_number_and_return(
1483
                            ResponseOutputItemDoneEvent(
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
                                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",
                                ),
1494
1495
                            )
                        )
1496

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

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

1668
                    current_item_id = f"tool_{random_uuid()}"
1669
                    yield _increment_sequence_number_and_return(
1670
                        ResponseOutputItemAddedEvent(
1671
1672
1673
                            type="response.output_item.added",
                            sequence_number=-1,
                            output_index=current_output_index,
1674
                            item=response_function_web_search.ResponseFunctionWebSearch(
1675
1676
1677
1678
1679
1680
                                # TODO: generate a unique id for web search call
                                type="web_search_call",
                                id=current_item_id,
                                action=action,
                                status="in_progress",
                            ),
1681
1682
                        )
                    )
1683
                    yield _increment_sequence_number_and_return(
1684
1685
1686
1687
1688
                        ResponseWebSearchCallInProgressEvent(
                            type="response.web_search_call.in_progress",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
1689
1690
                        )
                    )
1691
                    yield _increment_sequence_number_and_return(
1692
1693
1694
1695
1696
                        ResponseWebSearchCallSearchingEvent(
                            type="response.web_search_call.searching",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
1697
1698
                        )
                    )
1699
1700

                    # enqueue
1701
                    yield _increment_sequence_number_and_return(
1702
1703
1704
1705
1706
                        ResponseWebSearchCallCompletedEvent(
                            type="response.web_search_call.completed",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
1707
1708
                        )
                    )
1709
                    yield _increment_sequence_number_and_return(
1710
                        ResponseOutputItemDoneEvent(
1711
1712
1713
                            type="response.output_item.done",
                            sequence_number=-1,
                            output_index=current_output_index,
1714
                            item=ResponseFunctionWebSearch(
1715
1716
1717
1718
1719
                                type="web_search_call",
                                id=current_item_id,
                                action=action,
                                status="completed",
                            ),
1720
1721
                        )
                    )
1722

1723
1724
1725
1726
1727
1728
                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")
                ):
1729
                    yield _increment_sequence_number_and_return(
1730
1731
1732
1733
1734
                        ResponseCodeInterpreterCallCodeDoneEvent(
                            type="response.code_interpreter_call_code.done",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
1735
                            code=previous_item.content[0].text,
1736
1737
                        )
                    )
1738
                    yield _increment_sequence_number_and_return(
1739
1740
1741
1742
1743
                        ResponseCodeInterpreterCallInterpretingEvent(
                            type="response.code_interpreter_call.interpreting",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
1744
1745
                        )
                    )
1746
                    yield _increment_sequence_number_and_return(
1747
1748
1749
1750
1751
                        ResponseCodeInterpreterCallCompletedEvent(
                            type="response.code_interpreter_call.completed",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
1752
1753
                        )
                    )
1754
                    yield _increment_sequence_number_and_return(
1755
                        ResponseOutputItemDoneEvent(
1756
1757
1758
                            type="response.output_item.done",
                            sequence_number=-1,
                            output_index=current_output_index,
1759
                            item=ResponseCodeInterpreterToolCallParam(
1760
1761
1762
1763
1764
1765
1766
1767
                                type="code_interpreter_call",
                                id=current_item_id,
                                code=previous_item.content[0].text,
                                container_id="auto",
                                # TODO: add outputs here
                                outputs=[],
                                status="completed",
                            ),
1768
1769
                        )
                    )
1770

1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
    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,
1781
    ) -> AsyncGenerator[StreamingResponsesResponse, None]:
1782
1783
1784
1785
1786
        # TODO:
        # 1. Handle disconnect

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

1787
1788
        sequence_number = 0

1789
        def _increment_sequence_number_and_return(
1790
            event: StreamingResponsesResponse,
1791
        ) -> StreamingResponsesResponse:
1792
1793
            nonlocal sequence_number
            # Set sequence_number if the event has this attribute
1794
            if hasattr(event, "sequence_number"):
1795
1796
                event.sequence_number = sequence_number
            sequence_number += 1
1797
            return event
1798

1799
        async with AsyncExitStack() as exit_stack:
1800
1801
            processer = None
            if self.use_harmony:
1802
1803
                # TODO: in streaming, we noticed this bug:
                # https://github.com/vllm-project/vllm/issues/25697
1804
                await self._initialize_tool_sessions(request, context, exit_stack)
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
                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()
1818
            yield _increment_sequence_number_and_return(
1819
1820
1821
1822
                ResponseCreatedEvent(
                    type="response.created",
                    sequence_number=-1,
                    response=initial_response,
1823
1824
                )
            )
1825
            yield _increment_sequence_number_and_return(
1826
1827
1828
1829
                ResponseInProgressEvent(
                    type="response.in_progress",
                    sequence_number=-1,
                    response=initial_response,
1830
1831
                )
            )
1832

1833
            async for event_data in processer(
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
                request,
                sampling_params,
                result_generator,
                context,
                model_name,
                tokenizer,
                request_metadata,
                created_time,
                _increment_sequence_number_and_return,
            ):
1844
                yield event_data
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861

            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,
            )
1862
            yield _increment_sequence_number_and_return(
1863
                ResponseCompletedEvent(
1864
1865
                    type="response.completed",
                    sequence_number=-1,
1866
                    response=final_response,
1867
1868
                )
            )