-
Notifications
You must be signed in to change notification settings - Fork 34
docs(agents): Update agent execution timeout documentation #2316
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.
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
base: master
Are you sure you want to change the base?
docs(agents): Update agent execution timeout documentation #2316
Conversation
Co-authored-by: kelvin.sundli <[email protected]>
Cursor Agent can help with this pull request. Just |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2316 +/- ##
==========================================
- Coverage 90.80% 90.79% -0.01%
==========================================
Files 168 168
Lines 25014 25014
==========================================
- Hits 22714 22712 -2
- Misses 2300 2302 +2
🚀 New features to boost your workflow:
|
I’m okay with introducing a higher timeout setting for these agent APIs that we expect to be «long running» |
That would be great @haakonvt . How would we do that? |
If you experience timeout errors, you can increase the timeout by setting: | ||
>>> client.config.timeout = 60 # Set timeout to 60 seconds | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ks93 If you change self._post
to self._do_request("POST", ...)
, I believe you can pass an override timeout
. Then I would suggest agents API calls were appropriate get bumped to 60 sec and even accept timeout directly, timeout: int = 60
Description
Added a note to the
agents.chat()
method docstring to inform users that agent execution can exceed the default 30-second timeout. The note provides guidance and an example on how to increase the client's timeout configuration to prevent potential timeout errors. This improves user experience by proactively addressing a common issue with long-running agent operations.Checklist:
If a new method has been added it should be referenced in cognite.rst in order to generate docs based on its docstring.