Skip to content

Fix spelling, grammar, and minor formatting issues in running agents documentation #1128

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

Merged
merged 2 commits into from
Jul 18, 2025
Merged

Fix spelling, grammar, and minor formatting issues in running agents documentation #1128

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46f19e3
Fix spelling, grammar, and minor formatting issues in running agents …
mshsheikh Jul 15, 2025
c6f3bda
Fix typos and formatting; revert API naming change
mshsheikh Jul 16, 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
7 changes: 4 additions & 3 deletions docs/running_agents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ async def main():
print(result.final_output)
# Code within the code,
# Functions calling themselves,
# Infinite loop's dance.
# Infinite loop's dance
```

Read more in the [results guide](results.md).

## The agent loop

When you use the run method in `Runner`, you pass in a starting agent and input. The input can either be a string (which is considered a user message), or a list of input items, which are the items in the OpenAI Responses API.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Responses API is the correct name; please revert this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I’ve reverted the terminology back to “OpenAI Responses API” throughout the section.
Please let me know if there’s anything else that needs adjustment.

When you use the run method in `Runner`, you pass in a starting agent and input. The input can either be a string (which is considered a user message), or a list of input items, which are the items in the OpenAI Response API.

The runner then runs a loop:

Expand All @@ -40,7 +40,7 @@ The runner then runs a loop:

## Streaming

Streaming allows you to additionally receive streaming events as the LLM runs. Once the stream is done, the [`RunResultStreaming`][agents.result.RunResultStreaming] will contain the complete information about the run, including all the new outputs produces. You can call `.stream_events()` for the streaming events. Read more in the [streaming guide](streaming.md).
Streaming allows you to additionally receive streaming events as the LLM runs. Once the stream is done, the [`RunResultStreaming`][agents.result.RunResultStreaming] will contain the complete information about the run, including all the new outputs produced. You can call `.stream_events()` for the streaming events. Read more in the [streaming guide](streaming.md).

## Run config

Expand Down Expand Up @@ -73,6 +73,7 @@ You can manually manage conversation history using the [`RunResultBase.to_input_
async def main():
agent = Agent(name="Assistant", instructions="Reply very concisely.")

thread_id = "thread_123" # Example thread ID
with trace(workflow_name="Conversation", group_id=thread_id):
# First turn
result = await Runner.run(agent, "What city is the Golden Gate Bridge in?")
Expand Down