serving_responses.py 78.1 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
53
from vllm.config import ModelConfig
from vllm.engine.protocol import EngineClient
54
55
56
57
58
59
60
61
62
63
from vllm.entrypoints.chat_utils import (
    ChatCompletionMessageParam,
    ChatTemplateContentFormatOption,
)
from vllm.entrypoints.context import (
    ConversationContext,
    HarmonyContext,
    SimpleContext,
    StreamingHarmonyContext,
)
64
from vllm.entrypoints.harmony_utils import (
65
66
67
68
69
70
71
72
73
74
    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,
)
75
from vllm.entrypoints.logger import RequestLogger
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
from vllm.entrypoints.openai.protocol import (
    DeltaMessage,
    ErrorResponse,
    InputTokensDetails,
    OutputTokensDetails,
    RequestResponseMetadata,
    ResponseCompletedEvent,
    ResponseCreatedEvent,
    ResponseInProgressEvent,
    ResponseReasoningPartAddedEvent,
    ResponseReasoningPartDoneEvent,
    ResponsesRequest,
    ResponsesResponse,
    ResponseUsage,
    StreamingResponsesResponse,
)
92
93
from vllm.entrypoints.openai.serving_engine import OpenAIServing
from vllm.entrypoints.openai.serving_models import OpenAIServingModels
94
from vllm.entrypoints.tool_server import ToolServer
95
from vllm.inputs.data import TokensPrompt as EngineTokensPrompt
96
from vllm.logger import init_logger
97
98
from vllm.logprobs import Logprob as SampleLogprob
from vllm.logprobs import SampleLogprobs
99
from vllm.outputs import CompletionOutput
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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,
        model_config: ModelConfig,
        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,
122
        tool_server: Optional[ToolServer] = None,
123
124
        enable_prompt_tokens_details: bool = False,
        enable_force_include_usage: bool = False,
125
        enable_log_outputs: bool = False,
126
        log_error_stack: bool = False,
127
128
129
130
131
132
133
134
    ) -> None:
        super().__init__(
            engine_client=engine_client,
            model_config=model_config,
            models=models,
            request_logger=request_logger,
            return_tokens_as_token_ids=return_tokens_as_token_ids,
            enable_force_include_usage=enable_force_include_usage,
135
            log_error_stack=log_error_stack,
136
137
138
139
        )

        self.chat_template = chat_template
        self.chat_template_content_format: Final = chat_template_content_format
140
        self.enable_log_outputs = enable_log_outputs
141

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

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

166
167
168
169
170
        # 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.
171
        self.enable_store = envs.VLLM_ENABLE_RESPONSES_API_STORE
172
173
174
175
        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 "
176
177
                "the store."
            )
178
179
180

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

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

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

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

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

220
221
        self.background_tasks: dict[str, asyncio.Task] = {}

222
223
        self.tool_server = tool_server

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

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

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

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

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

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

323
        request_metadata = RequestResponseMetadata(request_id=request.request_id)
324
325
326
327
        if raw_request:
            raw_request.state.request_metadata = request_metadata

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

        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")
336
337
            if self.tool_server.has_tool("container"):
                builtin_tool_list.append("container")
338

339
340
341
342
343
344
345
        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):
346
347
348
349
                maybe_error = self._validate_generator_input(engine_prompt)
                if maybe_error is not None:
                    return maybe_error

350
                default_max_tokens = self.max_model_len - len(
351
352
                    engine_prompt["prompt_token_ids"]
                )
353

354
                sampling_params = request.to_sampling_params(
355
356
                    default_max_tokens, self.default_sampling_params
                )
357

358
359
360
361
362
                trace_headers = (
                    None
                    if raw_request is None
                    else await self._get_trace_headers(raw_request.headers)
                )
363
364
365
366

                context: ConversationContext
                if self.use_harmony:
                    if request.stream:
367
                        context = StreamingHarmonyContext(messages, available_tools)
368
369
370
371
372
373
374
375
376
377
378
379
380
                    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,
381
                )
382
383
384
385
                generators.append(generator)
        except ValueError as e:
            # TODO: Use a vllm-specific Validation Error
            return self.create_error_response(str(e))
386

387
        assert len(generators) == 1
388
        (result_generator,) = generators
389
390
391
392

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

394
395
396
397
398
399
400
401
402
403
404
405
406
        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
407

408
            # Run the request in the background.
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
434
435
436
            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}",
                )
437

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

            if request.stream:
446
                return self.responses_background_stream_generator(request.request_id)
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
            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))
472

473
474
475
476
477
478
    async def _make_request(
        self,
        request: ResponsesRequest,
        prev_response: Optional[ResponsesResponse],
        tokenizer: AnyTokenizer,
    ):
479
480
        if len(request.tools) > 0:
            raise NotImplementedError(
481
482
                "Tool use is not supported in Responses API without Harmony"
            )
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
        # 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(
501
502
503
                "Only 'auto' tool_choice is supported in response API with Harmony"
            )
        messages = self._construct_input_messages_with_harmony(request, prev_response)
504
505
        prompt_token_ids = render_for_completion(messages)
        engine_prompt = EngineTokensPrompt(prompt_token_ids=prompt_token_ids)
506
507
508
509
510

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

511
512
        return messages, [prompt_token_ids], [engine_prompt]

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

529
530
531
532
    async def responses_full_generator(
        self,
        request: ResponsesRequest,
        sampling_params: SamplingParams,
533
        result_generator: AsyncIterator[ConversationContext],
534
        context: ConversationContext,
535
536
537
538
539
540
541
542
        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())

543
544
        async with AsyncExitStack() as exit_stack:
            try:
545
                await self._initialize_tool_sessions(request, context, exit_stack)
546
547
548
549
550
551
552
                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))
553

554
555
556
557
558
        # 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"

559
560
        input_messages = None
        output_messages = None
561
562
563
        if self.use_harmony:
            assert isinstance(context, HarmonyContext)
            output = self._make_response_output_items_with_harmony(context)
564
            if request.enable_response_messages:
565
566
                input_messages = context.messages[: context.num_init_messages]
                output_messages = context.messages[context.num_init_messages :]
567
            num_tool_output_tokens = context.num_tool_output_tokens
568
569
570
571
572
573
574
            if len(output) > 0:
                if context.finish_reason == "length":
                    status = "incomplete"
                elif context.finish_reason == "abort":
                    status = "cancelled"
            else:
                status = "incomplete"
575
        else:
576
577
578
579
580
581
            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]

582
            output = self._make_response_output_items(request, final_output, tokenizer)
583

584
585
586
587
            # 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(
588
589
                    "enable_response_messages is currently only supported for gpt-oss"
                )
590
591
            # Calculate usage.
            assert final_res.prompt_token_ids is not None
592
593
            num_tool_output_tokens = 0

594
595
596
597
598
        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
599
600
601
602

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

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

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

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

716
717
718
719
720
721
722
723
724
725
726
727
728
    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

729
730
731
            reasoning_content, content = reasoning_parser.extract_reasoning_content(
                final_output.text, request=request
            )
732
733
734
735
        else:
            reasoning_content = None
            content = final_output.text

736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
        # 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,
                )

754
755
756
757
758
759
760
        output = []
        if reasoning_content:
            reasoning_item = ResponseReasoningItem(
                id=f"rs_{random_uuid()}",
                summary=[],
                type="reasoning",
                content=[
761
762
763
                    ResponseReasoningTextContent(
                        text=reasoning_content, type="reasoning_text"
                    )
764
765
766
767
768
769
770
771
772
                ],
                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",
773
774
775
776
777
                logprobs=self._create_response_logprobs(
                    token_ids=final_output.token_ids,
                    logprobs=final_output.logprobs,
                    tokenizer=tokenizer,
                    top_logprobs=request.top_logprobs,
778
779
780
                )
                if request.is_include_output_logprobs()
                else None,
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
            )
            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]:
796
        output_items: list[ResponseOutputItem] = []
797
798
799
800
801
802
803
804
805
        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

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

        # 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:
831
832
833
834
835
836
                        messages.append(
                            {
                                "role": "assistant",
                                "content": content.text,
                            }
                        )
837
838

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

846
847
848
849
850
851
852
853
    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.
854
            reasoning_effort = request.reasoning.effort if request.reasoning else None
855
            tool_types = [tool.type for tool in request.tools]
856
857
858
859
860
861

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

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

978
979
980
981
982
983
984
    async def _run_background_request(
        self,
        request: ResponsesRequest,
        *args,
        **kwargs,
    ):
        try:
985
            response = await self.responses_full_generator(request, *args, **kwargs)
986
        except Exception as e:
987
            logger.exception("Background request failed for %s", request.request_id)
988
989
990
991
992
993
994
995
996
997
998
            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"

999
1000
1001
1002
    async def responses_background_stream_generator(
        self,
        response_id: str,
        starting_after: Optional[int] = None,
1003
    ) -> AsyncGenerator[StreamingResponsesResponse, None]:
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
        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
1018
                if getattr(event, "type", "unknown") == "response.completed":
1019
                    return
1020
1021
1022
1023
                current_index += 1

            await new_event_signal.wait()

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

        if stream:
            return self.responses_background_stream_generator(
                response_id,
                starting_after,
            )
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
        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.
1067
        if task := self.background_tasks.get(response_id):
1068
1069
1070
1071
            task.cancel()
            try:
                await task
            except asyncio.CancelledError:
1072
                logger.exception("Background task for %s was cancelled", response_id)
1073
1074
1075
1076
1077
1078
1079
1080
        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,
        )
1081
1082
1083
1084

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

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

1273
                if delta_message.reasoning_content is not None:
1274
                    yield _increment_sequence_number_and_return(
1275
1276
1277
1278
1279
1280
1281
                        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,
1282
1283
                        )
                    )
1284
                elif delta_message.content is not None:
1285
                    yield _increment_sequence_number_and_return(
1286
                        ResponseTextDeltaEvent(
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
                            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,
1298
1299
1300
1301
1302
                            )
                            if request.is_include_output_logprobs()
                            else [],
                        )
                    )
1303
1304
1305
1306
1307
                current_content_index += 1

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

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

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

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

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

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

1736
1737
1738
1739
1740
1741
                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")
                ):
1742
                    yield _increment_sequence_number_and_return(
1743
1744
1745
1746
1747
                        ResponseCodeInterpreterCallCodeDoneEvent(
                            type="response.code_interpreter_call_code.done",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
1748
                            code=previous_item.content[0].text,
1749
1750
                        )
                    )
1751
                    yield _increment_sequence_number_and_return(
1752
1753
1754
1755
1756
                        ResponseCodeInterpreterCallInterpretingEvent(
                            type="response.code_interpreter_call.interpreting",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
1757
1758
                        )
                    )
1759
                    yield _increment_sequence_number_and_return(
1760
1761
1762
1763
1764
                        ResponseCodeInterpreterCallCompletedEvent(
                            type="response.code_interpreter_call.completed",
                            sequence_number=-1,
                            output_index=current_output_index,
                            item_id=current_item_id,
1765
1766
                        )
                    )
1767
                    yield _increment_sequence_number_and_return(
1768
                        ResponseOutputItemDoneEvent(
1769
1770
1771
                            type="response.output_item.done",
                            sequence_number=-1,
                            output_index=current_output_index,
1772
                            item=ResponseCodeInterpreterToolCallParam(
1773
1774
1775
1776
1777
1778
1779
1780
                                type="code_interpreter_call",
                                id=current_item_id,
                                code=previous_item.content[0].text,
                                container_id="auto",
                                # TODO: add outputs here
                                outputs=[],
                                status="completed",
                            ),
1781
1782
                        )
                    )
1783

1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
    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,
1794
    ) -> AsyncGenerator[StreamingResponsesResponse, None]:
1795
1796
1797
1798
1799
        # TODO:
        # 1. Handle disconnect

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

1800
1801
        sequence_number = 0

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

1812
        async with AsyncExitStack() as exit_stack:
1813
1814
            processer = None
            if self.use_harmony:
1815
1816
                # TODO: in streaming, we noticed this bug:
                # https://github.com/vllm-project/vllm/issues/25697
1817
                await self._initialize_tool_sessions(request, context, exit_stack)
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
                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()
1831
            yield _increment_sequence_number_and_return(
1832
1833
1834
1835
                ResponseCreatedEvent(
                    type="response.created",
                    sequence_number=-1,
                    response=initial_response,
1836
1837
                )
            )
1838
            yield _increment_sequence_number_and_return(
1839
1840
1841
1842
                ResponseInProgressEvent(
                    type="response.in_progress",
                    sequence_number=-1,
                    response=initial_response,
1843
1844
                )
            )
1845

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

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