Open-source Python library for AI browser agents, plus Browser Use Cloud: stealth browsers and a hosted agent API.
Python ai-agentsai-toolsbrowser-agentbrowser-automationbrowser-usecdpcloud-browsercomputer-useheadless-browserllmmcpplaywrightpythonremote-browserstealth-browserweb-automationweb-scraping
fix(openai): structured output call shouldn't depend on schema injection
Laith Weinberger1629799dd395
diff --git a/browser_use/llm/openai/chat.py b/browser_use/llm/openai/chat.pyindex 464b3debe..8b75eb54c 100644--- a/browser_use/llm/openai/chat.py+++ b/browser_use/llm/openai/chat.py@@ -246,20 +246,20 @@ class ChatOpenAI(BaseChatModel):ChatCompletionContentPartTextParam(text=schema_text, type='text')]- if self.dont_force_structured_output:- response = await self.get_client().chat.completions.create(- model=self.model,- messages=openai_messages,- **model_params,- )- else:- # Return structured response- response = await self.get_client().chat.completions.create(- model=self.model,- messages=openai_messages,- response_format=ResponseFormatJSONSchema(json_schema=response_format, type='json_schema'),- **model_params,- )+ if self.dont_force_structured_output:+ response = await self.get_client().chat.completions.create(+ model=self.model,+ messages=openai_messages,+ **model_params,+ )+ else:+ # Return structured response+ response = await self.get_client().chat.completions.create(+ model=self.model,+ messages=openai_messages,+ response_format=ResponseFormatJSONSchema(json_schema=response_format, type='json_schema'),+ **model_params,+ )choice = response.choices[0] if response.choices else Noneif choice is None:diff --git a/tests/ci/test_openai_invalid_response.py b/tests/ci/test_openai_invalid_response.pynew file mode 100644index 000000000..90defcc47--- /dev/null+++ b/tests/ci/test_openai_invalid_response.py@@ -0,0 +1,86 @@+"""+Regression tests for GitHub Issue #3897.++Some OpenAI-compatible proxies return HTTP 200 with an invalid body such as+`choices: null`. Browser Use should not crash by indexing `choices[0]`; it+should raise a clear ModelProviderError instead.+"""++import time++import httpx+import pytest+from pydantic import BaseModel+++class _DummyOutput(BaseModel):+ ok: bool+++class TestChatOpenAIInvalidResponse:+ @pytest.mark.asyncio+ async def test_choices_null_non_structured(self):+ from browser_use import ChatOpenAI+ from browser_use.llm.exceptions import ModelProviderError+ from browser_use.llm.messages import UserMessage++ def handler(request: httpx.Request) -> httpx.Response:+ body = {+ 'id': 'chatcmpl-proxy-fake-12345',+ 'object': 'chat.completion',+ 'created': int(time.time()),+ 'model': 'proxy-model',+ 'choices': None,+ }+ return httpx.Response(200, json=body)++ transport = httpx.MockTransport(handler)+ async with httpx.AsyncClient(transport=transport) as http_client:+ llm = ChatOpenAI(+ model='proxy-model',+ base_url='http://proxy.local/v1',+ api_key='fake-key-not-needed',+ http_client=http_client,+ max_retries=0,+ )++ with pytest.raises(ModelProviderError) as excinfo:+ await llm.ainvoke([UserMessage(content='hi')])++ assert 'choices' in excinfo.value.message+ assert '/v1/chat/completions' in excinfo.value.message++ @pytest.mark.asyncio+ async def test_choices_null_structured(self):+ from browser_use import ChatOpenAI+ from browser_use.llm.exceptions import ModelProviderError+ from browser_use.llm.messages import UserMessage++ def handler(request: httpx.Request) -> httpx.Response:+ body = {+ 'id': 'chatcmpl-proxy-fake-12345',+ 'object': 'chat.completion',+ 'created': int(time.time()),+ 'model': 'proxy-model',+ 'choices': None,+ }+ return httpx.Response(200, json=body)++ transport = httpx.MockTransport(handler)+ async with httpx.AsyncClient(transport=transport) as http_client:+ llm = ChatOpenAI(+ model='proxy-model',+ base_url='http://proxy.local/v1',+ api_key='fake-key-not-needed',+ http_client=http_client,+ max_retries=0,+ # Exercise the default structured-output path (schema injection disabled by default).+ add_schema_to_system_prompt=False,+ dont_force_structured_output=False,+ )++ with pytest.raises(ModelProviderError) as excinfo:+ await llm.ainvoke([UserMessage(content='hi')], output_format=_DummyOutput)++ assert 'choices' in excinfo.value.message+ assert '/v1/chat/completions' in excinfo.value.message