From 27b68303d043ddbddf9861c55c26bc8617ea7c35 Mon Sep 17 00:00:00 2001 From: ai-jz <156989844+ai-jz@users.noreply.github.com> Date: Tue, 13 Oct 2026 05:56:58 -0700 Subject: [PATCH] fix(openai): omit absent tool_calls from chat responses (#43027) Co-authored-by: ai-jz Co-authored-by: Xinyuan Tong --- .../sglang/srt/entrypoints/openai/protocol.py | 14 +++++ .../unit/entrypoints/openai/test_protocol.py | 51 +++++++++++++++++++ .../entrypoints/openai/test_serving_chat.py | 2 +- 3 files changed, 66 insertions(+), 1 deletion(-) diff --git a/python/sglang/srt/entrypoints/openai/protocol.py b/python/sglang/srt/entrypoints/openai/protocol.py index 7e7bf329a7..75dcb0585e 100644 --- a/python/sglang/srt/entrypoints/openai/protocol.py +++ b/python/sglang/srt/entrypoints/openai/protocol.py @@ -1212,6 +1212,13 @@ class ChatMessage(BaseModel): reasoning_content: Optional[str] = None tool_calls: Optional[List[ToolCall]] = Field(default=None, examples=[None]) + @model_serializer(mode="wrap") + def _serialize(self, handler): + data = handler(self) + if self.tool_calls is None: + data.pop("tool_calls", None) + return data + class ChatCompletionResponseChoice(BaseModel): index: int @@ -1286,6 +1293,13 @@ class ChatCompletionResponseStreamChoice(BaseModel): ] = None matched_stop: Union[None, int, str] = None + @model_serializer(mode="wrap") + def _serialize(self, handler): + data = handler(self) + if self.delta.tool_calls is None: + data["delta"].pop("tool_calls", None) + return data + class ChatCompletionStreamResponse(BaseModel): id: str diff --git a/test/registered/unit/entrypoints/openai/test_protocol.py b/test/registered/unit/entrypoints/openai/test_protocol.py index 7d53c3fe2a..1cae9d3b22 100644 --- a/test/registered/unit/entrypoints/openai/test_protocol.py +++ b/test/registered/unit/entrypoints/openai/test_protocol.py @@ -26,10 +26,15 @@ from sglang.srt.entrypoints.openai.protocol import ( ChatCompletionRequest, ChatCompletionResponse, ChatCompletionResponseChoice, + ChatCompletionResponseStreamChoice, + ChatCompletionStreamResponse, ChatMessage, CompletionRequest, + DeltaMessage, Function, + FunctionResponse, Tool, + ToolCall, UsageInfo, ) from sglang.test.ci.ci_register import register_cpu_ci @@ -566,6 +571,52 @@ class TestAudioContentParts(unittest.TestCase): class TestModelSerialization(unittest.TestCase): """Test model serialization with hidden states""" + def _chat_payloads(self, tool_calls): + response = ChatCompletionResponse( + id="chatcmpl-test", + model="test-model", + choices=[ + ChatCompletionResponseChoice( + index=0, + message=ChatMessage( + role="assistant", content="Hello", tool_calls=tool_calls + ), + finish_reason="stop", + ) + ], + usage=UsageInfo(prompt_tokens=1, completion_tokens=1, total_tokens=2), + ) + stream_response = ChatCompletionStreamResponse( + id="chatcmpl-test", + model="test-model", + choices=[ + ChatCompletionResponseStreamChoice( + index=0, + delta=DeltaMessage(content="Hello", tool_calls=tool_calls), + ) + ], + ) + return ( + json.loads(response.model_dump_json())["choices"][0]["message"], + json.loads(stream_response.model_dump_json())["choices"][0]["delta"], + ) + + def test_absent_tool_calls_are_omitted(self): + """Chat responses omit absent tool calls instead of emitting null.""" + for payload in self._chat_payloads(None): + self.assertNotIn("tool_calls", payload) + + def test_present_tool_calls_are_preserved(self): + tool_call = ToolCall( + id="call-1", + function=FunctionResponse(name="get_weather", arguments="{}"), + ) + for tool_calls in ([], [tool_call]): + expected = [tool.model_dump() for tool in tool_calls] + with self.subTest(tool_calls=expected): + for payload in self._chat_payloads(tool_calls): + self.assertEqual(payload["tool_calls"], expected) + def test_hidden_states_excluded_when_none(self): """Test that None hidden_states are excluded with exclude_none=True""" choice = ChatCompletionResponseChoice( diff --git a/test/registered/unit/entrypoints/openai/test_serving_chat.py b/test/registered/unit/entrypoints/openai/test_serving_chat.py index 768f6e7f54..274f03b4d3 100644 --- a/test/registered/unit/entrypoints/openai/test_serving_chat.py +++ b/test/registered/unit/entrypoints/openai/test_serving_chat.py @@ -4345,7 +4345,7 @@ class ServingChatTestCase(CustomTestCase): response = self.chat._build_chat_response(request, [ret], created=123) message = response.model_dump(mode="json")["choices"][0]["message"] self.assertEqual(message["content"], "" if tool_only else "Hello") - self.assertEqual(bool(message["tool_calls"]), tool_only) + self.assertEqual(bool(message.get("tool_calls")), tool_only) self._assert_empty_reasoning_replays(message) def test_empty_stream_reasoning_each_choice(self):