test_chat_utils.py 79.8 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3

4
import warnings
5
from collections.abc import Mapping
6
from typing import Literal
7
8

import pytest
9
import torch
10
from mistral_common.tokens.tokenizers.base import SpecialTokenPolicy
11

12
from vllm.assets.audio import AudioAsset
13
from vllm.assets.image import ImageAsset
14
from vllm.assets.video import VideoAsset
15
from vllm.config import ModelConfig
16
17
from vllm.entrypoints.chat_utils import (
    _try_extract_ast,
18
    apply_mistral_chat_template,
19
20
21
22
23
24
25
    load_chat_template,
    parse_chat_messages,
    parse_chat_messages_futures,
    resolve_chat_template_content_format,
    resolve_chat_template_kwargs,
    resolve_hf_chat_template,
)
26
from vllm.multimodal import MultiModalDataDict, MultiModalUUIDDict
27
from vllm.multimodal.utils import (
28
29
30
    encode_audio_url,
    encode_image_url,
    encode_video_url,
31
)
32
33
from vllm.tokenizers import get_tokenizer
from vllm.tokenizers.mistral import MistralTokenizer
34
from vllm.utils.serial_utils import tensor2base64
35

36
from ..models.registry import HF_EXAMPLE_MODELS
37
38
39
40
from ..utils import VLLM_PATH

EXAMPLES_DIR = VLLM_PATH / "examples"

41
PHI3V_MODEL_ID = "microsoft/Phi-3.5-vision-instruct"
42
ULTRAVOX_MODEL_ID = "fixie-ai/ultravox-v0_5-llama-3_2-1b"
43
QWEN2AUDIO_MODEL_ID = "Qwen/Qwen2-Audio-7B-Instruct"
44
QWEN2VL_MODEL_ID = "Qwen/Qwen2-VL-2B-Instruct"
45
QWEN25VL_MODEL_ID = "Qwen/Qwen2.5-VL-3B-Instruct"
46
QWEN25OMNI_MODEL_ID = "Qwen/Qwen2.5-Omni-7B"
47
QWEN3_MODEL_ID = "Qwen/Qwen3-8B"
48
LLAMA_GUARD_MODEL_ID = "meta-llama/Llama-Guard-3-1B"
49
HERMES_MODEL_ID = "NousResearch/Hermes-3-Llama-3.1-8B"
50
MISTRAL_MODEL_ID = "mistralai/Mistral-Small-3.1-24B-Instruct-2503"
51
52


53
@pytest.fixture(scope="function")
54
def phi3v_model_config():
55
56
57
58
59
60
61
62
    return ModelConfig(
        PHI3V_MODEL_ID,
        runner="generate",
        trust_remote_code=True,
        limit_mm_per_prompt={
            "image": 2,
        },
    )
63
64


65
66
@pytest.fixture(scope="function")
def phi3v_model_config_mm_interleaved():
67
68
69
70
71
72
73
74
75
    return ModelConfig(
        PHI3V_MODEL_ID,
        runner="generate",
        trust_remote_code=True,
        interleave_mm_strings=True,
        limit_mm_per_prompt={
            "image": 2,
        },
    )
76
77


78
79
80
81
82
83
84
85
86
87
88
89
90
@pytest.fixture(scope="function")
def phi3v_model_config_image_embeds():
    return ModelConfig(
        PHI3V_MODEL_ID,
        runner="generate",
        trust_remote_code=True,
        limit_mm_per_prompt={
            "image": 2,
        },
        enable_mm_embeds=True,
    )


91
92
93
94
95
96
97
98
99
100
101
102
@pytest.fixture(scope="function")
def qwen2_audio_model_config():
    return ModelConfig(
        QWEN2AUDIO_MODEL_ID,
        runner="generate",
        trust_remote_code=True,
        limit_mm_per_prompt={
            "audio": 1,
        },
    )


103
104
105
106
107
108
109
110
111
112
113
114
115
@pytest.fixture(scope="function")
def audio_embeds_model_config():
    return ModelConfig(
        QWEN2AUDIO_MODEL_ID,
        runner="generate",
        trust_remote_code=True,
        limit_mm_per_prompt={
            "audio": 2,
        },
        enable_mm_embeds=True,
    )


116
117
@pytest.fixture(scope="function")
def qwen25omni_model_config_mm_interleaved():
118
119
120
121
122
123
124
125
126
127
    return ModelConfig(
        QWEN25OMNI_MODEL_ID,
        runner="generate",
        interleave_mm_strings=True,
        limit_mm_per_prompt={
            "image": 2,
            "audio": 1,
            "video": 1,
        },
    )
128
129


130
131
@pytest.fixture(scope="function")
def mistral_model_config():
132
133
134
135
136
137
138
    return ModelConfig(
        MISTRAL_MODEL_ID,
        runner="generate",
        limit_mm_per_prompt={
            "image": 2,
        },
    )
139
140


141
142
@pytest.fixture(scope="module")
def image_url():
143
    image = ImageAsset("cherry_blossom")
144
    return encode_image_url(image.pil_image)
145
146


147
148
@pytest.fixture(scope="module")
def video_url():
149
    video = VideoAsset("baby_reading", 1)
150
    return encode_video_url(video.np_ndarrays)
151
152
153
154


@pytest.fixture(scope="module")
def audio_url():
155
    audio = AudioAsset("mary_had_lamb")
156
    return encode_audio_url(*audio.audio_and_sample_rate)
157
158


159
def _assert_mm_data_is_image_input(
160
    mm_data: MultiModalDataDict | None,
161
    image_count: int,
162
    skipped_image_indices: list | None = None,
163
164
165
166
167
168
169
) -> None:
    assert mm_data is not None
    assert set(mm_data.keys()) == {"image"}

    image_data = mm_data.get("image")
    assert image_data is not None

170
    assert isinstance(image_data, list) and len(image_data) == image_count
171
172
173
    if skipped_image_indices is not None:
        for i in skipped_image_indices:
            assert image_data[i] is None
174
175


176
def _assert_mm_uuids(
177
    mm_uuids: MultiModalUUIDDict | None,
178
    media_count: int,
179
    expected_uuids: list[str | None],
180
181
182
183
184
185
186
187
188
    modality: str = "image",
) -> None:
    if len(expected_uuids) > 0:
        assert mm_uuids is not None
        assert modality in mm_uuids

        image_uuids = mm_uuids.get(modality)
        assert image_uuids is not None

189
        assert isinstance(image_uuids, list) and len(image_uuids) == media_count
190
191
192
193
194
195

        assert image_uuids == expected_uuids
    else:
        assert mm_uuids is None


196
197
198
199
200
ModalityType = Literal["image", "video", "audio"]
MultiModalDataCounts = Mapping[ModalityType, int]


def _assert_mm_data_inputs(
201
    mm_data: MultiModalDataDict | None,
202
    data_count: MultiModalDataCounts,
203
    skipped_media_indices: dict[str, list] | None = None,  # modality -> list[int]
204
205
206
207
208
209
210
211
212
) -> None:
    assert mm_data is not None
    assert set(data_count.keys()) == (set(mm_data.keys()))

    for modality, n in data_count.items():
        modality_data = mm_data.get(modality)
        assert modality_data is not None
        assert isinstance(modality_data, list) and len(modality_data) == n

213
        if skipped_media_indices is not None:
214
            skipped_media_indices_for_modality = skipped_media_indices.get(modality)
215
216
217
218
            assert skipped_media_indices_for_modality is not None
            for i in skipped_media_indices_for_modality:
                assert modality_data[i] is None

219

220
221
222
223
def test_parse_chat_messages_single_image(
    phi3v_model_config,
    image_url,
):
224
    conversation, mm_data, mm_uuids = parse_chat_messages(
225
226
227
228
229
230
231
232
233
        [
            {
                "role": "user",
                "content": [
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "text", "text": "What's in the image?"},
                ],
            }
        ],
234
        phi3v_model_config,
235
236
        content_format="string",
    )
237

238
239
240
    assert conversation == [
        {"role": "user", "content": "<|image_1|>\nWhat's in the image?"}
    ]
241
    _assert_mm_data_is_image_input(mm_data, 1)
242
243
244
245
246
247
248
249
250
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[None])


def test_parse_chat_messages_single_image_with_uuid(
    phi3v_model_config,
    image_url,
):
    image_uuid = str(hash(image_url))
    conversation, mm_data, mm_uuids = parse_chat_messages(
251
252
253
254
255
256
257
258
259
260
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url,
                        },
                        "uuid": image_uuid,
261
                    },
262
263
264
265
                    {"type": "text", "text": "What's in the image?"},
                ],
            }
        ],
266
        phi3v_model_config,
267
268
269
        content_format="string",
    )

270
271
272
    assert conversation == [
        {"role": "user", "content": "<|image_1|>\nWhat's in the image?"}
    ]
273
274
275
276
    _assert_mm_data_is_image_input(mm_data, 1)
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[image_uuid])


277
278
279
280
281
282
def test_parse_chat_messages_single_empty_image_with_uuid(
    phi3v_model_config,
    image_url,
):
    image_uuid = str(hash(image_url))
    conversation, mm_data, mm_uuids = parse_chat_messages(
283
284
285
286
287
288
289
290
291
292
293
294
295
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": None,
                        "uuid": image_uuid,
                    },
                    {"type": "text", "text": "What's in the image?"},
                ],
            }
        ],
296
        phi3v_model_config,
297
298
299
        content_format="string",
    )

300
301
302
    assert conversation == [
        {"role": "user", "content": "<|image_1|>\nWhat's in the image?"}
    ]
303
304
305
306
    _assert_mm_data_is_image_input(mm_data, 1, skipped_image_indices=[0])
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[image_uuid])


307
308
309
310
311
312
def test_parse_chat_messages_single_image_with_bad_uuid_format(
    phi3v_model_config,
    image_url,
):
    image_uuid = str(hash(image_url))
    conversation, mm_data, mm_uuids = parse_chat_messages(
313
314
315
316
317
318
319
320
321
322
323
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url,
                            "uuid": image_uuid,
                        },
                        "bad_uuid_key": image_uuid,
324
                    },
325
326
327
328
                    {"type": "text", "text": "What's in the image?"},
                ],
            }
        ],
329
        phi3v_model_config,
330
331
332
        content_format="string",
    )

333
334
335
    assert conversation == [
        {"role": "user", "content": "<|image_1|>\nWhat's in the image?"}
    ]
336
337
338
339
340
341
342
343
344
345
346
347
    _assert_mm_data_is_image_input(mm_data, 1)
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[None])


def test_parse_chat_messages_multiple_images_with_uuids(
    phi3v_model_config,
    image_url,
):
    image_uuid1 = "my_uuid_1"
    image_uuid2 = "my_uuid_2"

    conversation, mm_data, mm_uuids = parse_chat_messages(
348
349
350
351
352
353
354
355
356
357
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url,
                        },
                        "uuid": image_uuid1,
358
                    },
359
360
361
362
363
364
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url,
                        },
                        "uuid": image_uuid2,
365
                    },
366
367
368
369
                    {"type": "text", "text": "What's in the image?"},
                ],
            }
        ],
370
        phi3v_model_config,
371
372
373
        content_format="string",
    )

374
375
376
377
378
379
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nWhat's in the image?",
        }
    ]
380
381
382
383
    _assert_mm_data_is_image_input(mm_data, 2)
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[image_uuid1, image_uuid2])


384
385
386
387
388
389
390
391
def test_parse_chat_messages_multiple_empty_images_with_uuids(
    phi3v_model_config,
    image_url,
):
    image_uuid1 = "my_uuid_1"
    image_uuid2 = "my_uuid_2"

    conversation, mm_data, mm_uuids = parse_chat_messages(
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": None,
                        "uuid": image_uuid1,
                    },
                    {
                        "type": "image_url",
                        "image_url": None,
                        "uuid": image_uuid2,
                    },
                    {"type": "text", "text": "What's in the image?"},
                ],
            }
        ],
410
        phi3v_model_config,
411
412
413
        content_format="string",
    )

414
415
416
417
418
419
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nWhat's in the image?",
        }
    ]
420
421
422
423
424
425
426
427
428
429
430
431
    _assert_mm_data_is_image_input(mm_data, 2, skipped_image_indices=[0, 1])
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[image_uuid1, image_uuid2])


def test_parse_chat_messages_mixed_empty_images_with_uuids(
    phi3v_model_config,
    image_url,
):
    image_uuid1 = "my_uuid_1"
    image_uuid2 = "my_uuid_2"

    conversation, mm_data, mm_uuids = parse_chat_messages(
432
433
434
435
436
437
438
439
440
441
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url,
                        },
                        "uuid": image_uuid1,
442
                    },
443
444
445
446
447
448
449
450
451
                    {
                        "type": "image_url",
                        "image_url": None,
                        "uuid": image_uuid2,
                    },
                    {"type": "text", "text": "What's in the image?"},
                ],
            }
        ],
452
        phi3v_model_config,
453
454
455
        content_format="string",
    )

456
457
458
459
460
461
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nWhat's in the image?",
        }
    ]
462
463
464
465
    _assert_mm_data_is_image_input(mm_data, 2, skipped_image_indices=[1])
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[image_uuid1, image_uuid2])


466
467
468
469
470
471
472
@pytest.mark.asyncio
async def test_parse_chat_messages_single_image_with_uuid_async(
    phi3v_model_config,
    image_url,
):
    image_uuid = str(hash(image_url))
    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
473
474
475
476
477
478
479
480
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": {"url": image_url},
                        "uuid": image_uuid,
481
                    },
482
483
484
485
                    {"type": "text", "text": "What's in the image?"},
                ],
            }
        ],
486
        phi3v_model_config,
487
488
489
        content_format="string",
    )

490
491
492
    assert conversation == [
        {"role": "user", "content": "<|image_1|>\nWhat's in the image?"}
    ]
493
494
495
496
    _assert_mm_data_is_image_input(await mm_future, 1)
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[image_uuid])


497
498
499
500
501
502
503
@pytest.mark.asyncio
async def test_parse_chat_messages_empty_image_with_uuid_async(
    phi3v_model_config,
    image_url,
):
    image_uuid = str(hash(image_url))
    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
504
505
506
507
508
509
510
511
512
513
514
515
516
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": None,
                        "uuid": image_uuid,
                    },
                    {"type": "text", "text": "What's in the image?"},
                ],
            }
        ],
517
        phi3v_model_config,
518
519
520
        content_format="string",
    )

521
522
523
524
    assert conversation == [
        {"role": "user", "content": "<|image_1|>\nWhat's in the image?"}
    ]
    _assert_mm_data_is_image_input(await mm_future, 1, skipped_image_indices=[0])
525
526
527
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[image_uuid])


528
529
530
531
532
533
534
535
536
@pytest.mark.asyncio
async def test_parse_chat_messages_multiple_images_with_uuids_async(
    phi3v_model_config,
    image_url,
):
    image_uuid1 = "my_uuid_1"
    image_uuid2 = "my_uuid_2"

    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
537
538
539
540
541
542
543
544
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": {"url": image_url},
                        "uuid": image_uuid1,
545
                    },
546
547
548
549
550
551
552
553
554
                    {
                        "type": "image_pil",
                        "image_pil": ImageAsset("cherry_blossom").pil_image,
                        "uuid": image_uuid2,
                    },
                    {"type": "text", "text": "What's in these images?"},
                ],
            }
        ],
555
        phi3v_model_config,
556
557
558
        content_format="string",
    )

559
560
561
562
563
564
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nWhat's in these images?",
        }
    ]
565
566
567
568
    _assert_mm_data_is_image_input(await mm_future, 2)
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[image_uuid1, image_uuid2])


569
570
571
572
573
574
575
576
577
@pytest.mark.asyncio
async def test_parse_chat_messages_multiple_empty_images_with_uuids_async(
    phi3v_model_config,
    image_url,
):
    image_uuid1 = "my_uuid_1"
    image_uuid2 = "my_uuid_2"

    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": None,
                        "uuid": image_uuid1,
                    },
                    {
                        "type": "image_pil",
                        "image_pil": None,
                        "uuid": image_uuid2,
                    },
                    {"type": "text", "text": "What's in these images?"},
                ],
            }
        ],
596
        phi3v_model_config,
597
598
599
        content_format="string",
    )

600
601
602
603
604
605
606
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nWhat's in these images?",
        }
    ]
    _assert_mm_data_is_image_input(await mm_future, 2, skipped_image_indices=[0, 1])
607
608
609
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[image_uuid1, image_uuid2])


610
611
612
613
614
615
616
617
@pytest.mark.asyncio
async def test_parse_chat_messages_multiple_images_with_partial_uuids_async(
    phi3v_model_config,
    image_url,
):
    image_uuid2 = "my_uuid_2"

    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
618
619
620
621
622
623
624
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": {"url": image_url},
625
                    },
626
627
628
629
630
631
632
633
634
                    {
                        "type": "image_pil",
                        "image_pil": ImageAsset("cherry_blossom").pil_image,
                        "uuid": image_uuid2,
                    },
                    {"type": "text", "text": "What's in these images?"},
                ],
            }
        ],
635
        phi3v_model_config,
636
637
638
        content_format="string",
    )

639
640
641
642
643
644
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nWhat's in these images?",
        }
    ]
645
646
    _assert_mm_data_is_image_input(await mm_future, 2)
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, image_uuid2])
647
648


649
650
651
652
def test_parse_chat_messages_empty_system(
    mistral_model_config,
):
    # Test string format
653
    conversation, _, _ = parse_chat_messages(
654
        [
655
            {"role": "system", "content": ""},
656
657
            {
                "role": "user",
658
                "content": [{"type": "text", "text": "Who are you?"}],
659
660
            },
        ],
661
        mistral_model_config,
662
663
        content_format="string",
    )
664
    assert conversation == [
665
666
        {"role": "system", "content": ""},
        {"role": "user", "content": "Who are you?"},
667
    ]
668
669

    # Test openai format
670
    conversation, _, _ = parse_chat_messages(
671
        [
672
            {"role": "system", "content": ""},
673
674
            {
                "role": "user",
675
                "content": [{"type": "text", "text": "Who are you?"}],
676
677
            },
        ],
678
        mistral_model_config,
679
680
681
        content_format="openai",
    )
    assert conversation == [
682
683
        {"role": "system", "content": [{"type": "text", "text": ""}]},
        {"role": "user", "content": [{"type": "text", "text": "Who are you?"}]},
684
    ]
685
686


687
@pytest.mark.asyncio
688
689
690
691
async def test_parse_chat_messages_single_image_async(
    phi3v_model_config,
    image_url,
):
692
    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
693
694
695
696
697
698
699
700
701
        [
            {
                "role": "user",
                "content": [
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "text", "text": "What's in the image?"},
                ],
            }
        ],
702
        phi3v_model_config,
703
704
        content_format="string",
    )
705

706
707
708
    assert conversation == [
        {"role": "user", "content": "<|image_1|>\nWhat's in the image?"}
    ]
709
    _assert_mm_data_is_image_input(await mm_future, 1)
710
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[None])
711
712
713
714
715
716


def test_parse_chat_messages_multiple_images(
    phi3v_model_config,
    image_url,
):
717
    conversation, mm_data, mm_uuids = parse_chat_messages(
718
719
720
721
722
723
724
725
726
727
728
729
730
        [
            {
                "role": "user",
                "content": [
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {
                        "type": "image_pil",
                        "image_pil": ImageAsset("cherry_blossom").pil_image,
                    },
                    {"type": "text", "text": "What's in these images?"},
                ],
            }
        ],
731
        phi3v_model_config,
732
733
        content_format="string",
    )
734

735
736
737
738
739
740
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nWhat's in these images?",
        }
    ]
741
    _assert_mm_data_is_image_input(mm_data, 2)
742
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
743
744


745
746
747
748
749
def test_parse_chat_messages_empty_pil_image_with_uuid(
    phi3v_model_config,
):
    uuid = "abcd"
    conversation, mm_data, mm_uuids = parse_chat_messages(
750
751
752
753
754
755
756
757
758
        [
            {
                "role": "user",
                "content": [
                    {"type": "image_pil", "image_pil": None, "uuid": uuid},
                    {"type": "text", "text": "What's in this image?"},
                ],
            }
        ],
759
        phi3v_model_config,
760
761
762
        content_format="string",
    )

763
764
765
766
767
768
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\nWhat's in this image?",
        }
    ]
769
770
771
772
773
    _assert_mm_data_is_image_input(mm_data, 1, skipped_image_indices=[0])
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[uuid])


def test_parse_chat_messages_empty_image_embeds_with_uuid(
774
    phi3v_model_config_image_embeds,
775
776
777
):
    uuid = "abcd"
    conversation, mm_data, mm_uuids = parse_chat_messages(
778
779
780
781
782
783
784
785
786
        [
            {
                "role": "user",
                "content": [
                    {"type": "image_embeds", "image_embeds": None, "uuid": uuid},
                    {"type": "text", "text": "What's in this image?"},
                ],
            }
        ],
787
        phi3v_model_config_image_embeds,
788
789
790
        content_format="string",
    )

791
792
793
794
795
796
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\nWhat's in this image?",
        }
    ]
797

798
799
    assert mm_data is not None
    assert "image" in mm_data
800
801
802
803
    assert isinstance(mm_data["image"], list)
    assert len(mm_data["image"]) == 1
    assert mm_data["image"][0] is None

804
805
806
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[uuid])


807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
def test_parse_chat_messages_empty_audio_embeds_with_uuid(
    audio_embeds_model_config,
):
    """Test audio_embeds with UUID (no actual embeds data)."""
    uuid = "test-audio-uuid-123"

    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
                "role": "user",
                "content": [
                    {"type": "text", "text": "Describe this audio"},
                    {"type": "audio_embeds", "audio_embeds": None, "uuid": uuid},
                ],
            }
        ],
823
        audio_embeds_model_config,
824
825
826
827
828
829
        content_format="string",
    )

    # Should have audio in mm_data as None (UUID provided)
    assert mm_data is not None
    assert "audio" in mm_data
830
831
832
833
    assert isinstance(mm_data["audio"], list)
    assert len(mm_data["audio"]) == 1
    assert mm_data["audio"][0] is None

834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
    # UUID should be recorded
    _assert_mm_uuids(mm_uuids, 1, modality="audio", expected_uuids=[uuid])


def test_parse_chat_messages_audio_embeds_with_string(
    audio_embeds_model_config,
):
    """Test audio_embeds with base64 string embedding data."""

    import torch

    # Create a sample audio embedding tensor
    audio_embedding = torch.randn(1, 128, 768)

    # Encode it as base64
849
    base64_audio_embedding = tensor2base64(audio_embedding)
850
851
852
853
854
855
856
857
858
859
860
861
862
863

    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
                "role": "user",
                "content": [
                    {"type": "text", "text": "Describe this audio"},
                    {
                        "type": "audio_embeds",
                        "audio_embeds": base64_audio_embedding,
                    },
                ],
            }
        ],
864
        audio_embeds_model_config,
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
        content_format="string",
    )

    # Should have audio embedding in mm_data (single tensor, not a list)
    assert mm_data is not None
    assert "audio" in mm_data
    assert isinstance(mm_data["audio"], torch.Tensor)
    assert mm_data["audio"].shape == audio_embedding.shape
    # No UUID provided
    assert mm_uuids is not None
    assert "audio" in mm_uuids
    _assert_mm_uuids(mm_uuids, 1, modality="audio", expected_uuids=[None])


@pytest.mark.asyncio
async def test_parse_chat_messages_audio_embeds_async(
    audio_embeds_model_config,
):
    """Test audio_embeds with async futures."""

    import torch

    # Create a sample audio embedding tensor
    audio_embedding = torch.randn(1, 128, 768)

    # Encode it as base64
891
    base64_audio_embedding = tensor2base64(audio_embedding)
892
893
894
895
896
897
898
899
900
901
902
903
904
905

    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
        [
            {
                "role": "user",
                "content": [
                    {"type": "text", "text": "Describe this audio"},
                    {
                        "type": "audio_embeds",
                        "audio_embeds": base64_audio_embedding,
                    },
                ],
            }
        ],
906
        audio_embeds_model_config,
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
        content_format="string",
    )

    # Should have audio embedding in mm_data (single tensor, not a list)
    mm_data = await mm_future
    assert mm_data is not None
    assert "audio" in mm_data
    assert isinstance(mm_data["audio"], torch.Tensor)
    assert mm_data["audio"].shape == audio_embedding.shape
    # No UUID provided
    assert mm_uuids is not None
    assert "audio" in mm_uuids
    _assert_mm_uuids(mm_uuids, 1, modality="audio", expected_uuids=[None])


922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
def test_parse_chat_messages_multiple_image_embeds(
    phi3v_model_config_image_embeds,
):
    """Test that multiple image_embeds in a single message are now supported.

    This test validates the fix for the limitation that previously only allowed
    one message with {'type': 'image_embeds'}. Now multiple image embeddings
    can be provided in a single request, similar to regular images.
    """
    # Create two sample image embedding tensors
    image_embedding_1 = torch.randn(256, 1024)
    image_embedding_2 = torch.randn(128, 1024)

    # Encode them as base64 using the convenience function
    base64_image_embedding_1 = tensor2base64(image_embedding_1)
    base64_image_embedding_2 = tensor2base64(image_embedding_2)

    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_embeds",
                        "image_embeds": base64_image_embedding_1,
                    },
                    {
                        "type": "image_embeds",
                        "image_embeds": base64_image_embedding_2,
                    },
                    {"type": "text", "text": "Describe these two images."},
                ],
            }
        ],
        phi3v_model_config_image_embeds,
        content_format="string",
    )

    # Verify conversation structure
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nDescribe these two images.",
        }
    ]

    # Verify mm_data contains a list of embeddings (not a single embedding)
    assert mm_data is not None
    assert "image" in mm_data
    assert isinstance(mm_data["image"], list)
    assert len(mm_data["image"]) == 2

    # Verify each embedding has the correct shape
    assert isinstance(mm_data["image"][0], torch.Tensor)
    assert mm_data["image"][0].shape == image_embedding_1.shape
    assert isinstance(mm_data["image"][1], torch.Tensor)
    assert mm_data["image"][1].shape == image_embedding_2.shape

    # Verify UUIDs (None since we didn't provide any)
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])


def test_parse_chat_messages_multiple_image_embeds_with_uuids(
    phi3v_model_config_image_embeds,
):
    """Test multiple image_embeds with UUIDs.

    This validates that UUIDs are properly tracked for multiple embeddings.
    """
    uuid1 = "image-uuid-1"
    uuid2 = "image-uuid-2"

    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_embeds",
                        "image_embeds": None,
                        "uuid": uuid1,
                    },
                    {
                        "type": "image_embeds",
                        "image_embeds": None,
                        "uuid": uuid2,
                    },
                    {"type": "text", "text": "Compare these images."},
                ],
            }
        ],
        phi3v_model_config_image_embeds,
        content_format="string",
    )

    # Verify conversation structure
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nCompare these images.",
        }
    ]

    # Verify mm_data contains a list with None values (UUID references)
    assert mm_data is not None
    assert "image" in mm_data
    assert isinstance(mm_data["image"], list)
    assert len(mm_data["image"]) == 2
    assert mm_data["image"][0] is None
    assert mm_data["image"][1] is None

    # Verify UUIDs are correctly tracked
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[uuid1, uuid2])


@pytest.mark.asyncio
async def test_parse_chat_messages_multiple_image_embeds_async(
    phi3v_model_config_image_embeds,
):
    """Test multiple image_embeds with async parsing.

    This validates the AsyncMultiModalItemTracker also supports multiple embeddings.
    """
    # Create two sample image embedding tensors
    image_embedding_1 = torch.randn(200, 768)
    image_embedding_2 = torch.randn(150, 768)

    # Encode them as base64 using the convenience function
    base64_image_embedding_1 = tensor2base64(image_embedding_1)
    base64_image_embedding_2 = tensor2base64(image_embedding_2)

    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_embeds",
                        "image_embeds": base64_image_embedding_1,
                    },
                    {
                        "type": "image_embeds",
                        "image_embeds": base64_image_embedding_2,
                    },
                    {"type": "text", "text": "What do these images show?"},
                ],
            }
        ],
        phi3v_model_config_image_embeds,
        content_format="string",
    )

    # Verify conversation structure
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nWhat do these images show?",
        }
    ]

    # Await the future and verify mm_data
    mm_data = await mm_future
    assert mm_data is not None
    assert "image" in mm_data
    assert isinstance(mm_data["image"], list)
    assert len(mm_data["image"]) == 2

    # Verify each embedding has the correct shape
    assert isinstance(mm_data["image"][0], torch.Tensor)
    assert mm_data["image"][0].shape == image_embedding_1.shape
    assert isinstance(mm_data["image"][1], torch.Tensor)
    assert mm_data["image"][1].shape == image_embedding_2.shape

    # Verify UUIDs
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])


1099
1100
@pytest.mark.asyncio
async def test_parse_chat_messages_empty_image_embeds_with_uuid_async(
1101
    phi3v_model_config_image_embeds,
1102
1103
1104
):
    uuid = "abcd"
    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
1105
1106
1107
1108
1109
1110
1111
1112
1113
        [
            {
                "role": "user",
                "content": [
                    {"type": "image_embeds", "image_embeds": None, "uuid": uuid},
                    {"type": "text", "text": "What's in this image?"},
                ],
            }
        ],
1114
        phi3v_model_config_image_embeds,
1115
1116
1117
        content_format="string",
    )

1118
1119
1120
1121
1122
1123
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\nWhat's in this image?",
        }
    ]
1124
1125
1126
    mm_data = await mm_future
    assert mm_data is not None
    assert "image" in mm_data
1127
1128
1129
1130
    assert isinstance(mm_data["image"], list)
    assert len(mm_data["image"]) == 1
    assert mm_data["image"][0] is None

1131
1132
1133
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[uuid])


1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
def test_parse_chat_messages_empty_dict_image_embeds(
    phi3v_model_config_image_embeds,
):
    """Test that empty dictionary for image_embeds is handled without errors."""
    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
                "role": "user",
                "content": [
                    {"type": "image_embeds", "image_embeds": {}},
                    {"type": "text", "text": "What's in this image?"},
                ],
            }
        ],
        phi3v_model_config_image_embeds,
        content_format="string",
    )

    # Verify conversation structure
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\nWhat's in this image?",
        }
    ]

    # Verify mm_data contains an empty dictionary of embeddings
    assert mm_data is not None
    assert "image" in mm_data
    assert isinstance(mm_data["image"], dict)
    assert len(mm_data["image"]) == 0

    # Verify UUIDs (None since we didn't provide any)
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[None])


def test_parse_chat_messages_multiple_dict_image_embeds(
    phi3v_model_config_image_embeds,
):
    """Test that multiple dictionaries for image_embeds is handled without errors."""
    # Create two sample image embedding tensors
    batch_size = 2
    image_embedding_1 = torch.randn(batch_size, 256, 1024)
    image_embedding_2 = torch.randn(batch_size, 3)

    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_embeds",
                        "image_embeds": {
                            "image_embedding_1": tensor2base64(p),
                            "image_embedding_2": tensor2base64(i),
                        },
                    }
                    for p, i in zip(image_embedding_1, image_embedding_2)
                ]
                + [
                    {"type": "text", "text": "Describe these two images."},
                ],
            }
        ],
        phi3v_model_config_image_embeds,
        content_format="string",
    )

    # Verify conversation structure
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nDescribe these two images.",
        }
    ]

    # Verify mm_data contains a dictionary of multi-embeddings
    assert mm_data is not None
    assert "image" in mm_data
    assert isinstance(mm_data["image"], dict)
    assert len(mm_data["image"]) == batch_size

    # Verify each embedding has the correct shape
    assert isinstance(mm_data["image"]["image_embedding_1"], torch.Tensor)
    assert mm_data["image"]["image_embedding_1"].shape == image_embedding_1.shape
    assert isinstance(mm_data["image"]["image_embedding_2"], torch.Tensor)
    assert mm_data["image"]["image_embedding_2"].shape == image_embedding_2.shape

    # Verify UUIDs (None since we didn't provide any)
    _assert_mm_uuids(mm_uuids, batch_size, expected_uuids=[None, None])


1226
@pytest.mark.asyncio
1227
1228
1229
1230
async def test_parse_chat_messages_multiple_images_async(
    phi3v_model_config,
    image_url,
):
1231
    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
        [
            {
                "role": "user",
                "content": [
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {
                        "type": "image_pil",
                        "image_pil": ImageAsset("cherry_blossom").pil_image,
                    },
                    {"type": "text", "text": "What's in these images?"},
                ],
            }
        ],
1245
        phi3v_model_config,
1246
1247
        content_format="string",
    )
1248

1249
1250
1251
1252
1253
1254
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nWhat's in these images?",
        }
    ]
1255
    _assert_mm_data_is_image_input(await mm_future, 2)
1256
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
1257
1258
1259
1260
1261
1262


def test_parse_chat_messages_placeholder_already_in_prompt(
    phi3v_model_config,
    image_url,
):
1263
    conversation, mm_data, mm_uuids = parse_chat_messages(
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
        [
            {
                "role": "user",
                "content": [
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {
                        "type": "text",
                        "text": "What's in <|image_1|> and how does it compare to <|image_2|>?",  # noqa: E501
                    },
                ],
            }
        ],
1277
        phi3v_model_config,
1278
1279
        content_format="string",
    )
1280
1281
1282
1283
1284
1285
    assert conversation == [
        {
            "role": "user",
            "content": "What's in <|image_1|> and how does it compare to <|image_2|>?",
        }
    ]
1286
    _assert_mm_data_is_image_input(mm_data, 2)
1287
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
1288
1289


1290
1291
1292
1293
def test_parse_chat_messages_placeholder_one_already_in_prompt(
    phi3v_model_config,
    image_url,
):
1294
    conversation, mm_data, mm_uuids = parse_chat_messages(
1295
1296
1297
1298
1299
1300
1301
1302
        [
            {
                "role": "user",
                "content": [
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {
                        "type": "text",
1303
1304
                        "text": "What's in <|image_1|> and how does it compare to "
                        "the other one?",
1305
1306
1307
1308
                    },
                ],
            }
        ],
1309
        phi3v_model_config,
1310
1311
        content_format="string",
    )
1312

1313
1314
1315
    assert conversation == [
        {
            "role": "user",
1316
1317
            "content": "<|image_2|>\nWhat's in <|image_1|> and how does it compare to "
            "the other one?",
1318
1319
        }
    ]
1320
    _assert_mm_data_is_image_input(mm_data, 2)
1321
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
1322
1323


1324
1325
1326
1327
def test_parse_chat_messages_multiple_images_across_messages(
    phi3v_model_config,
    image_url,
):
1328
    conversation, mm_data, mm_uuids = parse_chat_messages(
1329
1330
        [
            {
1331
                "role": "user",
1332
                "content": [
1333
1334
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "text", "text": "What's in this image?"},
1335
1336
                ],
            },
1337
            {"role": "assistant", "content": "Some stuff."},
1338
            {
1339
                "role": "user",
1340
                "content": [
1341
1342
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "text", "text": "What about this one?"},
1343
1344
1345
                ],
            },
        ],
1346
        phi3v_model_config,
1347
1348
        content_format="string",
    )
1349
1350

    assert conversation == [
1351
1352
1353
        {"role": "user", "content": "<|image_1|>\nWhat's in this image?"},
        {"role": "assistant", "content": "Some stuff."},
        {"role": "user", "content": "<|image_2|>\nWhat about this one?"},
1354
    ]
1355
    _assert_mm_data_is_image_input(mm_data, 2)
1356
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
1357
1358


1359
def test_parse_chat_messages_multiple_images_with_uuids_across_messages(
1360
    phi3v_model_config,
1361
    image_url,
1362
):
1363
1364
    image_uuid = str(hash(image_url))
    conversation, mm_data, mm_uuids = parse_chat_messages(
1365
1366
        [
            {
1367
                "role": "user",
1368
1369
1370
                "content": [
                    {
                        "type": "image_url",
1371
                        "image_url": {"url": image_url},
1372
1373
                        "uuid": image_uuid,
                    },
1374
                    {"type": "text", "text": "What's in this image?"},
1375
                ],
1376
            },
1377
            {"role": "assistant", "content": "Some stuff."},
1378
            {
1379
                "role": "user",
1380
1381
1382
                "content": [
                    {
                        "type": "image_url",
1383
                        "image_url": {"url": image_url},
1384
1385
                        "uuid": image_uuid,
                    },
1386
                    {"type": "text", "text": "What about this one?"},
1387
1388
1389
                ],
            },
        ],
1390
        phi3v_model_config,
1391
1392
1393
1394
        content_format="string",
    )

    assert conversation == [
1395
1396
1397
        {"role": "user", "content": "<|image_1|>\nWhat's in this image?"},
        {"role": "assistant", "content": "Some stuff."},
        {"role": "user", "content": "<|image_2|>\nWhat about this one?"},
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
    ]
    _assert_mm_data_is_image_input(mm_data, 2)
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[image_uuid, image_uuid])


def test_parse_chat_messages_context_text_format(
    phi3v_model_config,
):
    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
                "role": "user",
1410
                "content": [{"type": "text", "text": "What's in this text?"}],
1411
            },
1412
1413
            {"role": "assistant", "content": "Some stuff."},
            {"role": "user", "content": "What about this one?"},
1414
        ],
1415
        phi3v_model_config,
1416
1417
        content_format="openai",
    )
1418
1419
1420
1421

    assert conversation == [
        {
            "role": "user",
1422
            "content": [{"type": "text", "text": "What's in this text?"}],
1423
1424
1425
        },
        {
            "role": "assistant",
1426
            "content": [{"type": "text", "text": "Some stuff."}],
1427
1428
1429
        },
        {
            "role": "user",
1430
            "content": [{"type": "text", "text": "What about this one?"}],
1431
1432
        },
    ]
1433
1434
    assert mm_data is None
    assert mm_uuids is None
1435
1436


1437
1438
1439
1440
def test_parse_chat_messages_rejects_too_many_images_in_one_message(
    phi3v_model_config,
    image_url,
):
1441
1442
1443
    with warnings.catch_warnings():
        warnings.filterwarnings(
            "ignore",
1444
1445
            message="coroutine 'async_get_and_parse_image' was never awaited",
        )
1446
        with pytest.raises(ValueError, match="At most"):
1447
            parse_chat_messages(
1448
1449
1450
1451
1452
1453
1454
                [
                    {
                        "role": "user",
                        "content": [
                            {
                                "type": "image_url",
                                "image_url": {"url": image_url},
1455
                            },
1456
1457
1458
                            {
                                "type": "image_url",
                                "image_url": {"url": image_url},
1459
                            },
1460
1461
1462
                            {
                                "type": "image_url",
                                "image_url": {"url": image_url},
1463
                            },
1464
1465
1466
1467
                            {"type": "text", "text": "What's in these images?"},
                        ],
                    }
                ],
1468
                phi3v_model_config,
1469
1470
                content_format="string",
            )
1471
1472


1473
1474
1475
1476
def test_parse_chat_messages_rejects_too_many_images_across_messages(
    phi3v_model_config,
    image_url,
):
1477
1478
1479
    with warnings.catch_warnings():
        warnings.filterwarnings(
            "ignore",
1480
1481
            message="coroutine 'async_get_and_parse_image' was never awaited",
        )
1482
        with pytest.raises(ValueError, match="At most"):
1483
            parse_chat_messages(
1484
1485
                [
                    {
1486
                        "role": "user",
1487
1488
1489
                        "content": [
                            {
                                "type": "image_url",
1490
                                "image_url": {"url": image_url},
1491
                            },
1492
                            {"type": "text", "text": "What's in this image?"},
1493
1494
                        ],
                    },
1495
                    {"role": "assistant", "content": "Some stuff."},
1496
                    {
1497
                        "role": "user",
1498
1499
1500
                        "content": [
                            {
                                "type": "image_url",
1501
                                "image_url": {"url": image_url},
1502
1503
1504
                            },
                            {
                                "type": "image_url",
1505
                                "image_url": {"url": image_url},
1506
                            },
1507
                            {"type": "text", "text": "What about these two?"},
1508
1509
1510
                        ],
                    },
                ],
1511
                phi3v_model_config,
1512
1513
                content_format="string",
            )
1514
1515
1516
1517
1518
1519


def test_parse_chat_messages_multiple_images_uncommon_input(
    phi3v_model_config,
    image_url,
):
1520
    conversation, mm_data, mm_uuids = parse_chat_messages(
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
        [
            {
                "role": "user",
                "content": [
                    "What's in these images?",
                    {"image_url": image_url},
                    {"image_url": image_url},
                ],
            }
        ],
1531
        phi3v_model_config,
1532
1533
        content_format="string",
    )
1534

1535
1536
1537
1538
1539
1540
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nWhat's in these images?",
        }
    ]
1541
    _assert_mm_data_is_image_input(mm_data, 2)
1542
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
1543
1544


1545
1546
1547
1548
def test_parse_chat_messages_multiple_images_interleave(
    phi3v_model_config_mm_interleaved,
    image_url,
):
1549
    conversation, mm_data, mm_uuids = parse_chat_messages(
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "text",
                        "text": "I need you to compare this image",
                    },
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "text", "text": "and this one"},
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "text", "text": "Do they have differences?"},
                ],
            }
        ],
1565
        phi3v_model_config_mm_interleaved,
1566
1567
1568
        content_format="string",
    )

1569
1570
1571
1572
1573
1574
1575
    assert conversation == [
        {
            "role": "user",
            "content": "I need you to compare this image\n<|image_1|>\nand this one\n<|image_2|>\n"  # noqa: E501
            "Do they have differences?",
        }
    ]
1576
    _assert_mm_data_is_image_input(mm_data, 2)
1577
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
1578
1579
1580
1581
1582
1583
1584


@pytest.mark.asyncio
async def test_parse_chat_messages_multiple_images_interleave_async(
    phi3v_model_config_mm_interleaved,
    image_url,
):
1585
    conversation, mm_data, mm_uuids = parse_chat_messages_futures(
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "text",
                        "text": "I need you to compare this image",
                    },
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "text", "text": "and this one"},
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "text", "text": "Do they have differences?"},
                ],
            }
        ],
1601
        phi3v_model_config_mm_interleaved,
1602
1603
1604
        content_format="string",
    )

1605
1606
1607
1608
1609
1610
1611
    assert conversation == [
        {
            "role": "user",
            "content": "I need you to compare this image\n<|image_1|>\nand this one\n<|image_2|>\n"  # noqa: E501
            "Do they have differences?",
        }
    ]
1612
    _assert_mm_data_is_image_input(await mm_data, 2)
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])


@pytest.mark.asyncio
async def test_parse_chat_messages_multiple_images_with_uuids_interleave_async(
    phi3v_model_config_mm_interleaved,
    image_url,
):
    image_uuid = str(hash(image_url))
    conversation, mm_data, mm_uuids = parse_chat_messages_futures(
1623
1624
1625
1626
1627
1628
1629
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "text",
                        "text": "I need you to compare this image",
1630
                    },
1631
1632
1633
1634
                    {
                        "type": "image_url",
                        "image_url": {"url": image_url},
                        "uuid": image_uuid,
1635
                    },
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
                    {"type": "text", "text": "and this one"},
                    {
                        "type": "image_url",
                        "image_url": {"url": image_url},
                        "uuid": image_uuid,
                    },
                    {"type": "text", "text": "Do they have differences?"},
                ],
            }
        ],
1646
        phi3v_model_config_mm_interleaved,
1647
1648
1649
        content_format="string",
    )

1650
1651
1652
1653
1654
1655
1656
    assert conversation == [
        {
            "role": "user",
            "content": "I need you to compare this image\n<|image_1|>\nand this one\n<|image_2|>\n"  # noqa: E501
            "Do they have differences?",
        }
    ]
1657
1658
    _assert_mm_data_is_image_input(await mm_data, 2)
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[image_uuid, image_uuid])
1659
1660
1661
1662
1663
1664


def test_parse_chat_messages_multiple_images_multiple_messages_interleave(
    phi3v_model_config_mm_interleaved,
    image_url,
):
1665
    conversation, mm_data, mm_uuids = parse_chat_messages(
1666
1667
        [
            {
1668
                "role": "user",
1669
                "content": [
1670
1671
1672
                    {"type": "text", "text": "What's on this image?"},
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "text", "text": "Be accurate."},
1673
1674
                ],
            },
1675
            {"role": "assistant", "content": "Some stuff."},
1676
            {
1677
                "role": "user",
1678
                "content": [
1679
1680
                    {"type": "text", "text": "What's on this image?"},
                    {"type": "image_url", "image_url": {"url": image_url}},
1681
1682
1683
                ],
            },
        ],
1684
        phi3v_model_config_mm_interleaved,
1685
1686
1687
        content_format="string",
    )

1688
1689
1690
1691
1692
    assert conversation == [
        {
            "role": "user",
            "content": "What's on this image?\n<|image_1|>\nBe accurate.",
        },
1693
1694
        {"role": "assistant", "content": "Some stuff."},
        {"role": "user", "content": "What's on this image?\n<|image_2|>"},
1695
    ]
1696
    _assert_mm_data_is_image_input(mm_data, 2)
1697
1698
1699
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])


1700
def test_parse_chat_messages_multiple_images_with_uuids_multiple_messages_interleave(
1701
1702
1703
1704
1705
1706
1707
    phi3v_model_config_mm_interleaved,
    image_url,
):
    image_uuid = str(hash(image_url))
    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
1708
                "role": "user",
1709
                "content": [
1710
                    {"type": "text", "text": "What's on this image?"},
1711
1712
                    {
                        "type": "image_url",
1713
                        "image_url": {"url": image_url},
1714
1715
                        "uuid": image_uuid,
                    },
1716
                    {"type": "text", "text": "Be accurate."},
1717
1718
                ],
            },
1719
            {"role": "assistant", "content": "Some stuff."},
1720
            {
1721
                "role": "user",
1722
                "content": [
1723
                    {"type": "text", "text": "What's on this image?"},
1724
1725
                    {
                        "type": "image_url",
1726
                        "image_url": {"url": image_url},
1727
1728
1729
1730
1731
                        "uuid": image_uuid,
                    },
                ],
            },
        ],
1732
        phi3v_model_config_mm_interleaved,
1733
1734
1735
1736
1737
1738
1739
1740
        content_format="string",
    )

    assert conversation == [
        {
            "role": "user",
            "content": "What's on this image?\n<|image_1|>\nBe accurate.",
        },
1741
1742
        {"role": "assistant", "content": "Some stuff."},
        {"role": "user", "content": "What's on this image?\n<|image_2|>"},
1743
1744
1745
    ]
    _assert_mm_data_is_image_input(mm_data, 2)
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[image_uuid, image_uuid])
1746
1747
1748


def test_parse_chat_messages_multiple_modals_multiple_messages_interleave(
1749
1750
1751
1752
1753
    qwen25omni_model_config_mm_interleaved,
    image_url,
    video_url,
    audio_url,
):
1754
    conversation, mm_data, mm_uuids = parse_chat_messages(
1755
1756
        [
            {
1757
                "role": "user",
1758
                "content": [
1759
1760
1761
1762
                    {"type": "text", "text": "What's on this image?"},
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "text", "text": "Now listen to this audio"},
                    {"type": "audio_url", "audio_url": {"url": audio_url}},
1763
1764
                ],
            },
1765
            {"role": "assistant", "content": "Some stuff."},
1766
            {
1767
                "role": "user",
1768
                "content": [
1769
1770
1771
1772
                    {"type": "text", "text": "What's on this image?"},
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "text", "text": "And what's in the video?"},
                    {"type": "video_url", "video_url": {"url": video_url}},
1773
1774
1775
                ],
            },
        ],
1776
        qwen25omni_model_config_mm_interleaved,
1777
1778
1779
1780
1781
        content_format="string",
    )

    assert conversation == [
        {
1782
            "role": "user",
1783
1784
            "content": "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>"
            "\nNow listen to this audio\nAudio 1: <|audio_bos|><|AUDIO|><|audio_eos|>",
1785
        },
1786
        {"role": "assistant", "content": "Some stuff."},
1787
        {
1788
            "role": "user",
1789
1790
            "content": "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>"
            "\nAnd what's in the video?\n<|vision_start|><|VIDEO|><|vision_end|>",
1791
1792
        },
    ]
1793
1794

    _assert_mm_data_inputs(mm_data, {"image": 2, "video": 1, "audio": 1})
1795
    _assert_mm_uuids(mm_uuids, 2, modality="image", expected_uuids=[None, None])
1796
1797
1798
1799
    _assert_mm_uuids(mm_uuids, 1, modality="video", expected_uuids=[None])
    _assert_mm_uuids(mm_uuids, 1, modality="audio", expected_uuids=[None])


1800
def test_parse_chat_messages_multiple_modals_with_uuids_multiple_messages_interleave(
1801
1802
1803
1804
1805
1806
1807
1808
    qwen25omni_model_config_mm_interleaved,
    image_url,
    video_url,
    audio_url,
):
    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
1809
                "role": "user",
1810
                "content": [
1811
                    {"type": "text", "text": "What's on this image?"},
1812
1813
                    {
                        "type": "image_url",
1814
                        "image_url": {"url": image_url},
1815
1816
                        "uuid": "image_123",
                    },
1817
                    {"type": "text", "text": "Now listen to this audio"},
1818
1819
                    {
                        "type": "audio_url",
1820
                        "audio_url": {"url": audio_url},
1821
1822
1823
1824
                        "uuid": "audio_123",
                    },
                ],
            },
1825
            {"role": "assistant", "content": "Some stuff."},
1826
            {
1827
                "role": "user",
1828
                "content": [
1829
                    {"type": "text", "text": "What's on this image?"},
1830
1831
                    {
                        "type": "image_url",
1832
                        "image_url": {"url": image_url},
1833
1834
                        "uuid": "image_123",
                    },
1835
                    {"type": "text", "text": "And what's in the video?"},
1836
1837
                    {
                        "type": "video_url",
1838
                        "video_url": {"url": video_url},
1839
1840
1841
1842
1843
                        "uuid": "video_123",
                    },
                ],
            },
        ],
1844
        qwen25omni_model_config_mm_interleaved,
1845
1846
1847
1848
1849
        content_format="string",
    )

    assert conversation == [
        {
1850
            "role": "user",
1851
1852
            "content": "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>"
            "\nNow listen to this audio\nAudio 1: <|audio_bos|><|AUDIO|><|audio_eos|>",
1853
        },
1854
        {"role": "assistant", "content": "Some stuff."},
1855
        {
1856
            "role": "user",
1857
1858
            "content": "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>"
            "\nAnd what's in the video?\n<|vision_start|><|VIDEO|><|vision_end|>",
1859
1860
1861
1862
        },
    ]

    _assert_mm_data_inputs(mm_data, {"image": 2, "video": 1, "audio": 1})
1863
1864
1865
1866
1867
    _assert_mm_uuids(
        mm_uuids, 2, modality="image", expected_uuids=["image_123", "image_123"]
    )
    _assert_mm_uuids(mm_uuids, 1, modality="video", expected_uuids=["video_123"])
    _assert_mm_uuids(mm_uuids, 1, modality="audio", expected_uuids=["audio_123"])
1868
1869


1870
1871
1872
1873
1874
1875
1876
1877
1878
def test_parse_chat_messages_multiple_modals_with_uuids_multiple_empty_media_messages_interleave(  # noqa: E501
    qwen25omni_model_config_mm_interleaved,
    image_url,
    video_url,
    audio_url,
):
    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
1879
                "role": "user",
1880
                "content": [
1881
                    {"type": "text", "text": "What's on this image?"},
1882
1883
1884
1885
1886
                    {
                        "type": "image_url",
                        "image_url": None,
                        "uuid": "image_123",
                    },
1887
                    {"type": "text", "text": "Now listen to this audio"},
1888
1889
1890
1891
1892
1893
1894
                    {
                        "type": "audio_url",
                        "audio_url": None,
                        "uuid": "audio_123",
                    },
                ],
            },
1895
            {"role": "assistant", "content": "Some stuff."},
1896
            {
1897
                "role": "user",
1898
                "content": [
1899
                    {"type": "text", "text": "What's on this image?"},
1900
1901
1902
1903
1904
                    {
                        "type": "image_url",
                        "image_url": None,
                        "uuid": "image_123",
                    },
1905
                    {"type": "text", "text": "And what's in the video?"},
1906
1907
1908
1909
1910
1911
1912
1913
                    {
                        "type": "video_url",
                        "video_url": None,
                        "uuid": "video_123",
                    },
                ],
            },
        ],
1914
        qwen25omni_model_config_mm_interleaved,
1915
1916
1917
1918
1919
        content_format="string",
    )

    assert conversation == [
        {
1920
            "role": "user",
1921
1922
            "content": "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>"
            "\nNow listen to this audio\nAudio 1: <|audio_bos|><|AUDIO|><|audio_eos|>",
1923
        },
1924
        {"role": "assistant", "content": "Some stuff."},
1925
        {
1926
            "role": "user",
1927
1928
            "content": "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>"
            "\nAnd what's in the video?\n<|vision_start|><|VIDEO|><|vision_end|>",
1929
1930
1931
        },
    ]

1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
    _assert_mm_data_inputs(
        mm_data,
        {"image": 2, "video": 1, "audio": 1},
        skipped_media_indices={"image": [0, 1], "video": [0], "audio": [0]},
    )
    _assert_mm_uuids(
        mm_uuids, 2, modality="image", expected_uuids=["image_123", "image_123"]
    )
    _assert_mm_uuids(mm_uuids, 1, modality="video", expected_uuids=["video_123"])
    _assert_mm_uuids(mm_uuids, 1, modality="audio", expected_uuids=["audio_123"])
1942
1943


1944
1945
1946
1947
1948
1949
1950
1951
1952
def test_parse_chat_messages_multiple_modals_with_partial_uuids_multiple_messages_interleave(  # noqa: E501
    qwen25omni_model_config_mm_interleaved,
    image_url,
    video_url,
    audio_url,
):
    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
1953
                "role": "user",
1954
                "content": [
1955
                    {"type": "text", "text": "What's on this image?"},
1956
1957
                    {
                        "type": "image_url",
1958
                        "image_url": {"url": image_url},
1959
1960
                        "uuid": "image_123",
                    },
1961
1962
                    {"type": "text", "text": "Now listen to this audio"},
                    {"type": "audio_url", "audio_url": {"url": audio_url}},
1963
1964
                ],
            },
1965
            {"role": "assistant", "content": "Some stuff."},
1966
            {
1967
                "role": "user",
1968
                "content": [
1969
1970
1971
                    {"type": "text", "text": "What's on this image?"},
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "text", "text": "And what's in the video?"},
1972
1973
                    {
                        "type": "video_url",
1974
                        "video_url": {"url": video_url},
1975
1976
1977
1978
1979
                        "uuid": "video_123",
                    },
                ],
            },
        ],
1980
        qwen25omni_model_config_mm_interleaved,
1981
1982
1983
1984
1985
        content_format="string",
    )

    assert conversation == [
        {
1986
            "role": "user",
1987
1988
            "content": "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>"
            "\nNow listen to this audio\nAudio 1: <|audio_bos|><|AUDIO|><|audio_eos|>",
1989
        },
1990
        {"role": "assistant", "content": "Some stuff."},
1991
        {
1992
            "role": "user",
1993
1994
            "content": "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>"
            "\nAnd what's in the video?\n<|vision_start|><|VIDEO|><|vision_end|>",
1995
1996
1997
1998
        },
    ]

    _assert_mm_data_inputs(mm_data, {"image": 2, "video": 1, "audio": 1})
1999
2000
    _assert_mm_uuids(mm_uuids, 2, modality="image", expected_uuids=["image_123", None])
    _assert_mm_uuids(mm_uuids, 1, modality="video", expected_uuids=["video_123"])
2001
    _assert_mm_uuids(mm_uuids, 1, modality="audio", expected_uuids=[None])
2002
2003
2004
2005
2006
2007
2008


def test_parse_chat_messages_multiple_images_interleave_with_placeholders(
    phi3v_model_config_mm_interleaved,
    image_url,
):
    with pytest.raises(
2009
2010
2011
        ValueError,
        match=r"Found more '<|image_1|>' placeholders in input prompt "
        "than actual multimodal data items.",
2012
    ):
2013
        parse_chat_messages(
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
            [
                {
                    "role": "user",
                    "content": [
                        {"type": "image_url", "image_url": {"url": image_url}},
                        {"type": "image_url", "image_url": {"url": image_url}},
                        {
                            "type": "text",
                            "text": "I need you to compare this image\n<|image_1|>\nand this one\n<|image_2|>\n"  # noqa: E501
                            "Do they have differences?",
                        },
                    ],
                }
            ],
2028
            phi3v_model_config_mm_interleaved,
2029
2030
2031
2032
            content_format="string",
        )


2033
2034
2035
2036
2037
@pytest.mark.parametrize(
    "model",
    [
        QWEN2VL_MODEL_ID,  # tokenizer.chat_template is of type str
        HERMES_MODEL_ID,  # tokenizer.chat_template is of type dict
2038
2039
    ],
)
2040
2041
2042
@pytest.mark.parametrize("use_tools", [True, False])
def test_resolve_hf_chat_template(sample_json_schema, model, use_tools):
    """checks that chat_template is a dict type for HF models."""
2043
2044
2045
    model_info = HF_EXAMPLE_MODELS.find_hf_info(model)
    model_info.check_available_online(on_fail="skip")

2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
    model_config = ModelConfig(
        model,
        tokenizer=model_info.tokenizer or model,
        tokenizer_mode=model_info.tokenizer_mode,
        revision=model_info.revision,
        trust_remote_code=model_info.trust_remote_code,
        hf_overrides=model_info.hf_overrides,
        skip_tokenizer_init=model_info.require_embed_inputs,
        enable_prompt_embeds=model_info.require_embed_inputs,
        enable_mm_embeds=model_info.require_embed_inputs,
        enforce_eager=model_info.enforce_eager,
        dtype=model_info.dtype,
    )

    # Build the tokenizer
2061
    tokenizer = get_tokenizer(
2062
2063
        model,
        trust_remote_code=model_config.trust_remote_code,
2064
2065
    )

2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
    tools = (
        [
            {
                "type": "function",
                "function": {
                    "name": "dummy_function_name",
                    "description": "This is a dummy function",
                    "parameters": sample_json_schema,
                },
            }
        ]
        if use_tools
        else None
    )
2080
2081

    # Test detecting the tokenizer's chat_template
2082
    chat_template = resolve_hf_chat_template(
2083
2084
2085
        tokenizer,
        chat_template=None,
        tools=tools,
2086
        model_config=model_config,
2087
2088
2089
2090
    )
    assert isinstance(chat_template, str)


2091
2092
2093
2094
2095
2096
@pytest.mark.parametrize(
    "model, expected_kwargs",
    [
        (
            QWEN2VL_MODEL_ID,
            {
2097
2098
2099
2100
                "add_vision_id",
                "add_generation_prompt",
                "continue_final_message",
                "tools",
2101
2102
2103
2104
2105
            },
        ),
        (
            QWEN3_MODEL_ID,
            {
2106
2107
2108
2109
                "enable_thinking",
                "add_generation_prompt",
                "continue_final_message",
                "tools",
2110
2111
2112
2113
            },
        ),
    ],
)
2114
def test_resolve_hf_chat_template_kwargs(sample_json_schema, model, expected_kwargs):
2115
2116
2117
2118
    """checks that chat_template is a dict type for HF models."""
    model_info = HF_EXAMPLE_MODELS.find_hf_info(model)
    model_info.check_available_online(on_fail="skip")

2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
    tools = [
        {
            "type": "function",
            "function": {
                "name": "dummy_function_name",
                "description": "This is a dummy function",
                "parameters": sample_json_schema,
            },
        }
    ]
2129
2130
2131
2132
2133
2134
2135

    chat_template_kwargs = {
        # both unused
        "unsed_kwargs_1": 123,
        "unsed_kwargs_2": "abc",
        # should not appear
        "chat_template": "{% Hello world! %}",
2136
        "tokenize": True,
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
        # used by tokenizer
        "continue_final_message": True,
        "tools": tools,
        # both used by Qwen2-VL and Qwen3
        "add_generation_prompt": True,
        # only used by Qwen2-VL
        "add_vision_id": True,
        # only used by Qwen3
        "enable_thinking": True,
    }

2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
    model_config = ModelConfig(
        model,
        tokenizer=model_info.tokenizer or model,
        tokenizer_mode=model_info.tokenizer_mode,
        revision=model_info.revision,
        trust_remote_code=model_info.trust_remote_code,
        hf_overrides=model_info.hf_overrides,
        skip_tokenizer_init=model_info.require_embed_inputs,
        enable_prompt_embeds=model_info.require_embed_inputs,
        enable_mm_embeds=model_info.require_embed_inputs,
        enforce_eager=model_info.enforce_eager,
        dtype=model_info.dtype,
    )

    # Build the tokenizer
2163
    tokenizer = get_tokenizer(
2164
2165
        model,
        trust_remote_code=model_config.trust_remote_code,
2166
2167
2168
2169
2170
2171
2172
    )

    # Test detecting the tokenizer's chat_template
    chat_template = resolve_hf_chat_template(
        tokenizer,
        chat_template=None,
        tools=tools,
2173
        model_config=model_config,
2174
    )
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
    with pytest.raises(
        ValueError, match="Found unexpected chat template kwargs from request"
    ):
        # should raise error if `chat_template_kwargs` contains
        # `chat_template` or `tokenize`
        resolve_chat_template_kwargs(
            tokenizer,
            chat_template=chat_template,
            chat_template_kwargs=chat_template_kwargs,
        )
2185
2186
2187
2188
    resolved_chat_template_kwargs = resolve_chat_template_kwargs(
        tokenizer,
        chat_template=chat_template,
        chat_template_kwargs=chat_template_kwargs,
2189
        raise_on_unexpected=False,
2190
2191
2192
    )
    assert set(resolved_chat_template_kwargs.keys()) == expected_kwargs

2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
    # Additional test: Verify HF base parameters work with **kwargs tokenizers
    # This validates the fix for tokenizers like Kimi K2 that use **kwargs
    # to receive standard HuggingFace parameters instead of declaring them explicitly
    from vllm.entrypoints.chat_utils import _get_hf_base_chat_template_params

    hf_base_params = _get_hf_base_chat_template_params()
    # Verify common HF parameters are in the base class
    assert {"add_generation_prompt", "tools", "continue_final_message"}.issubset(
        hf_base_params
    ), f"Expected HF base params not found in {hf_base_params}"

    # Test with a mock tokenizer that uses **kwargs (like Kimi K2)
    class MockTokenizerWithKwargs:
        def apply_chat_template(self, conversation, **kwargs):
            return "mocked_output"

    mock_tokenizer = MockTokenizerWithKwargs()
    mock_kwargs = {
        "add_generation_prompt": True,
        "tools": tools,
        "continue_final_message": False,
        "unknown_param": "should_be_filtered",
    }
    resolved_mock = resolve_chat_template_kwargs(
        mock_tokenizer, chat_template, mock_kwargs, raise_on_unexpected=False
    )
    # HF base params should pass through even with **kwargs tokenizer
    assert "add_generation_prompt" in resolved_mock
    assert "tools" in resolved_mock
    assert "continue_final_message" in resolved_mock
    # Unknown params should be filtered out
    assert "unknown_param" not in resolved_mock

2226

2227
2228
# NOTE: Qwen2-Audio default chat template is specially defined inside
# processor class instead of using `tokenizer_config.json`
2229
2230
@pytest.mark.parametrize(
    ("model", "expected_format"),
2231
2232
2233
2234
2235
2236
2237
2238
    [
        (PHI3V_MODEL_ID, "string"),
        (QWEN2VL_MODEL_ID, "openai"),
        (QWEN25VL_MODEL_ID, "openai"),
        (ULTRAVOX_MODEL_ID, "string"),
        (QWEN2AUDIO_MODEL_ID, "openai"),
        (LLAMA_GUARD_MODEL_ID, "openai"),
    ],
2239
2240
)
def test_resolve_content_format_hf_defined(model, expected_format):
2241
2242
2243
    model_info = HF_EXAMPLE_MODELS.find_hf_info(model)
    model_info.check_available_online(on_fail="skip")

2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
    model_config = ModelConfig(
        model,
        tokenizer=model_info.tokenizer or model,
        tokenizer_mode=model_info.tokenizer_mode,
        revision=model_info.revision,
        trust_remote_code=model_info.trust_remote_code,
        hf_overrides=model_info.hf_overrides,
        skip_tokenizer_init=model_info.require_embed_inputs,
        enable_prompt_embeds=model_info.require_embed_inputs,
        enable_mm_embeds=model_info.require_embed_inputs,
        enforce_eager=model_info.enforce_eager,
        dtype=model_info.dtype,
    )
2257

2258
    tokenizer = get_tokenizer(
2259
2260
        model,
        trust_remote_code=model_config.trust_remote_code,
2261
2262
    )

2263
    # Test detecting the tokenizer's chat_template
2264
    chat_template = resolve_hf_chat_template(
2265
2266
2267
        tokenizer,
        chat_template=None,
        tools=None,
2268
        model_config=model_config,
2269
    )
2270
2271
2272
2273
2274
2275
2276
2277
    assert isinstance(chat_template, str)

    print("[TEXT]")
    print(chat_template)
    print("[AST]")
    print(_try_extract_ast(chat_template))

    resolved_format = resolve_chat_template_content_format(
2278
2279
2280
2281
        None,  # Test detecting the tokenizer's chat_template
        None,
        "auto",
        tokenizer,
2282
        model_config=model_config,
2283
2284
2285
2286
2287
2288
2289
    )

    assert resolved_format == expected_format


@pytest.mark.parametrize(
    ("model", "expected_format"),
2290
2291
2292
2293
2294
2295
2296
2297
2298
    [
        ("Salesforce/blip2-opt-2.7b", "string"),
        ("facebook/chameleon-7b", "string"),
        ("deepseek-ai/deepseek-vl2-tiny", "string"),
        ("adept/fuyu-8b", "string"),
        ("google/paligemma-3b-mix-224", "string"),
        ("Qwen/Qwen-VL", "string"),
        ("Qwen/Qwen-VL-Chat", "string"),
    ],
2299
2300
2301
2302
2303
)
def test_resolve_content_format_fallbacks(model, expected_format):
    model_info = HF_EXAMPLE_MODELS.find_hf_info(model)
    model_info.check_available_online(on_fail="skip")

2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
    model_config = ModelConfig(
        model,
        tokenizer=model_info.tokenizer or model,
        tokenizer_mode=model_info.tokenizer_mode,
        revision=model_info.revision,
        trust_remote_code=model_info.trust_remote_code,
        hf_overrides=model_info.hf_overrides,
        skip_tokenizer_init=model_info.require_embed_inputs,
        enable_prompt_embeds=model_info.require_embed_inputs,
        enable_mm_embeds=model_info.require_embed_inputs,
        enforce_eager=model_info.enforce_eager,
        dtype=model_info.dtype,
    )
2317

2318
    tokenizer = get_tokenizer(
2319
2320
        model_config.tokenizer,
        trust_remote_code=model_config.trust_remote_code,
2321
2322
2323
2324
2325
2326
2327
    )

    # Test detecting the tokenizer's chat_template
    chat_template = resolve_hf_chat_template(
        tokenizer,
        chat_template=None,
        tools=None,
2328
        model_config=model_config,
2329
2330
2331
2332
2333
2334
2335
2336
2337
    )
    assert isinstance(chat_template, str)

    print("[TEXT]")
    print(chat_template)
    print("[AST]")
    print(_try_extract_ast(chat_template))

    resolved_format = resolve_chat_template_content_format(
2338
        None,  # Test detecting the tokenizer's chat_template
2339
        None,
2340
2341
        "auto",
        tokenizer,
2342
        model_config=model_config,
2343
2344
2345
2346
2347
2348
2349
    )

    assert resolved_format == expected_format


@pytest.mark.parametrize(
    ("template_path", "expected_format"),
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
    [
        ("template_alpaca.jinja", "string"),
        ("template_baichuan.jinja", "string"),
        ("template_chatglm.jinja", "string"),
        ("template_chatglm2.jinja", "string"),
        ("template_chatml.jinja", "string"),
        ("template_dse_qwen2_vl.jinja", "openai"),
        ("template_falcon_180b.jinja", "string"),
        ("template_falcon.jinja", "string"),
        ("template_inkbot.jinja", "string"),
        ("template_teleflm.jinja", "string"),
        ("template_vlm2vec_phi3v.jinja", "openai"),
        ("template_vlm2vec_qwen2vl.jinja", "openai"),
        ("tool_chat_template_granite_20b_fc.jinja", "string"),
        ("tool_chat_template_hermes.jinja", "string"),
        ("tool_chat_template_internlm2_tool.jinja", "string"),
        ("tool_chat_template_llama3.1_json.jinja", "openai"),
        ("tool_chat_template_llama3.2_json.jinja", "openai"),
        ("tool_chat_template_mistral_parallel.jinja", "string"),
        ("tool_chat_template_mistral.jinja", "string"),
    ],
2371
2372
)
def test_resolve_content_format_examples(template_path, expected_format):
2373
2374
2375
2376
2377
    model_config = ModelConfig(
        PHI3V_MODEL_ID,  # Dummy
        tokenizer=PHI3V_MODEL_ID,  # Dummy
        trust_remote_code=True,
    )
2378

2379
    dummy_tokenizer = get_tokenizer(
2380
2381
        PHI3V_MODEL_ID,  # Dummy
        trust_remote_code=model_config.trust_remote_code,
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
    )
    dummy_tokenizer.chat_template = None

    chat_template = load_chat_template(EXAMPLES_DIR / template_path)
    assert isinstance(chat_template, str)

    print("[TEXT]")
    print(chat_template)
    print("[AST]")
    print(_try_extract_ast(chat_template))

    resolved_format = resolve_chat_template_content_format(
        chat_template,
2395
        None,
2396
2397
        "auto",
        dummy_tokenizer,
2398
        model_config=model_config,
2399
2400
2401
    )

    assert resolved_format == expected_format
Julien Denize's avatar
Julien Denize committed
2402
2403


2404
def test_parse_chat_messages_include_thinking_chunk(mistral_model_config):
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
    messages = [
        {
            "role": "system",
            "content": [
                {"type": "text", "text": "You are a helpful assistant."},
                {
                    "type": "thinking",
                    "closed": True,
                    "thinking": "Only return the answer when you are confident.",
                },
            ],
        },
        {"role": "user", "content": "What is 2+2?"},
        {
            "role": "assistant",
            "content": [
                {"type": "text", "text": "Let me think about it."},
                {"type": "thinking", "closed": True, "thinking": "2+2 = 4"},
                {
                    "type": "text",
                    "text": "The answer is 4.",
                },
            ],
        },
    ]
Julien Denize's avatar
Julien Denize committed
2430

2431
    conversation_with_thinking, _, _ = parse_chat_messages(
Julien Denize's avatar
Julien Denize committed
2432
        messages,
2433
        mistral_model_config,
Julien Denize's avatar
Julien Denize committed
2434
2435
2436
        content_format="openai",
    )

2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
    expected_conversation = [
        {
            "role": "system",
            "content": [
                {"type": "text", "text": "You are a helpful assistant."},
                {
                    "type": "text",
                    "text": "Only return the answer when you are confident.",
                },
            ],
        },
        {
            "role": "user",
            "content": [{"type": "text", "text": "What is 2+2?"}],
        },
        {
            "role": "assistant",
            "content": [
                {"type": "text", "text": "Let me think about it."},
                {"type": "text", "text": "2+2 = 4"},
                {"type": "text", "text": "The answer is 4."},
            ],
        },
    ]
Julien Denize's avatar
Julien Denize committed
2461
2462
2463
2464
2465

    assert conversation_with_thinking == expected_conversation


def test_apply_mistral_chat_template_thinking_chunk():
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
    messages = [
        {
            "role": "system",
            "content": [
                {"type": "text", "text": "You are a helpful assistant."},
                {
                    "type": "thinking",
                    "closed": True,
                    "thinking": "Only return the answer when you are confident.",
                },
            ],
        },
        {"role": "user", "content": "What is 2+2?"},
        {
            "role": "assistant",
            "content": [
                {"type": "text", "text": "Let me think about it."},
                {"type": "thinking", "closed": True, "thinking": "2+2 = 4"},
                {
                    "type": "text",
                    "text": "The answer is 4.",
                },
            ],
        },
        {"role": "user", "content": "Thanks, what is 3+3?"},
    ]
Julien Denize's avatar
Julien Denize committed
2492
    mistral_tokenizer = MistralTokenizer.from_pretrained(
2493
        "mistralai/Magistral-Small-2509"
2494
    )
Julien Denize's avatar
Julien Denize committed
2495

2496
2497
2498
    tokens_ids = apply_mistral_chat_template(
        mistral_tokenizer, messages, chat_template=None, tools=None
    )
Julien Denize's avatar
Julien Denize committed
2499
2500

    string_tokens = mistral_tokenizer.mistral.decode(
2501
2502
        tokens_ids, special_token_policy=SpecialTokenPolicy.KEEP
    )
Julien Denize's avatar
Julien Denize committed
2503
2504
2505
2506
2507
2508

    expected_tokens = (
        r"<s>[SYSTEM_PROMPT]You are a helpful assistant.[THINK]Only return the"
        r" answer when you are confident.[/THINK][/SYSTEM_PROMPT]"
        r"[INST]What is 2+2?[/INST]"
        r"Let me think about it.[THINK]2+2 = 4[/THINK]The answer is 4.</s>"
2509
2510
        r"[INST]Thanks, what is 3+3?[/INST]"
    )
Julien Denize's avatar
Julien Denize committed
2511
2512

    assert string_tokens == expected_tokens
2513
2514
2515
2516
2517
2518
2519


def test_parse_chat_messages_single_empty_audio_with_uuid(
    qwen2_audio_model_config,
):
    audio_uuid = "abcd"
    conversation, mm_data, mm_uuids = parse_chat_messages(
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "input_audio",
                        "input_audio": {},
                        "uuid": audio_uuid,
                    },
                    {"type": "text", "text": "What does the audio say?"},
                ],
            }
        ],
2533
        qwen2_audio_model_config,
2534
2535
2536
        content_format="string",
    )

2537
2538
2539
    assert conversation == [
        {
            "role": "user",
2540
2541
            "content": "Audio 1: <|audio_bos|><|AUDIO|><|audio_eos|>\nWhat does the "
            "audio say?",
2542
2543
        }
    ]
2544
    _assert_mm_data_inputs(mm_data, {"audio": 1})
2545
    _assert_mm_uuids(mm_uuids, 1, modality="audio", expected_uuids=[audio_uuid])
2546
2547
2548
2549
2550
2551
2552
2553


@pytest.mark.asyncio
async def test_parse_chat_messages_single_empty_audio_with_uuid_async(
    qwen2_audio_model_config,
):
    audio_uuid = "abcd"
    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "input_audio",
                        "input_audio": {},
                        "uuid": audio_uuid,
                    },
                    {"type": "text", "text": "What does the audio say?"},
                ],
            }
        ],
2567
        qwen2_audio_model_config,
2568
2569
2570
        content_format="string",
    )

2571
2572
2573
    assert conversation == [
        {
            "role": "user",
2574
2575
            "content": "Audio 1: <|audio_bos|><|AUDIO|><|audio_eos|>\nWhat does the "
            "audio say?",
2576
2577
        }
    ]
2578
    _assert_mm_data_inputs(await mm_future, {"audio": 1})
2579
    _assert_mm_uuids(mm_uuids, 1, modality="audio", expected_uuids=[audio_uuid])