Add documentation for agents #55
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pierrevalade
approved these changes
Feb 13, 2025
There was a problem hiding this comment.
I really like these changes. I think having a consistent @agent decorator and then using .run or .stream on the agent class instance is much clearer, and allows for more flexibility (for the same agent, you can decide to stream, or not, at the run-level).
I'll work on updating the SDK documentation accordingly, also.
| # It is possible to call the run function directly to get a run object if needed | ||
| run = await agent.run(CallFeedbackInput(...)) | ||
| # Or the stream function to get a stream of run objects (see below) | ||
| chunks = [chunk async for chunk in agent.stream(CallFeedbackInput(...)) |
There was a problem hiding this comment.
@guillaq could you please clarify how to print the chunk as they arrive?
There was a problem hiding this comment.
actually, I think I've got it. Let me try! :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Set the docstring for agents. Also fix the types so that cursor knows that agent functions are available on all agents