Skip to content

vllm.inputs.parse

ParsedSingletonPrompt module-attribute 

ParsedSingletonPrompt: TypeAlias = (
    ParsedStrPrompt
    | ParsedTextPrompt
    | ParsedTokensPrompt
    | ParsedEmbedsPrompt
)

ParsedEmbedsPrompt

Bases: TypedDict

Source code in vllm/inputs/parse.py 
39
40
41
class ParsedEmbedsPrompt(TypedDict):
    type: Literal["embeds"]
    content: EmbedsPrompt

content instance-attribute 

content: EmbedsPrompt

type instance-attribute 

type: Literal['embeds']

ParsedStrPrompt

Bases: TypedDict

Source code in vllm/inputs/parse.py 
24
25
26
class ParsedStrPrompt(TypedDict):
    type: Literal["str"]
    content: str

content instance-attribute 

content: str

type instance-attribute 

type: Literal['str']

ParsedTextPrompt

Bases: TypedDict

Source code in vllm/inputs/parse.py 
29
30
31
class ParsedTextPrompt(TypedDict):
    type: Literal["text"]
    content: TextPrompt

content instance-attribute 

content: TextPrompt

type instance-attribute 

type: Literal['text']

ParsedTokensPrompt

Bases: TypedDict

Source code in vllm/inputs/parse.py 
34
35
36
class ParsedTokensPrompt(TypedDict):
    type: Literal["tokens"]
    content: TokensPrompt

content instance-attribute 

content: TokensPrompt

type instance-attribute 

type: Literal['tokens']

PromptComponents

Bases: NamedTuple

Source code in vllm/inputs/parse.py 
85
86
87
88
class PromptComponents(NamedTuple):
    text: str | None = None
    token_ids: list[int] | None = None
    embeds: "torch.Tensor | None" = None

embeds class-attribute instance-attribute 

embeds: Tensor | None = None

text class-attribute instance-attribute 

text: str | None = None

token_ids class-attribute instance-attribute 

token_ids: list[int] | None = None

get_prompt_components 

get_prompt_components(
    prompt: PromptType,
) -> PromptComponents
Source code in vllm/inputs/parse.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
def get_prompt_components(prompt: PromptType) -> PromptComponents:
    if isinstance(prompt, str):
        return PromptComponents(text=prompt)

    if encoder_prompt := prompt.get("encoder_prompt"):
        return get_prompt_components(encoder_prompt)  # type: ignore[arg-type]

    return PromptComponents(
        text=prompt.get("prompt"),  # type: ignore[arg-type]
        token_ids=prompt.get("prompt_token_ids"),  # type: ignore[arg-type]
        embeds=prompt.get("prompt_embeds"),
    )

get_prompt_len 

get_prompt_len(prompt: TokensPrompt | EmbedsPrompt)
Source code in vllm/inputs/parse.py 
105
106
107
108
109
def get_prompt_len(prompt: TokensPrompt | EmbedsPrompt):
    return length_from_prompt_token_ids_or_embeds(
        prompt.get("prompt_token_ids"),  # type: ignore[arg-type]
        prompt.get("prompt_embeds"),  # type: ignore[arg-type]
    )

is_explicit_encoder_decoder_prompt 

is_explicit_encoder_decoder_prompt(
    prompt: PromptType,
) -> TypeIs[ExplicitEncoderDecoderPrompt]
Source code in vllm/inputs/parse.py 
66
67
68
69
def is_explicit_encoder_decoder_prompt(
    prompt: PromptType,
) -> TypeIs[ExplicitEncoderDecoderPrompt]:
    return isinstance(prompt, dict) and "encoder_prompt" in prompt

parse_singleton_prompt 

parse_singleton_prompt(
    prompt: SingletonPrompt,
) -> ParsedSingletonPrompt
Source code in vllm/inputs/parse.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def parse_singleton_prompt(prompt: SingletonPrompt) -> ParsedSingletonPrompt:
    if isinstance(prompt, str):
        return ParsedStrPrompt(type="str", content=prompt)
    elif isinstance(prompt, dict):
        # Type ignores are because mypy does not correctly infer the TypedDicts
        # Pyright does succeed.
        if "prompt_embeds" in prompt:
            return ParsedEmbedsPrompt(type="embeds", content=prompt)  # type: ignore[typeddict-item]
        elif "prompt_token_ids" in prompt:
            return ParsedTokensPrompt(type="tokens", content=prompt)  # type: ignore[typeddict-item]
        elif "prompt" in prompt:
            return ParsedTextPrompt(type="text", content=prompt)
    raise TypeError(
        "inputs must be a string, TextPrompt, TokensPrompt, or EmbedsPrompt"
    )

split_enc_dec_inputs 

split_enc_dec_inputs(
    inputs: ProcessorInputs,
) -> tuple[SingletonInputs | None, SingletonInputs]
Source code in vllm/inputs/parse.py 
72
73
74
75
76
77
78
79
80
81
82
def split_enc_dec_inputs(
    inputs: ProcessorInputs,
) -> tuple[SingletonInputs | None, SingletonInputs]:
    if "encoder" in inputs and "decoder" in inputs:
        # NOTE: This passes pyright but not mypy
        return (
            inputs["encoder"],  # type: ignore[typeddict-item]
            inputs["decoder"],  # type: ignore[typeddict-item]
        )

    return None, inputs