admin-valentin/openai-agents-python
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add docs for customizng agent-as-tool (#504)

Browse source 
Co-authored-by: pakrym-oai <pakrym@openai.com>
This commit is contained in:
Rohan Mehta 2025-04-14 12:40:32 -04:00 committed by GitHub
parent 25f97f979b
commit 5183f528f4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 21 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/tools.md
View file

@ -259,6 +259,27 @@ async def main():
print(result.final_output) print(result.final_output)
``` ```
### Customizing tool-agents
The `agent.as_tool` function is a convenience method to make it easy to turn an agent into a tool. It doesn't support all configuration though; for example, you can't set `max_turns`. For advanced use cases, use `Runner.run` directly in your tool implementation:
```python
@function_tool
async def run_my_agent() -> str:
"""A tool that runs the agent with custom configs".
agent = Agent(name="My agent", instructions="...")
result = await Runner.run(
agent,
input="...",
max_turns=5,
run_config=...
)
return str(result.final_output)
```
## Handling errors in function tools ## Handling errors in function tools
When you create a function tool via `@function_tool`, you can pass a `failure_error_function`. This is a function that provides an error response to the LLM in case the tool call crashes. When you create a function tool via `@function_tool`, you can pass a `failure_error_function`. This is a function that provides an error response to the LLM in case the tool call crashes.