""" python3 -m unittest openai_server.basic.test_openai_server.TestOpenAIServer.test_completion python3 -m unittest openai_server.basic.test_openai_server.TestOpenAIServer.test_completion_stream python3 -m unittest openai_server.basic.test_openai_server.TestOpenAIServer.test_chat_completion python3 -m unittest openai_server.basic.test_openai_server.TestOpenAIServer.test_chat_completion_stream """ import json import re import unittest import numpy as np import openai import requests from sglang.srt.hf_transformers_utils import get_tokenizer from sglang.srt.utils import kill_process_tree from sglang.test.runners import TEST_RERANK_QUERY_DOCS from sglang.test.test_utils import ( DEFAULT_SMALL_CROSS_ENCODER_MODEL_NAME_FOR_TEST, DEFAULT_SMALL_MODEL_NAME_FOR_TEST, DEFAULT_TIMEOUT_FOR_SERVER_LAUNCH, DEFAULT_URL_FOR_TEST, CustomTestCase, popen_launch_server, ) class TestOpenAIServer(CustomTestCase): @classmethod def setUpClass(cls): cls.model = DEFAULT_SMALL_MODEL_NAME_FOR_TEST cls.base_url = DEFAULT_URL_FOR_TEST cls.api_key = "sk-123456" cls.process = popen_launch_server( cls.model, cls.base_url, timeout=DEFAULT_TIMEOUT_FOR_SERVER_LAUNCH, api_key=cls.api_key, ) cls.base_url += "/v1" cls.tokenizer = get_tokenizer(DEFAULT_SMALL_MODEL_NAME_FOR_TEST) @classmethod def tearDownClass(cls): kill_process_tree(cls.process.pid) def run_completion( self, echo, logprobs, use_list_input, parallel_sample_num, token_input ): client = openai.Client(api_key=self.api_key, base_url=self.base_url) prompt = "The capital of France is" if token_input: prompt_input = self.tokenizer.encode(prompt) num_prompt_tokens = len(prompt_input) else: prompt_input = prompt num_prompt_tokens = len(self.tokenizer.encode(prompt)) if use_list_input: prompt_arg = [prompt_input, prompt_input] num_choices = len(prompt_arg) num_prompt_tokens *= 2 else: prompt_arg = prompt_input num_choices = 1 response = client.completions.create( model=self.model, prompt=prompt_arg, temperature=0, max_tokens=32, echo=echo, logprobs=logprobs, n=parallel_sample_num, ) assert len(response.choices) == num_choices * parallel_sample_num if echo: text = response.choices[0].text assert text.startswith(prompt) if logprobs: assert response.choices[0].logprobs assert isinstance(response.choices[0].logprobs.tokens[0], str) assert isinstance(response.choices[0].logprobs.top_logprobs[1], dict) ret_num_top_logprobs = len(response.choices[0].logprobs.top_logprobs[1]) # FIXME: Sometimes, some top_logprobs are missing in the return value. The reason is that some output id maps to the same output token and duplicate in the map # assert ret_num_top_logprobs == logprobs, f"{ret_num_top_logprobs} vs {logprobs}" assert ret_num_top_logprobs > 0 # when echo=True and request.logprobs>0, logprob_start_len is 0, so the first token's logprob would be None. if not echo: assert response.choices[0].logprobs.token_logprobs[0] assert response.id assert response.created assert ( response.usage.prompt_tokens == num_prompt_tokens ), f"{response.usage.prompt_tokens} vs {num_prompt_tokens}" assert response.usage.completion_tokens > 0 assert response.usage.total_tokens > 0 def run_completion_stream( self, echo, logprobs, use_list_input, parallel_sample_num, token_input ): client = openai.Client(api_key=self.api_key, base_url=self.base_url) prompt = "The capital of France is" if token_input: prompt_input = self.tokenizer.encode(prompt) num_prompt_tokens = len(prompt_input) else: prompt_input = prompt num_prompt_tokens = len(self.tokenizer.encode(prompt)) if use_list_input: prompt_arg = [prompt_input, prompt_input] num_choices = len(prompt_arg) num_prompt_tokens *= 2 else: prompt_arg = prompt_input num_choices = 1 generator = client.completions.create( model=self.model, prompt=prompt_arg, temperature=0, max_tokens=32, echo=echo, logprobs=logprobs, stream=True, stream_options={"include_usage": True}, n=parallel_sample_num, ) is_firsts = {} for response in generator: usage = response.usage if usage is not None: assert usage.prompt_tokens > 0, f"usage.prompt_tokens was zero" assert usage.completion_tokens > 0, f"usage.completion_tokens was zero" assert usage.total_tokens > 0, f"usage.total_tokens was zero" continue index = response.choices[0].index is_first = is_firsts.get(index, True) if logprobs: assert response.choices[0].logprobs, f"no logprobs in response" assert isinstance( response.choices[0].logprobs.tokens[0], str ), f"{response.choices[0].logprobs.tokens[0]} is not a string" if not (is_first and echo): assert isinstance( response.choices[0].logprobs.top_logprobs[0], dict ), f"top_logprobs was not a dictionary" ret_num_top_logprobs = len( response.choices[0].logprobs.top_logprobs[0] ) # FIXME: Sometimes, some top_logprobs are missing in the return value. The reason is that some output id maps to the same output token and duplicate in the map # assert ret_num_top_logprobs == logprobs, f"{ret_num_top_logprobs} vs {logprobs}" assert ret_num_top_logprobs > 0, f"ret_num_top_logprobs was 0" if is_first: if echo: assert response.choices[0].text.startswith( prompt ), f"{response.choices[0].text} and all args {echo} {logprobs} {token_input} {is_first}" is_firsts[index] = False assert response.id, f"no id in response" assert response.created, f"no created in response" for index in [i for i in range(parallel_sample_num * num_choices)]: assert not is_firsts.get( index, True ), f"index {index} is not found in the response" def run_chat_completion(self, logprobs, parallel_sample_num): client = openai.Client(api_key=self.api_key, base_url=self.base_url) response = client.chat.completions.create( model=self.model, messages=[ {"role": "system", "content": "You are a helpful AI assistant"}, { "role": "user", "content": "What is the capital of France? Answer in a few words.", }, ], temperature=0, logprobs=logprobs is not None and logprobs > 0, top_logprobs=logprobs, n=parallel_sample_num, ) if logprobs: assert isinstance( response.choices[0].logprobs.content[0].top_logprobs[0].token, str ) ret_num_top_logprobs = len( response.choices[0].logprobs.content[0].top_logprobs ) assert ( ret_num_top_logprobs == logprobs ), f"{ret_num_top_logprobs} vs {logprobs}" assert len(response.choices) == parallel_sample_num assert response.choices[0].message.role == "assistant" assert isinstance(response.choices[0].message.content, str) assert response.id assert response.created assert response.usage.prompt_tokens > 0 assert response.usage.completion_tokens > 0 assert response.usage.total_tokens > 0 def run_chat_completion_stream(self, logprobs, parallel_sample_num=1): client = openai.Client(api_key=self.api_key, base_url=self.base_url) generator = client.chat.completions.create( model=self.model, messages=[ {"role": "system", "content": "You are a helpful AI assistant"}, {"role": "user", "content": "What is the capital of France?"}, ], temperature=0, logprobs=logprobs is not None and logprobs > 0, top_logprobs=logprobs, stream=True, stream_options={"include_usage": True}, n=parallel_sample_num, ) is_firsts = {} is_finished = {} for response in generator: usage = response.usage if usage is not None: assert usage.prompt_tokens > 0, f"usage.prompt_tokens was zero" assert usage.completion_tokens > 0, f"usage.completion_tokens was zero" assert usage.total_tokens > 0, f"usage.total_tokens was zero" continue index = response.choices[0].index finish_reason = response.choices[0].finish_reason if finish_reason is not None: is_finished[index] = True data = response.choices[0].delta if is_firsts.get(index, True): assert ( data.role == "assistant" ), f"data.role was not 'assistant' for first chunk" is_firsts[index] = False continue if logprobs and not is_finished.get(index, False): assert response.choices[0].logprobs, f"logprobs was not returned" assert isinstance( response.choices[0].logprobs.content[0].top_logprobs[0].token, str ), f"top_logprobs token was not a string" assert isinstance( response.choices[0].logprobs.content[0].top_logprobs, list ), f"top_logprobs was not a list" ret_num_top_logprobs = len( response.choices[0].logprobs.content[0].top_logprobs ) assert ( ret_num_top_logprobs == logprobs ), f"{ret_num_top_logprobs} vs {logprobs}" assert ( isinstance(data.content, str) or isinstance(data.reasoning_content, str) or (isinstance(data.tool_calls, list) and len(data.tool_calls) > 0) or response.choices[0].finish_reason ) assert response.id assert response.created for index in [i for i in range(parallel_sample_num)]: assert not is_firsts.get( index, True ), f"index {index} is not found in the response" def test_completion(self): for echo in [False, True]: for logprobs in [None, 5]: for use_list_input in [True, False]: for parallel_sample_num in [1, 2]: for token_input in [False, True]: self.run_completion( echo, logprobs, use_list_input, parallel_sample_num, token_input, ) def test_completion_stream(self): # parallel sampling and list input are not supported in streaming mode for echo in [False, True]: for logprobs in [None, 5]: for use_list_input in [True, False]: for parallel_sample_num in [1, 2]: for token_input in [False, True]: self.run_completion_stream( echo, logprobs, use_list_input, parallel_sample_num, token_input, ) def test_chat_completion(self): for logprobs in [None, 5]: for parallel_sample_num in [1, 2]: self.run_chat_completion(logprobs, parallel_sample_num) def test_chat_completion_stream(self): for logprobs in [None, 5]: for parallel_sample_num in [1, 2]: self.run_chat_completion_stream(logprobs, parallel_sample_num) def test_regex(self): client = openai.Client(api_key=self.api_key, base_url=self.base_url) regex = ( r"""\{\n""" + r""" "name": "[\w]+",\n""" + r""" "population": [\d]+\n""" + r"""\}""" ) response = client.chat.completions.create( model=self.model, messages=[ {"role": "system", "content": "You are a helpful AI assistant"}, {"role": "user", "content": "Introduce the capital of France."}, ], temperature=0, max_tokens=128, extra_body={"regex": regex}, ) text = response.choices[0].message.content try: js_obj = json.loads(text) except (TypeError, json.decoder.JSONDecodeError): print("JSONDecodeError", text) raise assert isinstance(js_obj["name"], str) assert isinstance(js_obj["population"], int) def test_penalty(self): client = openai.Client(api_key=self.api_key, base_url=self.base_url) response = client.chat.completions.create( model=self.model, messages=[ {"role": "system", "content": "You are a helpful AI assistant"}, {"role": "user", "content": "Introduce the capital of France."}, ], temperature=0, max_tokens=32, frequency_penalty=1.0, ) text = response.choices[0].message.content assert isinstance(text, str) def test_response_prefill(self): client = openai.Client(api_key=self.api_key, base_url=self.base_url) response = client.chat.completions.create( model="meta-llama/Llama-3.1-8B-Instruct", messages=[ {"role": "system", "content": "You are a helpful AI assistant"}, { "role": "user", "content": """ Extract the name, size, price, and color from this product description as a JSON object: The SmartHome Mini is a compact smart home assistant available in black or white for only $49.99. At just 5 inches wide, it lets you control lights, thermostats, and other connected devices via voice or app—no matter where you place it in your home. This affordable little hub brings convenient hands-free control to your smart devices. """, }, { "role": "assistant", "content": "{\n", }, ], temperature=0, extra_body={"continue_final_message": True}, ) assert ( response.choices[0] .message.content.strip() .startswith('"name": "SmartHome Mini",') ) def test_model_list(self): client = openai.Client(api_key=self.api_key, base_url=self.base_url) models = list(client.models.list()) assert len(models) == 1 assert isinstance(getattr(models[0], "max_model_len", None), int) def test_retrieve_model(self): client = openai.Client(api_key=self.api_key, base_url=self.base_url) # Test retrieving an existing model retrieved_model = client.models.retrieve(self.model) self.assertEqual(retrieved_model.id, self.model) self.assertEqual(retrieved_model.root, self.model) # Test retrieving a non-existent model with self.assertRaises(openai.NotFoundError): client.models.retrieve("non-existent-model") # ------------------------------------------------------------------------- # EBNF Test Class: TestOpenAIServerEBNF # Launches the server with xgrammar, has only EBNF tests # ------------------------------------------------------------------------- class TestOpenAIServerEBNF(CustomTestCase): @classmethod def setUpClass(cls): cls.model = DEFAULT_SMALL_MODEL_NAME_FOR_TEST cls.base_url = DEFAULT_URL_FOR_TEST cls.api_key = "sk-123456" # passing xgrammar specifically other_args = ["--grammar-backend", "xgrammar"] cls.process = popen_launch_server( cls.model, cls.base_url, timeout=DEFAULT_TIMEOUT_FOR_SERVER_LAUNCH, api_key=cls.api_key, other_args=other_args, ) cls.base_url += "/v1" cls.tokenizer = get_tokenizer(DEFAULT_SMALL_MODEL_NAME_FOR_TEST) @classmethod def tearDownClass(cls): kill_process_tree(cls.process.pid) def test_ebnf(self): """ Ensure we can pass `ebnf` to the local openai server and that it enforces the grammar. """ client = openai.Client(api_key=self.api_key, base_url=self.base_url) ebnf_grammar = r""" root ::= "Hello" | "Hi" | "Hey" """ pattern = re.compile(r"^(Hello|Hi|Hey)[.!?]*\s*$") response = client.chat.completions.create( model=self.model, messages=[ {"role": "system", "content": "You are a helpful EBNF test bot."}, {"role": "user", "content": "Say a greeting (Hello, Hi, or Hey)."}, ], temperature=0, max_tokens=32, extra_body={"ebnf": ebnf_grammar}, ) text = response.choices[0].message.content.strip() self.assertTrue(len(text) > 0, "Got empty text from EBNF generation") self.assertRegex(text, pattern, f"Text '{text}' doesn't match EBNF choices") def test_ebnf_strict_json(self): """ A stricter EBNF that produces exactly {"name":"Alice"} format with no trailing punctuation or extra fields. """ client = openai.Client(api_key=self.api_key, base_url=self.base_url) ebnf_grammar = r""" root ::= "{" pair "}" pair ::= "\"name\"" ":" string string ::= "\"" [A-Za-z]+ "\"" """ pattern = re.compile(r'^\{"name":"[A-Za-z]+"\}$') response = client.chat.completions.create( model=self.model, messages=[ {"role": "system", "content": "EBNF mini-JSON generator."}, { "role": "user", "content": "Generate single key JSON with only letters.", }, ], temperature=0, max_tokens=64, extra_body={"ebnf": ebnf_grammar}, ) text = response.choices[0].message.content.strip() self.assertTrue(len(text) > 0, "Got empty text from EBNF strict JSON test") self.assertRegex( text, pattern, f"Text '{text}' not matching the EBNF strict JSON shape" ) class TestOpenAIV1Rerank(CustomTestCase): @classmethod def setUpClass(cls): cls.model = DEFAULT_SMALL_CROSS_ENCODER_MODEL_NAME_FOR_TEST cls.base_url = DEFAULT_URL_FOR_TEST cls.api_key = "sk-123456" cls.score_tolerance = 1e-2 # Configure embedding-specific args other_args = [ "--is-embedding", "--enable-metrics", "--disable-radix-cache", "--chunked-prefill-size", "-1", "--attention-backend", "torch_native", ] cls.process = popen_launch_server( cls.model, cls.base_url, timeout=DEFAULT_TIMEOUT_FOR_SERVER_LAUNCH, api_key=cls.api_key, other_args=other_args, ) cls.base_url += "/v1/rerank" @classmethod def tearDownClass(cls): kill_process_tree(cls.process.pid) def run_rerank(self, query, docs): response = requests.post( self.base_url, headers={ "Authorization": f"Bearer {self.api_key}", "Content-Type": "application/json", }, json={"query": query, "documents": docs}, ) return response.json() def test_rerank_single(self): """Test single rerank request""" query = TEST_RERANK_QUERY_DOCS[0]["query"] docs = TEST_RERANK_QUERY_DOCS[0]["documents"] response = self.run_rerank(query, docs) self.assertEqual(len(response), 1) self.assertTrue(isinstance(response[0]["score"], float)) self.assertTrue(isinstance(response[0]["document"], str)) self.assertTrue(isinstance(response[0]["index"], int)) def test_rerank_batch(self): """Test batch rerank request""" query = TEST_RERANK_QUERY_DOCS[1]["query"] docs = TEST_RERANK_QUERY_DOCS[1]["documents"] response = self.run_rerank(query, docs) self.assertEqual(len(response), 2) self.assertTrue(isinstance(response[0]["score"], float)) self.assertTrue(isinstance(response[1]["score"], float)) self.assertTrue(isinstance(response[0]["document"], str)) self.assertTrue(isinstance(response[1]["document"], str)) self.assertTrue(isinstance(response[0]["index"], int)) self.assertTrue(isinstance(response[1]["index"], int)) class TestOpenAIV1Score(CustomTestCase): @classmethod def setUpClass(cls): cls.model = DEFAULT_SMALL_MODEL_NAME_FOR_TEST cls.base_url = DEFAULT_URL_FOR_TEST cls.api_key = "sk-123456" cls.process = popen_launch_server( cls.model, cls.base_url, timeout=DEFAULT_TIMEOUT_FOR_SERVER_LAUNCH, api_key=cls.api_key, ) cls.base_url += "/v1/score" cls.tokenizer = get_tokenizer(DEFAULT_SMALL_MODEL_NAME_FOR_TEST) @classmethod def tearDownClass(cls): kill_process_tree(cls.process.pid) def run_score( self, query, items, label_token_ids, apply_softmax=False, item_first=False ): response = requests.post( self.base_url, headers={ "Authorization": f"Bearer {self.api_key}", "Content-Type": "application/json", }, json={ "model": self.model, "query": query, "items": items, "label_token_ids": label_token_ids, "apply_softmax": apply_softmax, "item_first": item_first, }, ) return response.json() def test_score_text_input(self): """Test scoring with text input""" query = "The capital of France is" items = ["Paris", "London", "Berlin"] # Get valid token IDs from the tokenizer label_token_ids = [] for item in items: token_ids = self.tokenizer.encode(item, add_special_tokens=False) if not token_ids: self.fail(f"Failed to encode item: {item}") label_token_ids.append(token_ids[0]) response = self.run_score(query, items, label_token_ids, apply_softmax=True) # Handle error responses if response.get("type") == "BadRequestError": self.fail(f"Score request failed with error: {response['message']}") # Verify response structure self.assertIn("scores", response, "Response should have a 'scores' field") self.assertIsInstance(response["scores"], list, "scores should be a list") self.assertEqual( len(response["scores"]), len(items), "Number of scores should match number of items", ) # Each score should be a list of floats in the order of label_token_ids for i, score_list in enumerate(response["scores"]): self.assertIsInstance(score_list, list, f"Score {i} should be a list") self.assertEqual( len(score_list), len(label_token_ids), f"Score {i} length should match label_token_ids", ) self.assertTrue( all(isinstance(v, float) for v in score_list), f"Score {i} values should be floats", ) self.assertAlmostEqual( sum(score_list), 1.0, places=6, msg=f"Score {i} probabilities should sum to 1", ) def test_score_token_input(self): """Test scoring with token IDs input""" query = "The capital of France is" items = ["Paris", "London", "Berlin"] # Get valid token IDs query_ids = self.tokenizer.encode(query, add_special_tokens=False) item_ids = [ self.tokenizer.encode(item, add_special_tokens=False) for item in items ] label_token_ids = [ ids[0] for ids in item_ids if ids ] # Get first token ID of each item response = self.run_score( query_ids, item_ids, label_token_ids, apply_softmax=True ) # Handle error responses if response.get("type") == "BadRequestError": self.fail(f"Score request failed with error: {response['message']}") # Verify response structure self.assertIn("scores", response, "Response should have a 'scores' field") self.assertIsInstance(response["scores"], list, "scores should be a list") self.assertEqual( len(response["scores"]), len(items), "Number of scores should match number of items", ) # Each score should be a list of floats in the order of label_token_ids for i, score_list in enumerate(response["scores"]): self.assertIsInstance(score_list, list, f"Score {i} should be a list") self.assertEqual( len(score_list), len(label_token_ids), f"Score {i} length should match label_token_ids", ) self.assertTrue( all(isinstance(v, float) for v in score_list), f"Score {i} values should be floats", ) self.assertAlmostEqual( sum(score_list), 1.0, places=6, msg=f"Score {i} probabilities should sum to 1", ) def test_score_error_handling(self): """Test error handling for invalid inputs""" query = "The capital of France is" items = ["Paris", "London", "Berlin"] # Test with invalid token ID response = requests.post( self.base_url, headers={ "Authorization": f"Bearer {self.api_key}", "Content-Type": "application/json", }, json={ "model": self.model, "query": query, "items": items, "label_token_ids": [999999], # Invalid token ID "apply_softmax": True, }, ) self.assertEqual(response.status_code, 400) error_response = response.json() self.assertEqual(error_response["type"], "BadRequestError") self.assertIn("Token ID 999999 is out of vocabulary", error_response["message"]) if __name__ == "__main__": unittest.main()