Document `State`

[anakin87]

State is a class that can be used to store information (such as documents or context) that tools can read from or write to during execution. We use it when building Agents.

Currently, it is not much documented.

We should find a way to explain this concept clearly, perhaps also showing how it works in a tutorial/cookbook.

This task will probably require some initial work and the contribution of an engineer who is familiar with this abstraction.

[Ujjwal-Bajpayee]

Hi, I’ve opened PR #9746 that expands the State class docstring with more explanation and a minimal usage snippet. Please let me know if you’d like me to adjust or add a separate example.

[anakin87]

@Ujjwal-Bajpayee thanks for your contribution.

To clarify: what I meant is creating a documentation page in https://docs.haystack.deepset.ai/ that explains this abstraction. I think we should handle this task internally, since we are more familiar with this undocumented abstraction.

Sorry for not being more specific in the initial issue. You can find a list of contributions wanted here.

[Ujjwal-Bajpayee]

Thanks for clarifying, that makes sense. I’ll look into the contributions wanted list for other issues where I can help. Appreciate the guidance!