Skip to content

Replaced dummy example function with meaningful user data handler #1066

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Replaced dummy example function with meaningful user data handler #1066

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d60c78d
fix(docs): add missing await in streaming example
mutahirshah11 Jul 10, 2025
e327a6a
Improved example function for better clarity and realism.
mutahirshah11 Jul 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/streaming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ async def main():
instructions="You are a helpful assistant.",
)

result = Runner.run_streamed(agent, input="Please tell me 5 jokes.")
result = await Runner.run_streamed(agent, input="Please tell me 5 jokes.")
async for event in result.stream_events():
if event.type == "raw_response_event" and isinstance(event.data, ResponseTextDeltaEvent):
print(event.data.delta, end="", flush=True)
Expand Down Expand Up @@ -54,7 +54,7 @@ async def main():
tools=[how_many_jokes],
)

result = Runner.run_streamed(
result = await Runner.run_streamed(
agent,
input="Hello",
)
Expand Down
6 changes: 3 additions & 3 deletions docs/tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,8 +191,8 @@ from agents import RunContextWrapper, FunctionTool



def do_some_work(data: str) -> str:
return "done"
def process_user_data(username: str, age: int) -> str:
return f"{username} is {age} years old ."


class FunctionArgs(BaseModel):
Expand All @@ -202,7 +202,7 @@ class FunctionArgs(BaseModel):

async def run_function(ctx: RunContextWrapper[Any], args: str) -> str:
parsed = FunctionArgs.model_validate_json(args)
return do_some_work(data=f"{parsed.username} is {parsed.age} years old")
return process_user_data(parsed.username , parsed.age)


tool = FunctionTool(
Expand Down