Skip to content

[Doc]: LLM.wait_for_completion output_type default is inaccurate #44616

@viiccwen

Description

@viiccwen

📚 The doc issue

LLM.wait_for_completion() documents output_type as defaulting to RequestOutput, but the implementation defaults to accepting both RequestOutput and PoolingRequestOutput when output_type is not provided.

This can mislead readers into thinking the method only expects generation outputs by default, while the actual behavior is broader.

Suggest a potential alternative/fix

Update the output_type argument description to state that, when omitted, it accepts both RequestOutput and PoolingRequestOutput.

Before submitting a new issue...

  • Make sure you already searched for relevant issues, and asked the chatbot living at the bottom right corner of the documentation page, which can answer lots of frequently asked questions.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions