mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Jacob AlberandGitHub
c73bd87503
* [BREAKING] refactor: Decouple Checkpointing and Execution APIs With this change, Checkpointing becomes an property of an IWorkflowExecutionEnvironment. This lets environments that are tightly-coupled to their CheckpointManager avoid needing to present APIs that would not work (e.g. taking in an InMemory CheckpointManager for Durable Tasks, for example) * refactor: Normalize IsCheckpointingEnabled naming
43 lines
2.4 KiB
C#
43 lines
2.4 KiB
C#
// Copyright (c) Microsoft. All rights reserved.
|
|
|
|
using System.Collections.Generic;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace Microsoft.Agents.AI.Workflows.Checkpointing;
|
|
|
|
/// <summary>
|
|
/// A manager for storing and retrieving workflow execution checkpoints.
|
|
/// </summary>
|
|
internal interface ICheckpointManager
|
|
{
|
|
/// <summary>
|
|
/// Commits the specified checkpoint and returns information that can be used to retrieve it later.
|
|
/// </summary>
|
|
/// <param name="runId">The identifier for the current run or execution context.</param>
|
|
/// <param name="checkpoint">The checkpoint to commit.</param>
|
|
/// <returns>A <see cref="CheckpointInfo"/> representing the incoming checkpoint.</returns>
|
|
ValueTask<CheckpointInfo> CommitCheckpointAsync(string runId, Checkpoint checkpoint);
|
|
|
|
/// <summary>
|
|
/// Retrieves the checkpoint associated with the specified checkpoint information.
|
|
/// </summary>
|
|
/// <param name="runId">The identifier for the current run of execution context.</param>
|
|
/// <param name="checkpointInfo">The information used to identify the checkpoint.</param>
|
|
/// <returns>A <see cref="ValueTask{TResult}"/> representing the asynchronous operation. The result contains the <see
|
|
/// cref="Checkpoint"/> associated with the specified <paramref name="checkpointInfo"/>.</returns>
|
|
/// <exception cref="KeyNotFoundException">Thrown if the checkpoint is not found.</exception>
|
|
ValueTask<Checkpoint> LookupCheckpointAsync(string runId, CheckpointInfo checkpointInfo);
|
|
|
|
/// <summary>
|
|
/// Asynchronously retrieves the collection of checkpoint information for the specified run identifier, optionally
|
|
/// filtered by a parent checkpoint.
|
|
/// </summary>
|
|
/// <param name="runId">The unique identifier of the run for which to retrieve checkpoint information. Cannot be null or empty.</param>
|
|
/// <param name="withParent">An optional parent checkpoint to filter the results. If specified, only checkpoints with the given parent are
|
|
/// returned; otherwise, all checkpoints for the run are included.</param>
|
|
/// <returns>A value task representing the asynchronous operation. The result contains a collection of <see
|
|
/// cref="CheckpointInfo"/> objects associated with the specified run. The collection is empty if no checkpoints are
|
|
/// found.</returns>
|
|
ValueTask<IEnumerable<CheckpointInfo>> RetrieveIndexAsync(string runId, CheckpointInfo? withParent = null);
|
|
}
|