fixup! [Feature]: Add OpenAI server prompt_logprobs support vllm-proj…

…ect#6508

tests/entrypoints/openai/test_completion.py

@@ -271,7 +271,7 @@ async def test_too_many_completion_logprobs(client: openai.AsyncOpenAI,
 @pytest.mark.asyncio
 @pytest.mark.parametrize(
     "model_name, prompt_logprobs",
-    [(MODEL_NAME, 1), (MODEL_NAME, 0), (MODEL_NAME, -1)],
+    [(MODEL_NAME, 1), (MODEL_NAME, 0), (MODEL_NAME, -1), (MODEL_NAME, None)],
 )
 async def test_prompt_logprobs_chat(client: openai.AsyncOpenAI,
                                     model_name: str, prompt_logprobs: int):
@@ -292,13 +292,13 @@ async def test_prompt_logprobs_chat(client: openai.AsyncOpenAI,
             "content": "Where was it played?"
         }],
         "model":
-        model_name,
-        "extra_body": {
-            "prompt_logprobs": prompt_logprobs
-        }
+        model_name
     }
 
-    if prompt_logprobs < 0:
+    if prompt_logprobs is not None:
+        params["extra_body"] = {"prompt_logprobs": prompt_logprobs}
+
+    if prompt_logprobs and prompt_logprobs < 0:
         with pytest.raises(BadRequestError) as err_info:
             await client.chat.completions.create(**params)
         expected_err_string = (
@@ -308,7 +308,7 @@ async def test_prompt_logprobs_chat(client: openai.AsyncOpenAI,
         assert str(err_info.value) == expected_err_string
     else:
         completion = await client.chat.completions.create(**params)
-        if prompt_logprobs > 0:
+        if prompt_logprobs and prompt_logprobs > 0:
             assert completion.prompt_logprobs is not None
             assert len(completion.prompt_logprobs) > 0
         else:
@@ -357,19 +357,19 @@ async def test_more_than_one_prompt_logprobs_chat(client: openai.AsyncOpenAI,
 @pytest.mark.asyncio
 @pytest.mark.parametrize("model_name, prompt_logprobs", [(MODEL_NAME, -1),
                                                          (MODEL_NAME, 0),
-                                                         (MODEL_NAME, 1)])
+                                                         (MODEL_NAME, 1),
+                                                         (MODEL_NAME, None)])
 async def test_prompt_logprobs_completion(client: openai.AsyncOpenAI,
                                           model_name: str,
                                           prompt_logprobs: int):
     params: Dict = {
         "prompt": ["A robot may not injure another robot", "My name is"],
         "model": model_name,
-        "extra_body": {
-            "prompt_logprobs": prompt_logprobs
-        }
     }
+    if prompt_logprobs is not None:
+        params["extra_body"] = {"prompt_logprobs": prompt_logprobs}
 
-    if prompt_logprobs < 0:
+    if prompt_logprobs and prompt_logprobs < 0:
         with pytest.raises(BadRequestError) as err_info:
             await client.completions.create(**params)
         expected_err_string = (
@@ -379,7 +379,7 @@ async def test_prompt_logprobs_completion(client: openai.AsyncOpenAI,
         assert str(err_info.value) == expected_err_string
     else:
         completion = await client.completions.create(**params)
-        if prompt_logprobs > 0:
+        if prompt_logprobs and prompt_logprobs > 0:
             assert completion.choices[0].prompt_logprobs is not None
             assert len(completion.choices[0].prompt_logprobs) > 0
 

vllm/entrypoints/openai/protocol.py

@@ -153,7 +153,7 @@ class ChatCompletionRequest(OpenAIBaseModel):
     skip_special_tokens: bool = True
     spaces_between_special_tokens: bool = True
     truncate_prompt_tokens: Optional[Annotated[int, Field(ge=1)]] = None
-    prompt_logprobs: int = 0
+    prompt_logprobs: Optional[int] = None
     # doc: end-chat-completion-sampling-params
 
     # doc: begin-chat-completion-extra-params
@@ -265,8 +265,8 @@ def to_sampling_params(
             stop=self.stop,
             stop_token_ids=self.stop_token_ids,
             logprobs=self.top_logprobs if self.logprobs else None,
-            prompt_logprobs=self.prompt_logprobs if self.prompt_logprobs > 0
-            else (self.top_logprobs if self.echo else None),
+            prompt_logprobs=self.prompt_logprobs if self.prompt_logprobs else
+            (self.top_logprobs if self.echo else None),
             ignore_eos=self.ignore_eos,
             max_tokens=max_tokens,
             min_tokens=self.min_tokens,
@@ -371,7 +371,7 @@ class CompletionRequest(OpenAIBaseModel):
     spaces_between_special_tokens: bool = True
     truncate_prompt_tokens: Optional[Annotated[int, Field(ge=1)]] = None
     allowed_token_ids: Optional[List[int]] = None
-    prompt_logprobs: int = 0
+    prompt_logprobs: Optional[int] = None
     # doc: end-completion-sampling-params
 
     # doc: begin-completion-extra-params
@@ -458,8 +458,8 @@ def to_sampling_params(
             min_tokens=self.min_tokens,
             use_beam_search=self.use_beam_search,
             early_stopping=self.early_stopping,
-            prompt_logprobs=self.prompt_logprobs if self.prompt_logprobs > 0
-            else self.logprobs if self.echo else None,
+            prompt_logprobs=self.prompt_logprobs
+            if self.prompt_logprobs else self.logprobs if self.echo else None,
             skip_special_tokens=self.skip_special_tokens,
             spaces_between_special_tokens=self.spaces_between_special_tokens,
             include_stop_str_in_output=self.include_stop_str_in_output,

vllm/entrypoints/openai/serving_chat.py

@@ -83,14 +83,15 @@ async def create_chat_completion(
         if error_check_ret is not None:
             return error_check_ret
 
-        if request.stream and request.prompt_logprobs > 0:
-            return self.create_error_response(
-                "Prompt_logprobs are not available when stream is enabled")
-
-        if request.prompt_logprobs < 0:
-            return self.create_error_response(
-                f"Prompt_logprobs set to invalid "
-                f"negative value: {request.prompt_logprobs}")
+        if request.prompt_logprobs is not None:
+            if request.stream and request.prompt_logprobs > 0:
+                return self.create_error_response(
+                    "Prompt_logprobs are not available when stream is enabled")
+
+            if request.prompt_logprobs < 0:
+                return self.create_error_response(
+                    f"Prompt_logprobs set to invalid "
+                    f"negative value: {request.prompt_logprobs}")
 
         try:
             (

vllm/entrypoints/openai/serving_completion.py

@@ -83,13 +83,15 @@ async def create_completion(self, request: CompletionRequest,
         model_name = self.served_model_names[0]
         request_id = f"cmpl-{random_uuid()}"
         created_time = int(time.time())
-        if request.stream and request.prompt_logprobs > 0:
-            return self.create_error_response(
-                "Prompt_logprobs are not available when stream is enabled")
-        elif request.prompt_logprobs < 0:
-            return self.create_error_response(
-                f"Prompt_logprobs set to invalid negative "
-                f"value: {request.prompt_logprobs}")
+
+        if request.prompt_logprobs is not None:
+            if request.stream and request.prompt_logprobs > 0:
+                return self.create_error_response(
+                    "Prompt_logprobs are not available when stream is enabled")
+            elif request.prompt_logprobs < 0:
+                return self.create_error_response(
+                    f"Prompt_logprobs set to invalid negative "
+                    f"value: {request.prompt_logprobs}")
 
         # Schedule the request and get the result generator.
         generators: List[AsyncGenerator[RequestOutput, None]] = []