tool_choice naming a function tool called web_search, file_search, mcp, etc. selects the built-in tool instead

Aperta Adatta ai principianti
  • Qualcosa non va?
#5,472 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
70/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
api

Direzione di ricerca

Inizia da Converter.convert_tool_choice in src/agents/models/openai_responses.py, dove i nomi di strumenti integrati come web_search vengono mappati prima del ramo delle funzioni con nome, e confrontalo con il controllo esistente per shell e apply_patch. Esegui il repro della issue con un httpx2 MockTransport per confermare che tool_choice venga inviato come {'type': 'web_search'} mentre gli strumenti della richiesta contengono solo la funzione. Il lavoro è completo quando uno strumento di funzione configurato di nome web_search produce {'type': 'function', 'name': 'web_search'}, e quando non ci sono strumenti o è configurato un WebSearchTool viene comunque restituito il selettore integrato e tests/models passa.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Please read this first
  • Have you read the docs? Yes
  • Have you searched for related issues? Yes. #4952 fixed this for shell and apply_patch, and computer and tool_search are already gated with tests. The other built-in names were left out.
Describe the bug

An agent on the Responses API has a function tool whose name matches a built-in tool type, for example its own web_search backed by another search API. Setting ModelSettings(tool_choice="web_search") to force that tool sends tool_choice={"type": "web_search"}, which selects the hosted web search tool, instead of {"type": "function", "name": "web_search"}. The request's tools list contains only the function, so the caller's tool can't be forced. The same happens for file_search, web_search_preview, computer_use_preview (with no ComputerTool), image_generation, code_interpreter, mcp and programmatic_tool_calling.

#4952 described exactly this for shell and apply_patch: without a gate, "a function tool named shell or apply_patch would silently stop being targetable".

Debug information
  • Agents SDK version: main (e355d69), also 0.24.0
  • Related library versions: openai 3.29.0
  • Python version: 3.14.7
  • Operating system: macOS
  • Model and model provider: OpenAI Responses API
  • Does the issue reproduce with the latest Agents SDK release? Yes
  • Does the issue occur consistently or intermittently? Consistently
Repro steps

A real AsyncOpenAI client on an httpx2.MockTransport, printing what's sent:

import asyncio, json
import httpx2
from openai import AsyncOpenAI
from agents import Agent, ModelSettings, OpenAIResponsesModel, RunConfig, Runner, function_tool

def handler(request: httpx2.Request) -> httpx2.Response:
    body = json.loads(request.content)
    print("tools sent      :", [(t["type"], t.get("name")) for t in body["tools"]])
    print("tool_choice sent:", body["tool_choice"])
    return httpx2.Response(200, json={
        "id": "resp_1", "object": "response", "created_at": 0, "model": "gpt-4.1",
        "status": "completed", "parallel_tool_calls": True, "tool_choice": "auto", "tools": [],
        "output": [{"type": "message", "id": "msg_1", "role": "assistant", "status": "completed",
                    "content": [{"type": "output_text", "text": "ok", "annotations": []}]}],
    })

@function_tool(name_override="web_search")
def my_search(query: str) -> str:
    """Search my own index."""
    return "result"

async def main() -> None:
    client = AsyncOpenAI(api_key="x", http_client=httpx2.AsyncClient(transport=httpx2.MockTransport(handler)))
    agent = Agent(name="a", tools=[my_search], model=OpenAIResponsesModel("gpt-4.1", client),
                  model_settings=ModelSettings(tool_choice="web_search"))
    await Runner.run(agent, "find docs", run_config=RunConfig(tracing_disabled=True))

asyncio.run(main())

tools sent      : [('function', 'web_search')]
tool_choice sent: {'type': 'web_search'}
Expected behavior

tool_choice is {"type": "function", "name": "web_search"} whenever a function tool (or handoff) with that name is configured, as already happens for shell, apply_patch, computer and tool_search.

Root cause and a possible fix

Converter.convert_tool_choice maps these strings to built-in selectors before the named-function branch and doesn't look at the configured tools (openai_responses.py#L1856-L1894). The shell/apply_patch branches are gated (#L1895-L1902). The gate below checks that a local function tool with that name exists, not that the built-in is configured, so prompt-managed built-in tools (#1304) keep working:

--- a/src/agents/models/openai_responses.py
+++ b/src/agents/models/openai_responses.py
+# Strings that convert_tool_choice maps to a built-in tool selector without checking
+# whether that built-in tool is configured.
+_HOSTED_TOOL_CHOICE_NAMES = frozenset(
+    {
+        "programmatic_tool_calling",
+        "file_search",
+        "web_search",
+        "web_search_preview",
+        "computer_use_preview",
+        "image_generation",
+        "code_interpreter",
+        "mcp",
+    }
+)
@@ class Converter:
         elif tool_choice == "none":
             return "none"
+        elif tool_choice in _HOSTED_TOOL_CHOICE_NAMES and cls._has_top_level_function_named(
+            tool_choice, tools=tools, handoffs=handoffs
+        ):
+            # Like computer, shell and apply_patch, a function tool with a built-in tool's
+            # name must stay targetable.
+            return {"type": "function", "name": tool_choice}
         elif tool_choice == "programmatic_tool_calling":
@@ class Converter:
+    @classmethod
+    def _has_top_level_function_named(
+        cls,
+        name: str,
+        *,
+        tools: Sequence[Tool] | None,
+        handoffs: Sequence[Handoff[Any, Any]] | None,
+    ) -> bool:
+        return any(handoff.tool_name == name for handoff in handoffs or ()) or any(
+            isinstance(tool, FunctionTool)
+            and tool.name == name
+            and get_explicit_function_tool_namespace(tool) is None
+            and not tool.defer_loading
+            for tool in tools or ()
+        )

With the patch, the repro sends {'type': 'function', 'name': 'web_search'}. With no tools, or with a configured WebSearchTool(), "web_search" still maps to {'type': 'web_search'}. tests/models passes (1023 passed, 1 skipped).

Lingua principale
Python
Stelle
30.4k
Fork
4.9k
Merge medio
16h 32m
PR unite (30g)
85

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di openai/openai-agents-python

Tutte le issue di openai/openai-agents-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.