docs: update resources docs #18991
Merged
docs: update resources docs #18991
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
dosubot
bot
added
the
size:M
masci
commented
Jun 6, 2025
| return StopEvent(result="Messages put into memory") | ||
| ``` | ||
|
|
||
| The `Resource` wrapper acts as both a type declaration and an executor. At definition time, it specifies the expected type using `Annotated` - for example, a `Memory` object. At runtime, it invokes the associated factory function, such as `get_memory`, to produce the actual instance. The return type of this function must match the declared type, ensuring consistency between what’s expected and what’s provided during execution. |
Contributor
Author
There was a problem hiding this comment.
I changed this bit because non technically true, Resource doesn't really declare a type.
| is passed to every step where it's injected. It's important to master this concept because cached and non-cached | ||
| resources can lead to unexpected behaviour, let's see it in detail. | ||
|
|
||
| ## Using Stateful Resources |
Contributor
Author
There was a problem hiding this comment.
This is the biggest change in this PR. I don't believe we can link statefulness to caching behaviour, addded a paragraph explaining their relationship at the end
AstraBert
reviewed
Jun 6, 2025
|
|
||
| If we disable caching with `Annotated[Memory, Resource(get_memory, cache=False)]`, the function `get_memory` is going | ||
| to be called multiple times but the resource instance will be always the same. Such a resource should be considered | ||
| stateful not regarding its caching behaviour. |
Member
There was a problem hiding this comment.
Yup, thanks a lot for bringing this up! When defining stateless VS stateful I didn't think of this, but yeah, this is definitely something that can happen!🙏
AstraBert
approved these changes
Jun 6, 2025
Member
|
It's good to go for me, but maybe it would be good if also @logan-markewich took a look at it before merging it :) |
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.
Description
Follow up for resources documentation