o hD @sddlmZddlZddlZddlmZddlmZddlm Z m Z m Z m Z m Z mZddlmZmZddlmZmZddlmZmZdd lmZmZmZdd lmZdd lmZdd l m!Z!dd l"m#Z#m$Z$m%Z%m&Z&ddl'm(Z(ddl)m*Z*m+Z+ddl,m-Z-ddl.m/Z/m.Z.ddl0m1Z1ddl2m2Z2ddl3m4Z4ddl5m6Z6ddl7m8Z8ddl9m:Z:m;Z;ddlm?Z?ddl@mAZAe rddlBmCZCmDZDe%dZEe eEe fZFe e#e4e eEfe fZGe e#e8eEfe fZHe eFeEeGeEeHeEfZIeGdddZJeGd d!d!ZKeGd"d#d#ZLeGd$d%d%ZMeGd&d'd'ZNeGd(d)d)ZOeGd*d+d+ZPGd,d-d-e&ZQe ePgeAeQfZR eGd.d/d/ZSeGd0d1d1ZTeGd2d3d3ZUeGd4d5d5ZVe eVgeAeWfZX eGd6d7d7ZYe eKeLeMeNeSeYeUeTfZZ dWd>d?Z[e e4e e\geAeWfZ]edddd@dd@d@dAdXdPdQZ^edddd@dd@d@dAdYdSdQZ^ dZdddd@e[d@d@dAd[dVdQZ^dS)\) annotationsN) Awaitable) dataclass) TYPE_CHECKINGAnyCallableLiteralUnionoverload)FiltersRankingOptions)PendingSafetyCheckResponseComputerToolCall)LocalShellCallMcpApprovalRequest)CodeInterpreterImageGenerationMcp)r ) UserLocation)ValidationError) Concatenate NotRequired ParamSpec TypedDict)_debug) AsyncComputerComputer)ModelBehaviorError)DocstringStylefunction_schema)RunItem)logger)RunContextWrapper)ensure_strict_json_schema) ToolContext)ToolInputGuardrailToolOutputGuardrail) SpanError)_error_tracing)MaybeAwaitable)Agent AgentBase ToolParamsc@s*eZdZUded< ded< ded<dS)FunctionToolResult FunctionTooltoolroutputr!run_itemN)__name__ __module__ __qualname____annotations__r7r7L/var/www/html/openai_agents/venv/lib/python3.10/site-packages/agents/tool.pyr.3s r.c@szeZdZUdZded< ded< ded< ded< d Zd ed < d Zd ed < dZded< dZded< ddZ dS)r/zA tool that wraps a function. In most cases, you should use the `function_tool` helpers to create a FunctionTool, as they let you easily wrap a Python function. strname descriptionzdict[str, Any]params_json_schemaz1Callable[[ToolContext[Any], str], Awaitable[Any]]on_invoke_toolTboolstrict_json_schemaJbool | Callable[[RunContextWrapper[Any], AgentBase], MaybeAwaitable[bool]] is_enabledNz$list[ToolInputGuardrail[Any]] | Nonetool_input_guardrailsz%list[ToolOutputGuardrail[Any]] | Nonetool_output_guardrailscCs|jr t|j|_dSdSN)r?r$r<selfr7r7r8 __post_init__iszFunctionTool.__post_init__) r3r4r5__doc__r6r?rArBrCrGr7r7r7r8r/?s&      r/c@s`eZdZUdZded< dZded< dZded < dZd ed < dZd ed < e ddZ dS)FileSearchToolzA hosted tool that lets the LLM search through a vector store. Currently only supported with OpenAI models, using the Responses API. z list[str]vector_store_idsNz int | Nonemax_num_resultsFr>include_search_resultszRankingOptions | Noneranking_optionszFilters | NonefilterscCdS)N file_searchr7rEr7r7r8r:zFileSearchTool.name) r3r4r5rHr6rKrLrMrNpropertyr:r7r7r7r8rIns     rIc@sHeZdZUdZdZded< dZded< dZded < ed d Z dS) WebSearchToolz~A hosted tool that lets the LLM search the web. Currently only supported with OpenAI models, using the Responses API. NzUserLocation | None user_locationzWebSearchToolFilters | NonerNmediumz Literal['low', 'medium', 'high']search_context_sizecCrO)N web_searchr7rEr7r7r8r:rQzWebSearchTool.name) r3r4r5rHrTr6rNrVrRr:r7r7r7r8rSs    rSc@6eZdZUdZded< dZded< eddZdS) ComputerToolz3A hosted tool that lets the LLM control a computer.zComputer | AsyncComputercomputerNzDCallable[[ComputerToolSafetyCheckData], MaybeAwaitable[bool]] | Noneon_safety_checkcCrO)Ncomputer_use_previewr7rEr7r7r8r:rQzComputerTool.name)r3r4r5rHr6r[rRr:r7r7r7r8rYs  rYc@s8eZdZUdZded< ded< ded< ded <d S) ComputerToolSafetyCheckDataz/Information about a computer tool safety check.RunContextWrapper[Any] ctx_wrapperz Agent[Any]agentr tool_callr safety_checkNr3r4r5rHr6r7r7r7r8r]s r]c@$eZdZUdZded< ded<dS)MCPToolApprovalRequestz!A request to approve a tool call.r^r_rdataNrcr7r7r7r8re rec@rd)MCPToolApprovalFunctionResultz,The result of an MCP tool approval function.r>approvezNotRequired[str]reasonNrcr7r7r7r8rhs rhc@rX) HostedMCPToolaA tool that allows the LLM to use a remote MCP server. The LLM will automatically list and call tools, without requiring a round trip back to your code. If you want to run MCP servers locally via stdio, in a VPC or other non-publicly-accessible environment, or you just prefer to run tool calls locally, then you can instead use the servers in `agents.mcp` and pass `Agent(mcp_servers=[...])` to the agent.r tool_configNzMCPToolApprovalFunction | Noneon_approval_requestcCrO)N hosted_mcpr7rEr7r7r8r:rQzHostedMCPTool.name)r3r4r5rHr6rmrRr:r7r7r7r8rks  rkc@(eZdZUdZded< eddZdS)CodeInterpreterToolzFA tool that allows the LLM to execute code in a sandboxed environment.rrlcCrO)Ncode_interpreterr7rEr7r7r8r:rQzCodeInterpreterTool.nameNr3r4r5rHr6rRr:r7r7r7r8rp rpc@ro)ImageGenerationToolz.A tool that allows the LLM to generate images.rrlcCrO)Nimage_generationr7rEr7r7r8r:rQzImageGenerationTool.nameNrrr7r7r7r8rtrsrtc@rd)LocalShellCommandRequestz*A request to execute a command on a shell.r^r_rrfNrcr7r7r7r8rvrgrvc@ro)LocalShellToolzA tool that allows the LLM to execute commands on a shell. For more details, see: https://platform.openai.com/docs/guides/tools-local-shell LocalShellExecutorexecutorcCrO)N local_shellr7rEr7r7r8r: rQzLocalShellTool.nameNrrr7r7r7r8rws rwctxr^error Exceptionreturnr9cCsdt|S)zLThe default tool error function, which just returns a generic error message.zCAn error occurred while running the tool. Please try again. Error: )r9)r{r|r7r7r8default_tool_error_function2srT name_overridedescription_overridedocstring_styleuse_docstring_infofailure_error_function strict_moderAfuncToolFunction[...]r str | NonerrDocstringStyle | Nonerr>rToolErrorFunction | NonerrAr@cCrO)z6Overload for usage as @function_tool (no parentheses).Nr7)rrrrrrrrAr7r7r8 function_tool:s r+Callable[[ToolFunction[...]], FunctionTool]cCrO)z*Overload for usage as @function_tool(...).Nr7rr7r7r8rJs ToolFunction[...] | None:FunctionTool | Callable[[ToolFunction[...]], FunctionTool]c s<d fdd t|r|Sd fdd }|S) a) Decorator to create a FunctionTool from a function. By default, we will: 1. Parse the function signature to create a JSON schema for the tool's parameters. 2. Use the function's docstring to populate the tool's description. 3. Use the function's docstring to populate argument descriptions. The docstring style is detected automatically, but you can override it. If the function takes a `RunContextWrapper` as the first argument, it *must* match the context type of the agent that uses the tool. Args: func: The function to wrap. name_override: If provided, use this name for the tool instead of the function's name. description_override: If provided, use this description for the tool instead of the function's docstring. docstring_style: If provided, use this style for the tool's docstring. If not provided, we will attempt to auto-detect the style. use_docstring_info: If True, use the function's docstring to populate the tool's description and argument descriptions. failure_error_function: If provided, use this function to generate an error message when the tool call fails. The error message is sent to the LLM. If you pass None, then no error message will be sent and instead an Exception will be raised. strict_mode: Whether to enable strict mode for the tool's JSON schema. We *strongly* recommend setting this to True, as it increases the likelihood of correct JSON input. If False, it allows non-strict JSON schemas. For example, if a parameter has a default value, it will be optional, additional properties are allowed, etc. See here for more: https://platform.openai.com/docs/guides/structured-outputs?api-mode=responses#supported-schemas is_enabled: Whether the tool is enabled. Can be a bool or a callable that takes the run context and agent and returns whether the tool is enabled. Disabled tools are hidden from the LLM at runtime. the_funcrr~r/csTt ddfdd dfd d }tjjp"d j|d S)N)rrrrrr?r{ToolContext[Any]inputr9r~rc sz |r t|ni}Wn1ty=}z%tjr!tdjn tdjd|tdjd||d}~wwtjrKtdjn tdjd|z|rbj d i|n }Wnt y}z tdjd||d}~ww |\}}tjstd|d|t rjr|g|Ri|IdH}n!|i|IdH}njrƈ|g|Ri|}n|i|}tjrtdjd|Stdjd ||S) NzInvalid JSON input for tool z: zInvoking tool z with input zTool call args: z , kwargs: zTool z completed.z returned r7)jsonloadsr}rDONT_LOG_TOOL_DATAr"debugr:rparams_pydantic_modelr to_call_argsinspectiscoroutinefunction takes_context)r{r json_dataeparsedargs kwargs_dictresult)schemarr7r8_on_invoke_tool_implsR  zJfunction_tool.._create_function_tool.._on_invoke_tool_implc sz ||IdHWStyG}z1dur||}t|r,|IdHWYd}~Sttdjt|dd|WYd}~Sd}~ww)NzError running tool (non-fatal)) tool_namer|)messagerf)r}r isawaitabler)attach_error_to_current_spanr(r:r9)r{rrr)rrrr7r8_on_invoke_tools(   zEfunction_tool.._create_function_tool.._on_invoke_tool)r:r;r<r=r?rA)r{rrr9r~r)r r/r:r;r<)rr)rrrrArrr)rrrr8_create_function_tools$ 1z,function_tool.._create_function_tool real_funccs|SrDr7)r)rr7r8 decoratorsz function_tool..decoratorN)rrr~r/)rrr~r/)callable) rrrrrrrrArr7)rrrrrArrrr8rYs +[)r{r^r|r}r~r9)rrrrrrrrrr>rrrr>rAr@r~r/)rrrrrrrr>rrrr>rAr@r~rrD)rrrrrrrrrr>rrrr>rAr@r~r)_ __future__rrrcollections.abcr dataclassesrtypingrrrrr r -openai.types.responses.file_search_tool_paramr r 2openai.types.responses.response_computer_tool_callr r+openai.types.responses.response_output_itemrr!openai.types.responses.tool_paramrrr&openai.types.responses.web_search_toolWebSearchToolFilters,openai.types.responses.web_search_tool_paramrpydanticrtyping_extensionsrrrrrrrZrr exceptionsrr ritemsr!r" run_contextr# strict_schemar$ tool_contextr%tool_guardrailsr&r'tracingr(utilr) util._typesr*r`r+r,r-ToolFunctionWithoutContextToolFunctionWithContextToolFunctionWithToolContext ToolFunctionr.r/rIrSrYr]rerhMCPToolApprovalFunctionrkrprtrvr9rxrwToolrr}ToolErrorFunctionrr7r7r7r8s                   .