JsonCheckpointStore.RetrieveIndexAsync(String, CheckpointInfo) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Asynchronously retrieves the collection of checkpoint information for the specified session identifier, optionally filtered by a parent checkpoint.
public abstract System.Threading.Tasks.ValueTask<System.Collections.Generic.IEnumerable<Microsoft.Agents.AI.Workflows.CheckpointInfo>> RetrieveIndexAsync(string sessionId, Microsoft.Agents.AI.Workflows.CheckpointInfo? withParent = default);abstract member RetrieveIndexAsync : string * Microsoft.Agents.AI.Workflows.CheckpointInfo -> System.Threading.Tasks.ValueTask<seq<Microsoft.Agents.AI.Workflows.CheckpointInfo>>Public MustOverride Function RetrieveIndexAsync (sessionId As String, Optional withParent As CheckpointInfo = Nothing) As ValueTask(Of IEnumerable(Of CheckpointInfo))Parameters
- sessionId
- String
The unique identifier of the session for which to retrieve checkpoint information. Cannot be null or empty.
- withParent
- CheckpointInfo
An optional parent checkpoint to filter the results. If specified, only checkpoints with the given parent are returned; otherwise, all checkpoints for the session are included.
Returns
A value task representing the asynchronous operation. The result contains a collection of CheckpointInfo objects associated with the specified session. The collection is empty if no checkpoints are found.