Skip to content

vllm.v1.structured_output.request

StructuredOutputRequest dataclass

Source code in vllm/v1/structured_output/request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
@dataclasses.dataclass
class StructuredOutputRequest:

    sampling_params: SamplingParams
    _grammar: Optional[Union[Future[StructuredOutputGrammar],
                             StructuredOutputGrammar]] = None
    reasoning_ended: Optional[bool] = None

    def _check_grammar_completion(self) -> bool:
        # NOTE: We have to lazy import to gate circular imports
        from vllm.v1.request import RequestStatus

        if isinstance(self._grammar, Future):
            try:
                # We will check whether the future is ready within 100 us
                self._grammar = self._grammar.result(timeout=0.0001)
                self.status = RequestStatus.WAITING
            except TimeoutError:
                return False
        return True

    @property
    def is_grammar_ready(self) -> bool:
        return self._check_grammar_completion()

    @property
    def grammar(self) -> Optional[StructuredOutputGrammar]:
        completed = self._check_grammar_completion()
        return cast(Optional[StructuredOutputGrammar],
                    self._grammar) if completed else None

    @grammar.setter
    def grammar(
        self, grammar: Union[StructuredOutputGrammar,
                             Future[StructuredOutputGrammar]]
    ) -> None:
        self._grammar = grammar

    @functools.cached_property
    def structured_output_key(self) -> StructuredOutputKey:
        return get_structured_output_key(self.sampling_params)

_grammar class-attribute instance-attribute 

_grammar: Optional[
    Union[
        Future[StructuredOutputGrammar],
        StructuredOutputGrammar,
    ]
] = None

grammar property writable 

grammar: Optional[StructuredOutputGrammar]

is_grammar_ready property 

is_grammar_ready: bool

reasoning_ended class-attribute instance-attribute 

reasoning_ended: Optional[bool] = None

sampling_params instance-attribute 

sampling_params: SamplingParams

structured_output_key cached property 

structured_output_key: StructuredOutputKey

__init__ 

__init__(
    sampling_params: SamplingParams,
    _grammar: Optional[
        Union[
            Future[StructuredOutputGrammar],
            StructuredOutputGrammar,
        ]
    ] = None,
    reasoning_ended: Optional[bool] = None,
) -> None

_check_grammar_completion 

_check_grammar_completion() -> bool
Source code in vllm/v1/structured_output/request.py 
26
27
28
29
30
31
32
33
34
35
36
37
def _check_grammar_completion(self) -> bool:
    # NOTE: We have to lazy import to gate circular imports
    from vllm.v1.request import RequestStatus

    if isinstance(self._grammar, Future):
        try:
            # We will check whether the future is ready within 100 us
            self._grammar = self._grammar.result(timeout=0.0001)
            self.status = RequestStatus.WAITING
        except TimeoutError:
            return False
    return True

get_structured_output_key 

get_structured_output_key(
    sampling_params: SamplingParams,
) -> StructuredOutputKey
Source code in vllm/v1/structured_output/request.py 
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def get_structured_output_key(
        sampling_params: SamplingParams) -> StructuredOutputKey:
    params = sampling_params.guided_decoding
    assert params is not None, "params can't be None."
    if params.json is not None:
        if not isinstance(params.json, str):
            json_str = json.dumps(params.json)
        else:
            json_str = params.json
        return (StructuredOutputOptions.JSON, json_str)
    elif params.json_object:
        return (StructuredOutputOptions.JSON_OBJECT, "")
    elif params.regex is not None:
        return (StructuredOutputOptions.REGEX, params.regex)
    elif params.choice is not None:
        if not isinstance(params.choice, str):
            json_str = json.dumps(params.choice)
        else:
            json_str = params.choice
        return (StructuredOutputOptions.CHOICE, json_str)
    elif params.grammar is not None:
        return (StructuredOutputOptions.GRAMMAR, params.grammar)
    elif params.structural_tag is not None:
        return (StructuredOutputOptions.STRUCTURAL_TAG, params.structural_tag)
    else:
        raise ValueError("No valid structured output parameter found")