test_chat_utils.py 73.7 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
from mistral_common.tokens.tokenizers.base import SpecialTokenPolicy
10

11
from vllm.assets.audio import AudioAsset
12
from vllm.assets.image import ImageAsset
13
from vllm.assets.video import VideoAsset
14
from vllm.config import ModelConfig
15
16
from vllm.entrypoints.chat_utils import (
    _try_extract_ast,
17
    apply_mistral_chat_template,
18
19
20
21
22
23
24
    load_chat_template,
    parse_chat_messages,
    parse_chat_messages_futures,
    resolve_chat_template_content_format,
    resolve_chat_template_kwargs,
    resolve_hf_chat_template,
)
25
from vllm.multimodal import MultiModalDataDict, MultiModalUUIDDict
26
27
28
29
30
from vllm.multimodal.utils import (
    encode_audio_base64,
    encode_image_base64,
    encode_video_base64,
)
31
from vllm.tokenizers import MistralTokenizer
32
from vllm.transformers_utils.tokenizer import get_tokenizer
33

34
from ..models.registry import HF_EXAMPLE_MODELS
35
36
37
38
from ..utils import VLLM_PATH

EXAMPLES_DIR = VLLM_PATH / "examples"

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


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


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


76
77
78
79
80
81
82
83
84
85
86
87
88
@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,
    )


89
90
@pytest.fixture(scope="module")
def phi3v_tokenizer():
91
    return get_tokenizer(PHI3V_MODEL_ID)
92
93


94
95
96
97
98
99
100
101
102
103
104
105
@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,
        },
    )


106
107
108
109
110
111
112
113
114
115
116
117
118
@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,
    )


119
120
@pytest.fixture(scope="module")
def qwen2_audio_tokenizer():
121
    return get_tokenizer(QWEN2AUDIO_MODEL_ID)
122
123


124
125
@pytest.fixture(scope="function")
def qwen25omni_model_config_mm_interleaved():
126
127
128
129
130
131
132
133
134
135
    return ModelConfig(
        QWEN25OMNI_MODEL_ID,
        runner="generate",
        interleave_mm_strings=True,
        limit_mm_per_prompt={
            "image": 2,
            "audio": 1,
            "video": 1,
        },
    )
136
137
138
139


@pytest.fixture(scope="module")
def qwen25omni_tokenizer():
140
    return get_tokenizer(QWEN25OMNI_MODEL_ID)
141
142


143
144
@pytest.fixture(scope="function")
def mistral_model_config():
145
146
147
148
149
150
151
    return ModelConfig(
        MISTRAL_MODEL_ID,
        runner="generate",
        limit_mm_per_prompt={
            "image": 2,
        },
    )
152
153
154
155


@pytest.fixture(scope="module")
def mistral_tokenizer():
156
    return get_tokenizer(MISTRAL_MODEL_ID)
157
158


159
160
@pytest.fixture(scope="module")
def image_url():
161
    image = ImageAsset("cherry_blossom")
162
163
164
165
    base64 = encode_image_base64(image.pil_image)
    return f"data:image/jpeg;base64,{base64}"


166
167
@pytest.fixture(scope="module")
def video_url():
168
    video = VideoAsset("baby_reading", 1)
169
170
171
172
173
174
    base64 = encode_video_base64(video.np_ndarrays)
    return f"data:video/jpeg;base64,{base64}"


@pytest.fixture(scope="module")
def audio_url():
175
    audio = AudioAsset("mary_had_lamb")
176
177
178
179
    base64 = encode_audio_base64(*audio.audio_and_sample_rate)
    return f"data:audio/ogg;base64,{base64}"


180
def _assert_mm_data_is_image_input(
181
    mm_data: MultiModalDataDict | None,
182
    image_count: int,
183
    skipped_image_indices: list | None = None,
184
185
186
187
188
189
190
) -> 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

191
    assert isinstance(image_data, list) and len(image_data) == image_count
192
193
194
    if skipped_image_indices is not None:
        for i in skipped_image_indices:
            assert image_data[i] is None
195
196


197
def _assert_mm_uuids(
198
    mm_uuids: MultiModalUUIDDict | None,
199
    media_count: int,
200
    expected_uuids: list[str | None],
201
202
203
204
205
206
207
208
209
    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

210
        assert isinstance(image_uuids, list) and len(image_uuids) == media_count
211
212
213
214
215
216

        assert image_uuids == expected_uuids
    else:
        assert mm_uuids is None


217
218
219
220
221
ModalityType = Literal["image", "video", "audio"]
MultiModalDataCounts = Mapping[ModalityType, int]


def _assert_mm_data_inputs(
222
    mm_data: MultiModalDataDict | None,
223
    data_count: MultiModalDataCounts,
224
    skipped_media_indices: dict[str, list] | None = None,  # modality -> list[int]
225
226
227
228
229
230
231
232
233
) -> 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

234
        if skipped_media_indices is not None:
235
            skipped_media_indices_for_modality = skipped_media_indices.get(modality)
236
237
238
239
            assert skipped_media_indices_for_modality is not None
            for i in skipped_media_indices_for_modality:
                assert modality_data[i] is None

240

241
242
243
244
245
def test_parse_chat_messages_single_image(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
246
    conversation, mm_data, mm_uuids = parse_chat_messages(
247
248
249
250
251
252
253
254
255
        [
            {
                "role": "user",
                "content": [
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "text", "text": "What's in the image?"},
                ],
            }
        ],
256
257
258
259
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
260

261
262
263
    assert conversation == [
        {"role": "user", "content": "<|image_1|>\nWhat's in the image?"}
    ]
264
    _assert_mm_data_is_image_input(mm_data, 1)
265
266
267
268
269
270
271
272
273
274
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[None])


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

295
296
297
    assert conversation == [
        {"role": "user", "content": "<|image_1|>\nWhat's in the image?"}
    ]
298
299
300
301
    _assert_mm_data_is_image_input(mm_data, 1)
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[image_uuid])


302
303
304
305
306
307
308
def test_parse_chat_messages_single_empty_image_with_uuid(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
    image_uuid = str(hash(image_url))
    conversation, mm_data, mm_uuids = parse_chat_messages(
309
310
311
312
313
314
315
316
317
318
319
320
321
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": None,
                        "uuid": image_uuid,
                    },
                    {"type": "text", "text": "What's in the image?"},
                ],
            }
        ],
322
323
324
325
326
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )

327
328
329
    assert conversation == [
        {"role": "user", "content": "<|image_1|>\nWhat's in the image?"}
    ]
330
331
332
333
    _assert_mm_data_is_image_input(mm_data, 1, skipped_image_indices=[0])
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[image_uuid])


334
335
336
337
338
339
340
def test_parse_chat_messages_single_image_with_bad_uuid_format(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
    image_uuid = str(hash(image_url))
    conversation, mm_data, mm_uuids = parse_chat_messages(
341
342
343
344
345
346
347
348
349
350
351
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url,
                            "uuid": image_uuid,
                        },
                        "bad_uuid_key": image_uuid,
352
                    },
353
354
355
356
                    {"type": "text", "text": "What's in the image?"},
                ],
            }
        ],
357
358
359
360
361
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )

362
363
364
    assert conversation == [
        {"role": "user", "content": "<|image_1|>\nWhat's in the image?"}
    ]
365
366
367
368
369
370
371
372
373
374
375
376
377
    _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,
    phi3v_tokenizer,
    image_url,
):
    image_uuid1 = "my_uuid_1"
    image_uuid2 = "my_uuid_2"

    conversation, mm_data, mm_uuids = parse_chat_messages(
378
379
380
381
382
383
384
385
386
387
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url,
                        },
                        "uuid": image_uuid1,
388
                    },
389
390
391
392
393
394
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url,
                        },
                        "uuid": image_uuid2,
395
                    },
396
397
398
399
                    {"type": "text", "text": "What's in the image?"},
                ],
            }
        ],
400
401
402
403
404
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )

405
406
407
408
409
410
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nWhat's in the image?",
        }
    ]
411
412
413
414
    _assert_mm_data_is_image_input(mm_data, 2)
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[image_uuid1, image_uuid2])


415
416
417
418
419
420
421
422
423
def test_parse_chat_messages_multiple_empty_images_with_uuids(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
    image_uuid1 = "my_uuid_1"
    image_uuid2 = "my_uuid_2"

    conversation, mm_data, mm_uuids = parse_chat_messages(
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
        [
            {
                "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?"},
                ],
            }
        ],
442
443
444
445
446
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )

447
448
449
450
451
452
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nWhat's in the image?",
        }
    ]
453
454
455
456
457
458
459
460
461
462
463
464
465
    _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,
    phi3v_tokenizer,
    image_url,
):
    image_uuid1 = "my_uuid_1"
    image_uuid2 = "my_uuid_2"

    conversation, mm_data, mm_uuids = parse_chat_messages(
466
467
468
469
470
471
472
473
474
475
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url,
                        },
                        "uuid": image_uuid1,
476
                    },
477
478
479
480
481
482
483
484
485
                    {
                        "type": "image_url",
                        "image_url": None,
                        "uuid": image_uuid2,
                    },
                    {"type": "text", "text": "What's in the image?"},
                ],
            }
        ],
486
487
488
489
490
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )

491
492
493
494
495
496
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nWhat's in the image?",
        }
    ]
497
498
499
500
    _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])


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

527
528
529
    assert conversation == [
        {"role": "user", "content": "<|image_1|>\nWhat's in the image?"}
    ]
530
531
532
533
    _assert_mm_data_is_image_input(await mm_future, 1)
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[image_uuid])


534
535
536
537
538
539
540
541
@pytest.mark.asyncio
async def test_parse_chat_messages_empty_image_with_uuid_async(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
    image_uuid = str(hash(image_url))
    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
542
543
544
545
546
547
548
549
550
551
552
553
554
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": None,
                        "uuid": image_uuid,
                    },
                    {"type": "text", "text": "What's in the image?"},
                ],
            }
        ],
555
556
557
558
559
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )

560
561
562
563
    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])
564
565
566
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[image_uuid])


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

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

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


610
611
612
613
614
615
616
617
618
619
@pytest.mark.asyncio
async def test_parse_chat_messages_multiple_empty_images_with_uuids_async(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
    image_uuid1 = "my_uuid_1"
    image_uuid2 = "my_uuid_2"

    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
        [
            {
                "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?"},
                ],
            }
        ],
638
639
640
641
642
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )

643
644
645
646
647
648
649
    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])
650
651
652
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[image_uuid1, image_uuid2])


653
654
655
656
657
658
659
660
661
@pytest.mark.asyncio
async def test_parse_chat_messages_multiple_images_with_partial_uuids_async(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
    image_uuid2 = "my_uuid_2"

    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
662
663
664
665
666
667
668
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": {"url": image_url},
669
                    },
670
671
672
673
674
675
676
677
678
                    {
                        "type": "image_pil",
                        "image_pil": ImageAsset("cherry_blossom").pil_image,
                        "uuid": image_uuid2,
                    },
                    {"type": "text", "text": "What's in these images?"},
                ],
            }
        ],
679
680
681
682
683
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )

684
685
686
687
688
689
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nWhat's in these images?",
        }
    ]
690
691
    _assert_mm_data_is_image_input(await mm_future, 2)
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, image_uuid2])
692
693


694
695
696
697
698
def test_parse_chat_messages_empty_system(
    mistral_model_config,
    mistral_tokenizer,
):
    # Test string format
699
    conversation, _, _ = parse_chat_messages(
700
        [
701
            {"role": "system", "content": ""},
702
703
            {
                "role": "user",
704
                "content": [{"type": "text", "text": "Who are you?"}],
705
706
            },
        ],
707
708
709
710
        mistral_model_config,
        mistral_tokenizer,
        content_format="string",
    )
711
    assert conversation == [
712
713
        {"role": "system", "content": ""},
        {"role": "user", "content": "Who are you?"},
714
    ]
715
716

    # Test openai format
717
    conversation, _, _ = parse_chat_messages(
718
        [
719
            {"role": "system", "content": ""},
720
721
            {
                "role": "user",
722
                "content": [{"type": "text", "text": "Who are you?"}],
723
724
725
726
727
728
729
            },
        ],
        mistral_model_config,
        mistral_tokenizer,
        content_format="openai",
    )
    assert conversation == [
730
731
        {"role": "system", "content": [{"type": "text", "text": ""}]},
        {"role": "user", "content": [{"type": "text", "text": "Who are you?"}]},
732
    ]
733
734


735
@pytest.mark.asyncio
736
737
738
739
740
async def test_parse_chat_messages_single_image_async(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
741
    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
742
743
744
745
746
747
748
749
750
        [
            {
                "role": "user",
                "content": [
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "text", "text": "What's in the image?"},
                ],
            }
        ],
751
752
753
754
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
755

756
757
758
    assert conversation == [
        {"role": "user", "content": "<|image_1|>\nWhat's in the image?"}
    ]
759
    _assert_mm_data_is_image_input(await mm_future, 1)
760
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[None])
761
762
763
764
765
766
767


def test_parse_chat_messages_multiple_images(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
768
    conversation, mm_data, mm_uuids = parse_chat_messages(
769
770
771
772
773
774
775
776
777
778
779
780
781
        [
            {
                "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?"},
                ],
            }
        ],
782
783
784
785
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
786

787
788
789
790
791
792
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nWhat's in these images?",
        }
    ]
793
    _assert_mm_data_is_image_input(mm_data, 2)
794
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
795
796


797
798
799
800
801
802
def test_parse_chat_messages_empty_pil_image_with_uuid(
    phi3v_model_config,
    phi3v_tokenizer,
):
    uuid = "abcd"
    conversation, mm_data, mm_uuids = parse_chat_messages(
803
804
805
806
807
808
809
810
811
        [
            {
                "role": "user",
                "content": [
                    {"type": "image_pil", "image_pil": None, "uuid": uuid},
                    {"type": "text", "text": "What's in this image?"},
                ],
            }
        ],
812
813
814
815
816
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )

817
818
819
820
821
822
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\nWhat's in this image?",
        }
    ]
823
824
825
826
827
    _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(
828
    phi3v_model_config_image_embeds,
829
830
831
832
    phi3v_tokenizer,
):
    uuid = "abcd"
    conversation, mm_data, mm_uuids = parse_chat_messages(
833
834
835
836
837
838
839
840
841
        [
            {
                "role": "user",
                "content": [
                    {"type": "image_embeds", "image_embeds": None, "uuid": uuid},
                    {"type": "text", "text": "What's in this image?"},
                ],
            }
        ],
842
        phi3v_model_config_image_embeds,
843
844
845
846
        phi3v_tokenizer,
        content_format="string",
    )

847
848
849
850
851
852
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\nWhat's in this image?",
        }
    ]
853
854
855
856
857
858
    assert mm_data is not None
    assert "image" in mm_data
    assert mm_data["image"] is None
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[uuid])


859
860
861
862
863
864
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
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
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
def test_parse_chat_messages_empty_audio_embeds_with_uuid(
    audio_embeds_model_config,
    qwen2_audio_tokenizer,
):
    """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},
                ],
            }
        ],
        audio_embeds_model_config,
        qwen2_audio_tokenizer,
        content_format="string",
    )

    # Should have audio in mm_data as None (UUID provided)
    assert mm_data is not None
    assert "audio" in mm_data
    assert mm_data["audio"] is None
    # UUID should be recorded
    assert mm_uuids is not None
    assert "audio" in mm_uuids
    _assert_mm_uuids(mm_uuids, 1, modality="audio", expected_uuids=[uuid])


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

    import torch

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

    # Encode it as base64
    buffer = io.BytesIO()
    torch.save(audio_embedding, buffer)
    buffer.seek(0)
    binary_data = buffer.read()
    base64_audio_embedding = base64.b64encode(binary_data).decode("utf-8")

    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,
                    },
                ],
            }
        ],
        audio_embeds_model_config,
        qwen2_audio_tokenizer,
        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,
    qwen2_audio_tokenizer,
):
    """Test audio_embeds with async futures."""
    import base64
    import io

    import torch

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

    # Encode it as base64
    buffer = io.BytesIO()
    torch.save(audio_embedding, buffer)
    buffer.seek(0)
    binary_data = buffer.read()
    base64_audio_embedding = base64.b64encode(binary_data).decode("utf-8")

    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,
                    },
                ],
            }
        ],
        audio_embeds_model_config,
        qwen2_audio_tokenizer,
        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])


991
992
@pytest.mark.asyncio
async def test_parse_chat_messages_empty_image_embeds_with_uuid_async(
993
    phi3v_model_config_image_embeds,
994
995
996
997
    phi3v_tokenizer,
):
    uuid = "abcd"
    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
998
999
1000
1001
1002
1003
1004
1005
1006
        [
            {
                "role": "user",
                "content": [
                    {"type": "image_embeds", "image_embeds": None, "uuid": uuid},
                    {"type": "text", "text": "What's in this image?"},
                ],
            }
        ],
1007
        phi3v_model_config_image_embeds,
1008
1009
1010
1011
        phi3v_tokenizer,
        content_format="string",
    )

1012
1013
1014
1015
1016
1017
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\nWhat's in this image?",
        }
    ]
1018
1019
1020
1021
1022
1023
1024
    mm_data = await mm_future
    assert mm_data is not None
    assert "image" in mm_data
    assert mm_data["image"] is None
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[uuid])


1025
@pytest.mark.asyncio
1026
1027
1028
1029
1030
async def test_parse_chat_messages_multiple_images_async(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
1031
    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
        [
            {
                "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?"},
                ],
            }
        ],
1045
1046
1047
1048
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
1049

1050
1051
1052
1053
1054
1055
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nWhat's in these images?",
        }
    ]
1056
    _assert_mm_data_is_image_input(await mm_future, 2)
1057
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
1058
1059
1060
1061
1062
1063
1064


def test_parse_chat_messages_placeholder_already_in_prompt(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
1065
    conversation, mm_data, mm_uuids = parse_chat_messages(
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
        [
            {
                "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
                    },
                ],
            }
        ],
1079
1080
1081
1082
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
1083
1084
1085
1086
1087
1088
    assert conversation == [
        {
            "role": "user",
            "content": "What's in <|image_1|> and how does it compare to <|image_2|>?",
        }
    ]
1089
    _assert_mm_data_is_image_input(mm_data, 2)
1090
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
1091
1092


1093
1094
1095
1096
1097
def test_parse_chat_messages_placeholder_one_already_in_prompt(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
1098
    conversation, mm_data, mm_uuids = parse_chat_messages(
1099
1100
1101
1102
1103
1104
1105
1106
        [
            {
                "role": "user",
                "content": [
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {
                        "type": "text",
1107
1108
                        "text": "What's in <|image_1|> and how does it compare to "
                        "the other one?",
1109
1110
1111
1112
                    },
                ],
            }
        ],
1113
1114
1115
1116
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
1117

1118
1119
1120
    assert conversation == [
        {
            "role": "user",
1121
1122
            "content": "<|image_2|>\nWhat's in <|image_1|> and how does it compare to "
            "the other one?",
1123
1124
        }
    ]
1125
    _assert_mm_data_is_image_input(mm_data, 2)
1126
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
1127
1128


1129
1130
1131
1132
1133
def test_parse_chat_messages_multiple_images_across_messages(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
1134
    conversation, mm_data, mm_uuids = parse_chat_messages(
1135
1136
        [
            {
1137
                "role": "user",
1138
                "content": [
1139
1140
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "text", "text": "What's in this image?"},
1141
1142
                ],
            },
1143
            {"role": "assistant", "content": "Some stuff."},
1144
            {
1145
                "role": "user",
1146
                "content": [
1147
1148
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "text", "text": "What about this one?"},
1149
1150
1151
                ],
            },
        ],
1152
1153
1154
1155
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
1156
1157

    assert conversation == [
1158
1159
1160
        {"role": "user", "content": "<|image_1|>\nWhat's in this image?"},
        {"role": "assistant", "content": "Some stuff."},
        {"role": "user", "content": "<|image_2|>\nWhat about this one?"},
1161
    ]
1162
    _assert_mm_data_is_image_input(mm_data, 2)
1163
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
1164
1165


1166
def test_parse_chat_messages_multiple_images_with_uuids_across_messages(
1167
1168
    phi3v_model_config,
    phi3v_tokenizer,
1169
    image_url,
1170
):
1171
1172
    image_uuid = str(hash(image_url))
    conversation, mm_data, mm_uuids = parse_chat_messages(
1173
1174
        [
            {
1175
                "role": "user",
1176
1177
1178
                "content": [
                    {
                        "type": "image_url",
1179
                        "image_url": {"url": image_url},
1180
1181
                        "uuid": image_uuid,
                    },
1182
                    {"type": "text", "text": "What's in this image?"},
1183
                ],
1184
            },
1185
            {"role": "assistant", "content": "Some stuff."},
1186
            {
1187
                "role": "user",
1188
1189
1190
                "content": [
                    {
                        "type": "image_url",
1191
                        "image_url": {"url": image_url},
1192
1193
                        "uuid": image_uuid,
                    },
1194
                    {"type": "text", "text": "What about this one?"},
1195
1196
1197
1198
1199
1200
1201
1202
1203
                ],
            },
        ],
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )

    assert conversation == [
1204
1205
1206
        {"role": "user", "content": "<|image_1|>\nWhat's in this image?"},
        {"role": "assistant", "content": "Some stuff."},
        {"role": "user", "content": "<|image_2|>\nWhat about this one?"},
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
    ]
    _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,
    phi3v_tokenizer,
):
    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
                "role": "user",
1220
                "content": [{"type": "text", "text": "What's in this text?"}],
1221
            },
1222
1223
            {"role": "assistant", "content": "Some stuff."},
            {"role": "user", "content": "What about this one?"},
1224
        ],
1225
1226
1227
1228
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="openai",
    )
1229
1230
1231
1232

    assert conversation == [
        {
            "role": "user",
1233
            "content": [{"type": "text", "text": "What's in this text?"}],
1234
1235
1236
        },
        {
            "role": "assistant",
1237
            "content": [{"type": "text", "text": "Some stuff."}],
1238
1239
1240
        },
        {
            "role": "user",
1241
            "content": [{"type": "text", "text": "What about this one?"}],
1242
1243
        },
    ]
1244
1245
    assert mm_data is None
    assert mm_uuids is None
1246
1247


1248
1249
1250
1251
1252
def test_parse_chat_messages_rejects_too_many_images_in_one_message(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
1253
1254
1255
    with warnings.catch_warnings():
        warnings.filterwarnings(
            "ignore",
1256
1257
            message="coroutine 'async_get_and_parse_image' was never awaited",
        )
1258
        with pytest.raises(ValueError, match="At most"):
1259
            parse_chat_messages(
1260
1261
1262
1263
1264
1265
1266
                [
                    {
                        "role": "user",
                        "content": [
                            {
                                "type": "image_url",
                                "image_url": {"url": image_url},
1267
                            },
1268
1269
1270
                            {
                                "type": "image_url",
                                "image_url": {"url": image_url},
1271
                            },
1272
1273
1274
                            {
                                "type": "image_url",
                                "image_url": {"url": image_url},
1275
                            },
1276
1277
1278
1279
                            {"type": "text", "text": "What's in these images?"},
                        ],
                    }
                ],
1280
1281
1282
1283
                phi3v_model_config,
                phi3v_tokenizer,
                content_format="string",
            )
1284
1285


1286
1287
1288
1289
1290
def test_parse_chat_messages_rejects_too_many_images_across_messages(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
1291
1292
1293
    with warnings.catch_warnings():
        warnings.filterwarnings(
            "ignore",
1294
1295
            message="coroutine 'async_get_and_parse_image' was never awaited",
        )
1296
        with pytest.raises(ValueError, match="At most"):
1297
            parse_chat_messages(
1298
1299
                [
                    {
1300
                        "role": "user",
1301
1302
1303
                        "content": [
                            {
                                "type": "image_url",
1304
                                "image_url": {"url": image_url},
1305
                            },
1306
                            {"type": "text", "text": "What's in this image?"},
1307
1308
                        ],
                    },
1309
                    {"role": "assistant", "content": "Some stuff."},
1310
                    {
1311
                        "role": "user",
1312
1313
1314
                        "content": [
                            {
                                "type": "image_url",
1315
                                "image_url": {"url": image_url},
1316
1317
1318
                            },
                            {
                                "type": "image_url",
1319
                                "image_url": {"url": image_url},
1320
                            },
1321
                            {"type": "text", "text": "What about these two?"},
1322
1323
1324
                        ],
                    },
                ],
1325
1326
1327
1328
                phi3v_model_config,
                phi3v_tokenizer,
                content_format="string",
            )
1329
1330
1331
1332
1333
1334
1335


def test_parse_chat_messages_multiple_images_uncommon_input(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
1336
    conversation, mm_data, mm_uuids = parse_chat_messages(
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
        [
            {
                "role": "user",
                "content": [
                    "What's in these images?",
                    {"image_url": image_url},
                    {"image_url": image_url},
                ],
            }
        ],
1347
1348
1349
1350
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
1351

1352
1353
1354
1355
1356
1357
    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\n<|image_2|>\nWhat's in these images?",
        }
    ]
1358
    _assert_mm_data_is_image_input(mm_data, 2)
1359
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
1360
1361


1362
1363
1364
1365
1366
def test_parse_chat_messages_multiple_images_interleave(
    phi3v_model_config_mm_interleaved,
    phi3v_tokenizer,
    image_url,
):
1367
    conversation, mm_data, mm_uuids = parse_chat_messages(
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
        [
            {
                "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?"},
                ],
            }
        ],
1383
1384
1385
1386
1387
        phi3v_model_config_mm_interleaved,
        phi3v_tokenizer,
        content_format="string",
    )

1388
1389
1390
1391
1392
1393
1394
    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?",
        }
    ]
1395
    _assert_mm_data_is_image_input(mm_data, 2)
1396
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
1397
1398
1399
1400
1401
1402
1403
1404


@pytest.mark.asyncio
async def test_parse_chat_messages_multiple_images_interleave_async(
    phi3v_model_config_mm_interleaved,
    phi3v_tokenizer,
    image_url,
):
1405
    conversation, mm_data, mm_uuids = parse_chat_messages_futures(
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
        [
            {
                "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?"},
                ],
            }
        ],
1421
1422
1423
1424
1425
        phi3v_model_config_mm_interleaved,
        phi3v_tokenizer,
        content_format="string",
    )

1426
1427
1428
1429
1430
1431
1432
    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?",
        }
    ]
1433
    _assert_mm_data_is_image_input(await mm_data, 2)
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
    _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,
    phi3v_tokenizer,
    image_url,
):
    image_uuid = str(hash(image_url))
    conversation, mm_data, mm_uuids = parse_chat_messages_futures(
1445
1446
1447
1448
1449
1450
1451
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "text",
                        "text": "I need you to compare this image",
1452
                    },
1453
1454
1455
1456
                    {
                        "type": "image_url",
                        "image_url": {"url": image_url},
                        "uuid": image_uuid,
1457
                    },
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
                    {"type": "text", "text": "and this one"},
                    {
                        "type": "image_url",
                        "image_url": {"url": image_url},
                        "uuid": image_uuid,
                    },
                    {"type": "text", "text": "Do they have differences?"},
                ],
            }
        ],
1468
1469
1470
1471
1472
        phi3v_model_config_mm_interleaved,
        phi3v_tokenizer,
        content_format="string",
    )

1473
1474
1475
1476
1477
1478
1479
    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?",
        }
    ]
1480
1481
    _assert_mm_data_is_image_input(await mm_data, 2)
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[image_uuid, image_uuid])
1482
1483
1484
1485
1486
1487
1488


def test_parse_chat_messages_multiple_images_multiple_messages_interleave(
    phi3v_model_config_mm_interleaved,
    phi3v_tokenizer,
    image_url,
):
1489
    conversation, mm_data, mm_uuids = parse_chat_messages(
1490
1491
        [
            {
1492
                "role": "user",
1493
                "content": [
1494
1495
1496
                    {"type": "text", "text": "What's on this image?"},
                    {"type": "image_url", "image_url": {"url": image_url}},
                    {"type": "text", "text": "Be accurate."},
1497
1498
                ],
            },
1499
            {"role": "assistant", "content": "Some stuff."},
1500
            {
1501
                "role": "user",
1502
                "content": [
1503
1504
                    {"type": "text", "text": "What's on this image?"},
                    {"type": "image_url", "image_url": {"url": image_url}},
1505
1506
1507
                ],
            },
        ],
1508
1509
1510
1511
1512
        phi3v_model_config_mm_interleaved,
        phi3v_tokenizer,
        content_format="string",
    )

1513
1514
1515
1516
1517
    assert conversation == [
        {
            "role": "user",
            "content": "What's on this image?\n<|image_1|>\nBe accurate.",
        },
1518
1519
        {"role": "assistant", "content": "Some stuff."},
        {"role": "user", "content": "What's on this image?\n<|image_2|>"},
1520
    ]
1521
    _assert_mm_data_is_image_input(mm_data, 2)
1522
1523
1524
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])


1525
def test_parse_chat_messages_multiple_images_with_uuids_multiple_messages_interleave(
1526
1527
1528
1529
1530
1531
1532
1533
    phi3v_model_config_mm_interleaved,
    phi3v_tokenizer,
    image_url,
):
    image_uuid = str(hash(image_url))
    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
1534
                "role": "user",
1535
                "content": [
1536
                    {"type": "text", "text": "What's on this image?"},
1537
1538
                    {
                        "type": "image_url",
1539
                        "image_url": {"url": image_url},
1540
1541
                        "uuid": image_uuid,
                    },
1542
                    {"type": "text", "text": "Be accurate."},
1543
1544
                ],
            },
1545
            {"role": "assistant", "content": "Some stuff."},
1546
            {
1547
                "role": "user",
1548
                "content": [
1549
                    {"type": "text", "text": "What's on this image?"},
1550
1551
                    {
                        "type": "image_url",
1552
                        "image_url": {"url": image_url},
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
                        "uuid": image_uuid,
                    },
                ],
            },
        ],
        phi3v_model_config_mm_interleaved,
        phi3v_tokenizer,
        content_format="string",
    )

    assert conversation == [
        {
            "role": "user",
            "content": "What's on this image?\n<|image_1|>\nBe accurate.",
        },
1568
1569
        {"role": "assistant", "content": "Some stuff."},
        {"role": "user", "content": "What's on this image?\n<|image_2|>"},
1570
1571
1572
    ]
    _assert_mm_data_is_image_input(mm_data, 2)
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[image_uuid, image_uuid])
1573
1574
1575


def test_parse_chat_messages_multiple_modals_multiple_messages_interleave(
1576
1577
1578
1579
1580
1581
    qwen25omni_model_config_mm_interleaved,
    qwen25omni_tokenizer,
    image_url,
    video_url,
    audio_url,
):
1582
    conversation, mm_data, mm_uuids = parse_chat_messages(
1583
1584
        [
            {
1585
                "role": "user",
1586
                "content": [
1587
1588
1589
1590
                    {"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}},
1591
1592
                ],
            },
1593
            {"role": "assistant", "content": "Some stuff."},
1594
            {
1595
                "role": "user",
1596
                "content": [
1597
1598
1599
1600
                    {"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}},
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
                ],
            },
        ],
        qwen25omni_model_config_mm_interleaved,
        qwen25omni_tokenizer,
        content_format="string",
    )

    assert conversation == [
        {
1611
            "role": "user",
1612
1613
            "content": "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>"
            "\nNow listen to this audio\nAudio 1: <|audio_bos|><|AUDIO|><|audio_eos|>",
1614
        },
1615
        {"role": "assistant", "content": "Some stuff."},
1616
        {
1617
            "role": "user",
1618
1619
            "content": "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>"
            "\nAnd what's in the video?\n<|vision_start|><|VIDEO|><|vision_end|>",
1620
1621
        },
    ]
1622
1623

    _assert_mm_data_inputs(mm_data, {"image": 2, "video": 1, "audio": 1})
1624
    _assert_mm_uuids(mm_uuids, 2, modality="image", expected_uuids=[None, None])
1625
1626
1627
1628
    _assert_mm_uuids(mm_uuids, 1, modality="video", expected_uuids=[None])
    _assert_mm_uuids(mm_uuids, 1, modality="audio", expected_uuids=[None])


1629
def test_parse_chat_messages_multiple_modals_with_uuids_multiple_messages_interleave(
1630
1631
1632
1633
1634
1635
1636
1637
1638
    qwen25omni_model_config_mm_interleaved,
    qwen25omni_tokenizer,
    image_url,
    video_url,
    audio_url,
):
    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
1639
                "role": "user",
1640
                "content": [
1641
                    {"type": "text", "text": "What's on this image?"},
1642
1643
                    {
                        "type": "image_url",
1644
                        "image_url": {"url": image_url},
1645
1646
                        "uuid": "image_123",
                    },
1647
                    {"type": "text", "text": "Now listen to this audio"},
1648
1649
                    {
                        "type": "audio_url",
1650
                        "audio_url": {"url": audio_url},
1651
1652
1653
1654
                        "uuid": "audio_123",
                    },
                ],
            },
1655
            {"role": "assistant", "content": "Some stuff."},
1656
            {
1657
                "role": "user",
1658
                "content": [
1659
                    {"type": "text", "text": "What's on this image?"},
1660
1661
                    {
                        "type": "image_url",
1662
                        "image_url": {"url": image_url},
1663
1664
                        "uuid": "image_123",
                    },
1665
                    {"type": "text", "text": "And what's in the video?"},
1666
1667
                    {
                        "type": "video_url",
1668
                        "video_url": {"url": video_url},
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
                        "uuid": "video_123",
                    },
                ],
            },
        ],
        qwen25omni_model_config_mm_interleaved,
        qwen25omni_tokenizer,
        content_format="string",
    )

    assert conversation == [
        {
1681
            "role": "user",
1682
1683
            "content": "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>"
            "\nNow listen to this audio\nAudio 1: <|audio_bos|><|AUDIO|><|audio_eos|>",
1684
        },
1685
        {"role": "assistant", "content": "Some stuff."},
1686
        {
1687
            "role": "user",
1688
1689
            "content": "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>"
            "\nAnd what's in the video?\n<|vision_start|><|VIDEO|><|vision_end|>",
1690
1691
1692
1693
        },
    ]

    _assert_mm_data_inputs(mm_data, {"image": 2, "video": 1, "audio": 1})
1694
1695
1696
1697
1698
    _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"])
1699
1700


1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
def test_parse_chat_messages_multiple_modals_with_uuids_multiple_empty_media_messages_interleave(  # noqa: E501
    qwen25omni_model_config_mm_interleaved,
    qwen25omni_tokenizer,
    image_url,
    video_url,
    audio_url,
):
    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
1711
                "role": "user",
1712
                "content": [
1713
                    {"type": "text", "text": "What's on this image?"},
1714
1715
1716
1717
1718
                    {
                        "type": "image_url",
                        "image_url": None,
                        "uuid": "image_123",
                    },
1719
                    {"type": "text", "text": "Now listen to this audio"},
1720
1721
1722
1723
1724
1725
1726
                    {
                        "type": "audio_url",
                        "audio_url": None,
                        "uuid": "audio_123",
                    },
                ],
            },
1727
            {"role": "assistant", "content": "Some stuff."},
1728
            {
1729
                "role": "user",
1730
                "content": [
1731
                    {"type": "text", "text": "What's on this image?"},
1732
1733
1734
1735
1736
                    {
                        "type": "image_url",
                        "image_url": None,
                        "uuid": "image_123",
                    },
1737
                    {"type": "text", "text": "And what's in the video?"},
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
                    {
                        "type": "video_url",
                        "video_url": None,
                        "uuid": "video_123",
                    },
                ],
            },
        ],
        qwen25omni_model_config_mm_interleaved,
        qwen25omni_tokenizer,
        content_format="string",
    )

    assert conversation == [
        {
1753
            "role": "user",
1754
1755
            "content": "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>"
            "\nNow listen to this audio\nAudio 1: <|audio_bos|><|AUDIO|><|audio_eos|>",
1756
        },
1757
        {"role": "assistant", "content": "Some stuff."},
1758
        {
1759
            "role": "user",
1760
1761
            "content": "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>"
            "\nAnd what's in the video?\n<|vision_start|><|VIDEO|><|vision_end|>",
1762
1763
1764
        },
    ]

1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
    _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"])
1775
1776


1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
def test_parse_chat_messages_multiple_modals_with_partial_uuids_multiple_messages_interleave(  # noqa: E501
    qwen25omni_model_config_mm_interleaved,
    qwen25omni_tokenizer,
    image_url,
    video_url,
    audio_url,
):
    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
1787
                "role": "user",
1788
                "content": [
1789
                    {"type": "text", "text": "What's on this image?"},
1790
1791
                    {
                        "type": "image_url",
1792
                        "image_url": {"url": image_url},
1793
1794
                        "uuid": "image_123",
                    },
1795
1796
                    {"type": "text", "text": "Now listen to this audio"},
                    {"type": "audio_url", "audio_url": {"url": audio_url}},
1797
1798
                ],
            },
1799
            {"role": "assistant", "content": "Some stuff."},
1800
            {
1801
                "role": "user",
1802
                "content": [
1803
1804
1805
                    {"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?"},
1806
1807
                    {
                        "type": "video_url",
1808
                        "video_url": {"url": video_url},
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
                        "uuid": "video_123",
                    },
                ],
            },
        ],
        qwen25omni_model_config_mm_interleaved,
        qwen25omni_tokenizer,
        content_format="string",
    )

    assert conversation == [
        {
1821
            "role": "user",
1822
1823
            "content": "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>"
            "\nNow listen to this audio\nAudio 1: <|audio_bos|><|AUDIO|><|audio_eos|>",
1824
        },
1825
        {"role": "assistant", "content": "Some stuff."},
1826
        {
1827
            "role": "user",
1828
1829
            "content": "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>"
            "\nAnd what's in the video?\n<|vision_start|><|VIDEO|><|vision_end|>",
1830
1831
1832
1833
        },
    ]

    _assert_mm_data_inputs(mm_data, {"image": 2, "video": 1, "audio": 1})
1834
1835
    _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"])
1836
    _assert_mm_uuids(mm_uuids, 1, modality="audio", expected_uuids=[None])
1837
1838
1839
1840
1841
1842
1843
1844


def test_parse_chat_messages_multiple_images_interleave_with_placeholders(
    phi3v_model_config_mm_interleaved,
    phi3v_tokenizer,
    image_url,
):
    with pytest.raises(
1845
1846
1847
        ValueError,
        match=r"Found more '<|image_1|>' placeholders in input prompt "
        "than actual multimodal data items.",
1848
    ):
1849
        parse_chat_messages(
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
            [
                {
                    "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?",
                        },
                    ],
                }
            ],
1864
1865
1866
1867
1868
1869
            phi3v_model_config_mm_interleaved,
            phi3v_tokenizer,
            content_format="string",
        )


1870
1871
1872
1873
1874
@pytest.mark.parametrize(
    "model",
    [
        QWEN2VL_MODEL_ID,  # tokenizer.chat_template is of type str
        HERMES_MODEL_ID,  # tokenizer.chat_template is of type dict
1875
1876
    ],
)
1877
1878
1879
@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."""
1880
1881
1882
1883
1884
1885
1886
    model_info = HF_EXAMPLE_MODELS.find_hf_info(model)
    model_info.check_available_online(on_fail="skip")

    model_config = ModelConfig(
        model,
        tokenizer=model_info.tokenizer or model,
        tokenizer_mode=model_info.tokenizer_mode,
1887
        revision=model_info.revision,
1888
1889
        trust_remote_code=model_info.trust_remote_code,
        hf_overrides=model_info.hf_overrides,
1890
1891
1892
        skip_tokenizer_init=model_info.require_embed_inputs,
        enable_prompt_embeds=model_info.require_embed_inputs,
        enable_mm_embeds=model_info.require_embed_inputs,
1893
        enforce_eager=model_info.enforce_eager,
1894
1895
        dtype=model_info.dtype,
    )
1896

1897
1898
    # Build the tokenizer
    tokenizer = get_tokenizer(
1899
        model,
1900
        trust_remote_code=model_config.trust_remote_code,
1901
1902
    )

1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
    tools = (
        [
            {
                "type": "function",
                "function": {
                    "name": "dummy_function_name",
                    "description": "This is a dummy function",
                    "parameters": sample_json_schema,
                },
            }
        ]
        if use_tools
        else None
    )
1917
1918

    # Test detecting the tokenizer's chat_template
1919
    chat_template = resolve_hf_chat_template(
1920
1921
1922
        tokenizer,
        chat_template=None,
        tools=tools,
1923
        model_config=model_config,
1924
1925
1926
1927
    )
    assert isinstance(chat_template, str)


1928
1929
1930
1931
1932
1933
@pytest.mark.parametrize(
    "model, expected_kwargs",
    [
        (
            QWEN2VL_MODEL_ID,
            {
1934
1935
1936
1937
                "add_vision_id",
                "add_generation_prompt",
                "continue_final_message",
                "tools",
1938
1939
1940
1941
1942
            },
        ),
        (
            QWEN3_MODEL_ID,
            {
1943
1944
1945
1946
                "enable_thinking",
                "add_generation_prompt",
                "continue_final_message",
                "tools",
1947
1948
1949
1950
            },
        ),
    ],
)
1951
def test_resolve_hf_chat_template_kwargs(sample_json_schema, model, expected_kwargs):
1952
1953
1954
1955
    """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")

1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
    tools = [
        {
            "type": "function",
            "function": {
                "name": "dummy_function_name",
                "description": "This is a dummy function",
                "parameters": sample_json_schema,
            },
        }
    ]
1966
1967
1968
1969
1970
1971
1972

    chat_template_kwargs = {
        # both unused
        "unsed_kwargs_1": 123,
        "unsed_kwargs_2": "abc",
        # should not appear
        "chat_template": "{% Hello world! %}",
1973
        "tokenize": True,
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
        # 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,
    }

    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,
1992
1993
1994
        skip_tokenizer_init=model_info.require_embed_inputs,
        enable_prompt_embeds=model_info.require_embed_inputs,
        enable_mm_embeds=model_info.require_embed_inputs,
1995
        enforce_eager=model_info.enforce_eager,
1996
1997
        dtype=model_info.dtype,
    )
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011

    # Build the tokenizer
    tokenizer = get_tokenizer(
        model,
        trust_remote_code=model_config.trust_remote_code,
    )

    # Test detecting the tokenizer's chat_template
    chat_template = resolve_hf_chat_template(
        tokenizer,
        chat_template=None,
        tools=tools,
        model_config=model_config,
    )
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
    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,
        )
2022
2023
2024
2025
    resolved_chat_template_kwargs = resolve_chat_template_kwargs(
        tokenizer,
        chat_template=chat_template,
        chat_template_kwargs=chat_template_kwargs,
2026
        raise_on_unexpected=False,
2027
2028
2029
    )
    assert set(resolved_chat_template_kwargs.keys()) == expected_kwargs

2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
    # 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

2063

2064
2065
# NOTE: Qwen2-Audio default chat template is specially defined inside
# processor class instead of using `tokenizer_config.json`
2066
2067
@pytest.mark.parametrize(
    ("model", "expected_format"),
2068
2069
2070
2071
2072
2073
2074
2075
    [
        (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"),
    ],
2076
2077
)
def test_resolve_content_format_hf_defined(model, expected_format):
2078
2079
2080
2081
2082
2083
2084
    model_info = HF_EXAMPLE_MODELS.find_hf_info(model)
    model_info.check_available_online(on_fail="skip")

    model_config = ModelConfig(
        model,
        tokenizer=model_info.tokenizer or model,
        tokenizer_mode=model_info.tokenizer_mode,
2085
        revision=model_info.revision,
2086
2087
        trust_remote_code=model_info.trust_remote_code,
        hf_overrides=model_info.hf_overrides,
2088
2089
2090
        skip_tokenizer_init=model_info.require_embed_inputs,
        enable_prompt_embeds=model_info.require_embed_inputs,
        enable_mm_embeds=model_info.require_embed_inputs,
2091
        enforce_eager=model_info.enforce_eager,
2092
2093
        dtype=model_info.dtype,
    )
2094

2095
    tokenizer = get_tokenizer(
2096
        model,
2097
        trust_remote_code=model_config.trust_remote_code,
2098
2099
    )

2100
    # Test detecting the tokenizer's chat_template
2101
    chat_template = resolve_hf_chat_template(
2102
2103
2104
        tokenizer,
        chat_template=None,
        tools=None,
2105
        model_config=model_config,
2106
    )
2107
2108
2109
2110
2111
2112
2113
2114
    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(
2115
2116
2117
2118
        None,  # Test detecting the tokenizer's chat_template
        None,
        "auto",
        tokenizer,
2119
        model_config=model_config,
2120
2121
2122
2123
2124
2125
2126
    )

    assert resolved_format == expected_format


@pytest.mark.parametrize(
    ("model", "expected_format"),
2127
2128
2129
2130
2131
2132
2133
2134
2135
    [
        ("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"),
    ],
2136
2137
2138
2139
2140
2141
2142
2143
2144
)
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")

    model_config = ModelConfig(
        model,
        tokenizer=model_info.tokenizer or model,
        tokenizer_mode=model_info.tokenizer_mode,
2145
        revision=model_info.revision,
2146
2147
        trust_remote_code=model_info.trust_remote_code,
        hf_overrides=model_info.hf_overrides,
2148
2149
2150
        skip_tokenizer_init=model_info.require_embed_inputs,
        enable_prompt_embeds=model_info.require_embed_inputs,
        enable_mm_embeds=model_info.require_embed_inputs,
2151
        enforce_eager=model_info.enforce_eager,
2152
2153
        dtype=model_info.dtype,
    )
2154

2155
    tokenizer = get_tokenizer(
2156
2157
2158
2159
2160
2161
2162
2163
2164
        model_config.tokenizer,
        trust_remote_code=model_config.trust_remote_code,
    )

    # Test detecting the tokenizer's chat_template
    chat_template = resolve_hf_chat_template(
        tokenizer,
        chat_template=None,
        tools=None,
2165
        model_config=model_config,
2166
2167
2168
2169
2170
2171
2172
2173
2174
    )
    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(
2175
        None,  # Test detecting the tokenizer's chat_template
2176
        None,
2177
2178
        "auto",
        tokenizer,
2179
        model_config=model_config,
2180
2181
2182
2183
2184
2185
2186
    )

    assert resolved_format == expected_format


@pytest.mark.parametrize(
    ("template_path", "expected_format"),
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
    [
        ("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"),
    ],
2208
2209
)
def test_resolve_content_format_examples(template_path, expected_format):
2210
2211
2212
2213
2214
2215
    model_config = ModelConfig(
        PHI3V_MODEL_ID,  # Dummy
        tokenizer=PHI3V_MODEL_ID,  # Dummy
        trust_remote_code=True,
    )

2216
    dummy_tokenizer = get_tokenizer(
2217
2218
        PHI3V_MODEL_ID,  # Dummy
        trust_remote_code=model_config.trust_remote_code,
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
    )
    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,
2232
        None,
2233
2234
        "auto",
        dummy_tokenizer,
2235
        model_config=model_config,
2236
2237
2238
    )

    assert resolved_format == expected_format
Julien Denize's avatar
Julien Denize committed
2239
2240


2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
def test_parse_chat_messages_include_thinking_chunk(
    mistral_model_config, mistral_tokenizer
):
    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
2269

2270
    conversation_with_thinking, _, _ = parse_chat_messages(
Julien Denize's avatar
Julien Denize committed
2271
2272
2273
2274
2275
2276
        messages,
        mistral_model_config,
        mistral_tokenizer,
        content_format="openai",
    )

2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
    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
2301
2302
2303
2304
2305

    assert conversation_with_thinking == expected_conversation


def test_apply_mistral_chat_template_thinking_chunk():
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
    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
2332
    mistral_tokenizer = MistralTokenizer.from_pretrained(
2333
        "mistralai/Magistral-Small-2509"
2334
    )
Julien Denize's avatar
Julien Denize committed
2335

2336
2337
2338
    tokens_ids = apply_mistral_chat_template(
        mistral_tokenizer, messages, chat_template=None, tools=None
    )
Julien Denize's avatar
Julien Denize committed
2339
2340

    string_tokens = mistral_tokenizer.mistral.decode(
2341
2342
        tokens_ids, special_token_policy=SpecialTokenPolicy.KEEP
    )
Julien Denize's avatar
Julien Denize committed
2343
2344
2345
2346
2347
2348

    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>"
2349
2350
        r"[INST]Thanks, what is 3+3?[/INST]"
    )
Julien Denize's avatar
Julien Denize committed
2351
2352

    assert string_tokens == expected_tokens
2353
2354
2355
2356
2357
2358
2359
2360


def test_parse_chat_messages_single_empty_audio_with_uuid(
    qwen2_audio_model_config,
    qwen2_audio_tokenizer,
):
    audio_uuid = "abcd"
    conversation, mm_data, mm_uuids = parse_chat_messages(
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "input_audio",
                        "input_audio": {},
                        "uuid": audio_uuid,
                    },
                    {"type": "text", "text": "What does the audio say?"},
                ],
            }
        ],
2374
2375
2376
2377
2378
        qwen2_audio_model_config,
        qwen2_audio_tokenizer,
        content_format="string",
    )

2379
2380
2381
    assert conversation == [
        {
            "role": "user",
2382
2383
            "content": "Audio 1: <|audio_bos|><|AUDIO|><|audio_eos|>\nWhat does the "
            "audio say?",
2384
2385
        }
    ]
2386
    _assert_mm_data_inputs(mm_data, {"audio": 1})
2387
    _assert_mm_uuids(mm_uuids, 1, modality="audio", expected_uuids=[audio_uuid])
2388
2389
2390
2391
2392
2393
2394
2395
2396


@pytest.mark.asyncio
async def test_parse_chat_messages_single_empty_audio_with_uuid_async(
    qwen2_audio_model_config,
    qwen2_audio_tokenizer,
):
    audio_uuid = "abcd"
    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "input_audio",
                        "input_audio": {},
                        "uuid": audio_uuid,
                    },
                    {"type": "text", "text": "What does the audio say?"},
                ],
            }
        ],
2410
2411
2412
2413
2414
        qwen2_audio_model_config,
        qwen2_audio_tokenizer,
        content_format="string",
    )

2415
2416
2417
    assert conversation == [
        {
            "role": "user",
2418
2419
            "content": "Audio 1: <|audio_bos|><|AUDIO|><|audio_eos|>\nWhat does the "
            "audio say?",
2420
2421
        }
    ]
2422
    _assert_mm_data_inputs(await mm_future, {"audio": 1})
2423
    _assert_mm_uuids(mm_uuids, 1, modality="audio", expected_uuids=[audio_uuid])