[BugFix] Do not raise a `ValueError` when `tool_choice` is set to the supported `none` option and `tools` are not defined. #10000

gcalmettes · 2024-11-04T18:33:35Z

This PR fixes the raise of a ValueError when tool_choice is set to the supported none value.

Currently, the ChatCompletionRequest object supports the none and auto options for the tool_choice field.

However, setting tool_choice to none will raise an error as the current validation check is expecting the tools field to be also set when tool_choice is defined, whatever its value.

{"object":"error","message":"[{'type': 'value_error', 'loc': ('body',), 'msg': 'Value error, When using `tool_choice`, `tools` must be set.', 'input': {'model': 'pixtral', 'messages': [{'role': 'system', 'content': 'You are a helpful assistant'}, {'role': 'user', 'content': 'tell me a short story'}], 'max_tokens': 100, 'temperature': 0.7, 'top_p': 0.7, 'presence_penalty': 0, 'stop': [], 'stream': False, 'tool_choice': 'none'}, 'ctx': {'error': ValueError('When using `tool_choice`, `tools` must be set.')}}]","type":"BadRequestError","param":null,"code":400}%

This PR prevents the ValueError to occur and also ensure that when tool_choice is set to the supported none value, no tools definitions are actually sent to the model.

BEFORE SUBMITTING, PLEASE READ THE CHECKLIST BELOW AND FILL IN THE DESCRIPTION ABOVE

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.

Adding or changing kernels

Each custom kernel needs a schema and one or more implementations to be registered with PyTorch.

Make sure custom ops are registered following PyTorch guidelines: Custom C++ and CUDA Operators and The Custom Operators Manual
Custom operations that return Tensors require meta-functions. Meta-functions should be implemented and registered in python so that dynamic dims can be handled automatically. See above documents for a description of meta-functions.
Use torch.libary.opcheck() to test the function registration and meta-function for any registered ops. See tests/kernels for examples.
When changing the C++ signature of an existing op, the schema must be updated to reflect the changes.
If a new custom type is needed, see the following document: Custom Class Support in PT2.

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 · 2024-11-04T18:33:48Z

👋 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.

🚀

DarkLight1337 · 2024-11-05T02:22:46Z

cc @K-Mistele can you take a look at this and check whether the docs are up-to-date as well?

gcalmettes · 2024-11-05T08:51:01Z

Note that we encountered the issue when using vllm with Microsoft semantic-kernel, which forces the tool_choice to none if no tool_choice is set in the request (see here).

K-Mistele · 2024-11-07T05:16:31Z

Taking a look; this seems pretty straightforward

vllm/entrypoints/openai/protocol.py

mergify · 2024-11-07T15:10:34Z

This pull request has merge conflicts that must be resolved before it can be
merged. Please rebase the PR, @gcalmettes.

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

Signed-off-by: Guillaume Calmettes <gcalmettes@scaleway.com>

docs/source/serving/openai_compatible_server.md

…d in the doc

DarkLight1337

Thanks for your patience!

gcalmettes · 2024-11-12T10:20:42Z

@DarkLight1337 it looks like one of the required CI pipeline (for auto-merge) has failed due to timeout to fetch one of the model. Anything I can do on my end for this ? Or does this required force merge ?

DarkLight1337 · 2024-11-12T10:33:34Z

Thanks for the reminder, I have retried the tests just now.

… supported `none` option and `tools` are not defined. (vllm-project#10000) Signed-off-by: Guillaume Calmettes <gcalmettes@scaleway.com> Signed-off-by: Sumit Dubey <sumit.dubey2@ibm.com>

… supported `none` option and `tools` are not defined. (vllm-project#10000) Signed-off-by: Guillaume Calmettes <gcalmettes@scaleway.com>

# What does this PR do? This is to be consistent with OpenAI API and support vLLM <= v0.6.3 References: * https://platform.openai.com/docs/api-reference/chat/create#chat-create-tool_choice * vllm-project/vllm#10000 This fixes the error when running older versions of vLLM: ``` 00:50:19.834 [START] /v1/inference/chat-completion INFO 2025-02-28 00:50:20,203 httpx:1025: HTTP Request: POST https://api-xeai-granite-3-1-8b-instruct.apps.int.stc.ai.preprod.us-east-1.aws.paas.redhat.com/v1/chat/completions "HTTP/1.1 400 Bad Request" Traceback (most recent call last): File "/usr/local/lib/python3.10/site-packages/llama_stack/distribution/server/server.py", line 235, in endpoint return await maybe_await(value) File "/usr/local/lib/python3.10/site-packages/llama_stack/distribution/server/server.py", line 201, in maybe_await return await value File "/usr/local/lib/python3.10/site-packages/llama_stack/providers/utils/telemetry/trace_protocol.py", line 89, in async_wrapper result = await method(self, *args, **kwargs) File "/usr/local/lib/python3.10/site-packages/llama_stack/distribution/routers/routers.py", line 193, in chat_completion return await provider.chat_completion(**params) File "/usr/local/lib/python3.10/site-packages/llama_stack/providers/utils/telemetry/trace_protocol.py", line 89, in async_wrapper result = await method(self, *args, **kwargs) File "/usr/local/lib/python3.10/site-packages/llama_stack/providers/remote/inference/vllm/vllm.py", line 286, in chat_completion return await self._nonstream_chat_completion(request, self.client) File "/usr/local/lib/python3.10/site-packages/llama_stack/providers/remote/inference/vllm/vllm.py", line 292, in _nonstream_chat_completion r = client.chat.completions.create(**params) File "/usr/local/lib/python3.10/site-packages/openai/_utils/_utils.py", line 279, in wrapper return func(*args, **kwargs) File "/usr/local/lib/python3.10/site-packages/openai/resources/chat/completions/completions.py", line 879, in create return self._post( File "/usr/local/lib/python3.10/site-packages/openai/_base_client.py", line 1290, in post return cast(ResponseT, self.request(cast_to, opts, stream=stream, stream_cls=stream_cls)) File "/usr/local/lib/python3.10/site-packages/openai/_base_client.py", line 967, in request return self._request( File "/usr/local/lib/python3.10/site-packages/openai/_base_client.py", line 1071, in _request raise self._make_status_error_from_response(err.response) from None openai.BadRequestError: Error code: 400 - {'object': 'error', 'message': "[{'type': 'value_error', 'loc': ('body',), 'msg': 'Value error, When using `tool_choice`, `tools` must be set.', 'input': {'messages': [{'role': 'user', 'content': [{'type': 'text', 'text': 'What model are you?'}]}], 'model': 'granite-3-1-8b-instruct', 'max_tokens': 4096, 'stream': False, 'temperature': 0.0, 'tools': None, 'tool_choice': 'auto'}, 'ctx': {'error': ValueError('When using `tool_choice`, `tools` must be set.')}}]", 'type': 'BadRequestError', 'param': None, 'code': 400} INFO: 2600:1700:9d20:ac0::49:59736 - "POST /v1/inference/chat-completion HTTP/1.1" 500 Internal Server Error 00:50:20.266 [END] /v1/inference/chat-completion [StatusCode.OK] (431.99ms) ``` ## Test Plan All existing tests pass. --------- Signed-off-by: Yuan Tang <terrytangyuan@gmail.com>

mergify bot added documentation Improvements or additions to documentation frontend labels Nov 4, 2024

K-Mistele reviewed Nov 7, 2024

View reviewed changes

vllm/entrypoints/openai/protocol.py Outdated Show resolved Hide resolved

mergify bot added the needs-rebase label Nov 7, 2024

gcalmettes added 2 commits November 8, 2024 16:47

feat: ignore tools in request if tool_choice=none

f2d659b

Signed-off-by: Guillaume Calmettes <gcalmettes@scaleway.com>

feat(doc): set auto tool_choice option as supported

bb9940b

Signed-off-by: Guillaume Calmettes <gcalmettes@scaleway.com>

gcalmettes force-pushed the feat/support-tool-choice-none branch from 43404a4 to a2710f5 Compare November 8, 2024 16:07

mergify bot removed the needs-rebase label Nov 8, 2024

gcalmettes force-pushed the feat/support-tool-choice-none branch 3 times, most recently from 0106ba4 to 118338b Compare November 8, 2024 16:34

feat: prevent tool parsing if tool_choice is 'none'

32a35fb

Signed-off-by: Guillaume Calmettes <gcalmettes@scaleway.com>

gcalmettes force-pushed the feat/support-tool-choice-none branch from 118338b to 32a35fb Compare November 8, 2024 16:37

DarkLight1337 reviewed Nov 9, 2024

View reviewed changes

docs/source/serving/openai_compatible_server.md Outdated Show resolved Hide resolved

feat(doc): be more explicit on which tool_choice options are supporte…

426e098

…d in the doc

DarkLight1337 approved these changes Nov 9, 2024

View reviewed changes

DarkLight1337 enabled auto-merge (squash) November 9, 2024 09:55

github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Nov 9, 2024

DarkLight1337 merged commit 36c513a into vllm-project:main Nov 12, 2024
58 of 60 checks passed

laserkelvin mentioned this pull request Jan 14, 2025

[Feature]: Allow setting tool_choice="none" in LLM calls if the OpenAI comaptible vllm server is started with --enable-auto-tool-choice #9426

Closed

1 task

terrytangyuan mentioned this pull request Feb 28, 2025

fix: Make remote::vllm compatible with vLLM <= v0.6.3 llamastack/llama-stack#1325

Merged

okdshin mentioned this pull request Jun 17, 2025

[Frontend] Expand tools even if tool_choice="none" #17177

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[BugFix] Do not raise a `ValueError` when `tool_choice` is set to the supported `none` option and `tools` are not defined. #10000

[BugFix] Do not raise a `ValueError` when `tool_choice` is set to the supported `none` option and `tools` are not defined. #10000

Uh oh!

gcalmettes commented Nov 4, 2024

Uh oh!

github-actions bot commented Nov 4, 2024

Uh oh!

DarkLight1337 commented Nov 5, 2024

Uh oh!

gcalmettes commented Nov 5, 2024

Uh oh!

K-Mistele commented Nov 7, 2024

Uh oh!

Uh oh!

mergify bot commented Nov 7, 2024

Uh oh!

Uh oh!

DarkLight1337 left a comment

Uh oh!

gcalmettes commented Nov 12, 2024

Uh oh!

DarkLight1337 commented Nov 12, 2024

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

[BugFix] Do not raise a ValueError when tool_choice is set to the supported none option and tools are not defined. #10000

[BugFix] Do not raise a ValueError when tool_choice is set to the supported none option and tools are not defined. #10000

Uh oh!

Conversation

gcalmettes commented Nov 4, 2024

PR Title and Classification

Code Quality

Adding or changing kernels

Notes for Large Changes

What to Expect for the Reviews

Thank You

Uh oh!

github-actions bot commented Nov 4, 2024

Uh oh!

DarkLight1337 commented Nov 5, 2024

Uh oh!

gcalmettes commented Nov 5, 2024

Uh oh!

K-Mistele commented Nov 7, 2024

Uh oh!

Uh oh!

mergify bot commented Nov 7, 2024

Uh oh!

Uh oh!

DarkLight1337 left a comment

Choose a reason for hiding this comment

Uh oh!

gcalmettes commented Nov 12, 2024

Uh oh!

DarkLight1337 commented Nov 12, 2024

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

[BugFix] Do not raise a `ValueError` when `tool_choice` is set to the supported `none` option and `tools` are not defined. #10000

[BugFix] Do not raise a `ValueError` when `tool_choice` is set to the supported `none` option and `tools` are not defined. #10000