[Bugfix][Frontend] Update all fastapi requests based on OpenAPIBase with annotations

[drikster80]

Adds additional Annotation to all fastapi requests that are based on OpenAPIBase pydantic model.

FIX #8212

---

PR Checklist (Click to Expand)

Thank you for your contribution to vLLM! Before submitting the pull request, please ensure the PR meets the following criteria. This helps vLLM maintain the code quality and improve the efficiency of the review process.

PR Title and Classification

Only specific types of PRs will be reviewed. The PR title is prefixed appropriately to indicate the type of change. Please use one of the following:

• [Bugfix] for bug fixes.
• [CI/Build] for build or continuous integration improvements.
• [Doc] for documentation fixes and improvements.
• [Model] for adding a new model or improving an existing model. Model name should appear in the title.
• [Frontend] For changes on the vLLM frontend (e.g., OpenAI API server, LLM class, etc.)
• [Kernel] for changes affecting CUDA kernels or other compute kernels.
• [Core] for changes in the core vLLM logic (e.g., LLMEngine, AsyncLLMEngine, Scheduler, etc.)
• [Hardware][Vendor] for hardware-specific changes. Vendor name should appear in the prefix (e.g., [Hardware][AMD]).
• [Misc] for PRs that do not fit the above categories. Please use this sparingly.

Note: If the PR spans more than one category, please include all relevant prefixes.

Code Quality

The PR need to meet the following code quality standards:

• We adhere to Google Python style guide and Google C++ style guide.
• Pass all linter checks. Please use format.sh to format your code.
• The code need to be well-documented to ensure future contributors can easily understand the code.
• Include sufficient tests to ensure the project to stay correct and robust. This includes both unit tests and integration tests.
• Please add documentation to docs/source/ if the PR modifies the user-facing behaviors of vLLM. It helps vLLM user understand and utilize the new features or changes.

Notes for Large Changes

Please keep the changes as concise as possible. For major architectural changes (>500 LOC excluding kernel/data/config/test), we would expect a GitHub issue (RFC) discussing the technical design and justification. Otherwise, we will tag it with rfc-required and might not go through the PR.

What to Expect for the Reviews

The goal of the vLLM team is to be a transparent reviewing machine. We would like to make the review process transparent and efficient and make sure no contributor feel confused or frustrated. However, the vLLM team is small, so we need to prioritize some PRs over others. Here is what you can expect from the review process:

• After the PR is submitted, the PR will be assigned to a reviewer. Every reviewer will pick up the PRs based on their expertise and availability.
• After the PR is assigned, the reviewer will provide status update every 2-3 days. If the PR is not reviewed within 7 days, please feel free to ping the reviewer or the vLLM team.
• After the review, the reviewer will put an action-required label on the PR if there are changes required. The contributor should address the comments and ping the reviewer to re-review the PR.
• Please respond to all comments within a reasonable time frame. If a comment isn't clear or you disagree with a suggestion, feel free to ask for clarification or discuss the suggestion.

Thank You

Finally, thank you for taking the time to read these guidelines and for your interest in contributing to vLLM. Your contributions make vLLM a great tool for everyone!

[github-actions]

👋 Hi! Thank you for contributing to the vLLM project.
Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can do one of these:

• Add ready label to the PR
• Enable auto-merge.

🚀

[drikster80]

Converting to draft PR until the mypy static checks are fixed...

[drikster80]

@DarkLight1337 or @robertgshaw2-neuralmagic (tagging as recent committers to the openai entrypoint)
Any recommendations for how to approach this? FastAPI/Pydantic isn't my strong area.

Would wrapping this in a new TypeVar be a good approach to make mypy happy or am I way off base here?

T = TypeVar('T')
AnnotatedRequest = Annotated[dict, T]

@router.post("/v1/chat/completions")
async def create_chat_completion(request: AnnotatedRequest[ChatCompletionRequest], raw_request: Request):

[DarkLight1337]

Could you explain why we should update them with Annotation? Even in the current state, the incoming requests are already being type checked.

Just saw the linked issue, I guess the point of this is to make it compatible with the newest version of FastAPI? Do these annotations work with previous versions of FastAPI as well?

[drikster80]

Just saw the linked issue, I guess the point of this is to make it compatible with the newest version of FastAPI? Do these annotations work with previous versions of FastAPI as well?

Just tested successfully with fastapi==0.112.2 (prior to the pydantic refactoring).
Admittedly, this feels like it might be a bug in fastapi, or it conveniently worked in prior versions until the 0.113.0 refactor.

I just provided the FastAPI maintainer with a minimal example to recreate the error using latest vllm container (and edit it) here: fastapi/fastapi#12133 (comment)

I know adding the Annotated "solves" the problem, but unsure if it's the correct approach since python development isn't really my strong area.

[DarkLight1337]

Although I have worked with Pydantic quite a lot, I'm less experienced with using it in the context of FastAPI. Let's wait until they debug the issue on their end first.

[drikster80]

I was able to confirm that upgrading to the pydantic >2.9.0 resolves this issue. Closing.