mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Jacob Alber
0086d38f58
* refactor: Normalize Run/RunStreaming with AIAgent * refactor: Clarify Session vs. Run -level concepts * Rename RunId to SessionId to better match Run/Session terminology in AIAgent * [BREAKING]: Will break existing checkpointed sessions in CosmosDb due to field rename * refactor: Rename and simplify interface around getting typed data out of ExternalRequest/Response * Also adds hints around using value types in PortableValue * refactor: Rename AddFanInEdge to AddFanInBarrierEdge This will prevent a breaking change later when we introduce a programmable FanIn edge, analogous to the FanOut edge's EdgeSelector. The goal, in the long run is to support a number of different FanIn scenarios, with naive FanIn (no barrier) by default, similar to FanOut. * refactor: AsAgent(this Workflow, ...) => AsAIAgent(...) * misc - part1: SwitchBuilder internal --------- Co-authored-by: Dmytro Struk <13853051+dmytrostruk@users.noreply.github.com>
47 lines
2.9 KiB
C#
47 lines
2.9 KiB
C#
// Copyright (c) Microsoft. All rights reserved.
|
|
|
|
using System.Collections.Generic;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace Microsoft.Agents.AI.Workflows.Checkpointing;
|
|
|
|
/// <summary>
|
|
/// Defines a contract for storing and retrieving checkpoints associated with a specific session and key.
|
|
/// </summary>
|
|
/// <typeparam name="TStoreObject">The type of object to be stored as the value for each checkpoint.</typeparam>
|
|
public interface ICheckpointStore<TStoreObject>
|
|
{
|
|
/// <summary>
|
|
/// Asynchronously retrieves the collection of checkpoint information for the specified session identifier, optionally
|
|
/// filtered by a parent checkpoint.
|
|
/// </summary>
|
|
/// <param name="sessionId">The unique identifier of the session 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 session 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 session. The collection is empty if no checkpoints are
|
|
/// found.</returns>
|
|
ValueTask<IEnumerable<CheckpointInfo>> RetrieveIndexAsync(string sessionId, CheckpointInfo? withParent = null);
|
|
|
|
/// <summary>
|
|
/// Asynchronously creates a checkpoint for the specified session and key, associating it with the provided value and
|
|
/// optional parent checkpoint.
|
|
/// </summary>
|
|
/// <param name="sessionId">The unique identifier of the session for which the checkpoint is being created. Cannot be null or empty.</param>
|
|
/// <param name="value">The value to associate with the checkpoint. Cannot be null.</param>
|
|
/// <param name="parent">The optional parent checkpoint information. If specified, the new checkpoint will be linked as a child of this
|
|
/// parent.</param>
|
|
/// <returns>A ValueTask that represents the asynchronous operation. The result contains the <see cref="CheckpointInfo"/>
|
|
/// object representing this stored checkpoint.</returns>
|
|
ValueTask<CheckpointInfo> CreateCheckpointAsync(string sessionId, TStoreObject value, CheckpointInfo? parent = null);
|
|
|
|
/// <summary>
|
|
/// Asynchronously retrieves a checkpoint object associated with the specified session and checkpoint key.
|
|
/// </summary>
|
|
/// <param name="sessionId">The unique identifier of the session for which the checkpoint is to be retrieved. Cannot be null or empty.</param>
|
|
/// <param name="key">The key identifying the specific checkpoint to retrieve. Cannot be null.</param>
|
|
/// <returns>A ValueTask that represents the asynchronous operation. The result contains the checkpoint object associated
|
|
/// with the specified session and key.</returns>
|
|
ValueTask<TStoreObject> RetrieveCheckpointAsync(string sessionId, CheckpointInfo key);
|
|
}
|