diff --git a/python/packages/autogen-ext/src/autogen_ext/memory/canvas/_canvas.py b/python/packages/autogen-ext/src/autogen_ext/memory/canvas/_canvas.py index 91992b4dc..de2eca26b 100644 --- a/python/packages/autogen-ext/src/autogen_ext/memory/canvas/_canvas.py +++ b/python/packages/autogen-ext/src/autogen_ext/memory/canvas/_canvas.py @@ -7,6 +7,11 @@ class BaseCanvas(ABC): An abstract protocol for "canvas" objects that maintain revision history for file-like data. Concrete subclasses can handle text, images, structured data, etc. + + .. warning:: + + This is an experimental API and may change in the future. + """ @abstractmethod diff --git a/python/packages/autogen-ext/src/autogen_ext/memory/canvas/_text_canvas.py b/python/packages/autogen-ext/src/autogen_ext/memory/canvas/_text_canvas.py index a6ae961ee..306a070a4 100644 --- a/python/packages/autogen-ext/src/autogen_ext/memory/canvas/_text_canvas.py +++ b/python/packages/autogen-ext/src/autogen_ext/memory/canvas/_text_canvas.py @@ -22,6 +22,10 @@ class FileRevision: class TextCanvas(BaseCanvas): """An in‑memory canvas that stores *text* files with full revision history. + .. warning:: + + This is an experimental API and may change in the future. + Besides the original CRUD‑like operations, this enhanced implementation adds: * **apply_patch** – applies patches using the ``unidiff`` library for accurate diff --git a/python/packages/autogen-ext/src/autogen_ext/memory/canvas/_text_canvas_memory.py b/python/packages/autogen-ext/src/autogen_ext/memory/canvas/_text_canvas_memory.py index d17515499..ecf41a3c9 100644 --- a/python/packages/autogen-ext/src/autogen_ext/memory/canvas/_text_canvas_memory.py +++ b/python/packages/autogen-ext/src/autogen_ext/memory/canvas/_text_canvas_memory.py @@ -20,6 +20,10 @@ class TextCanvasMemory(Memory): A memory implementation that uses a Canvas for storing file-like content. Inserts the current state of the canvas into the ChatCompletionContext on each turn. + .. warning:: + + This is an experimental API and may change in the future. + The TextCanvasMemory provides a persistent, file-like storage mechanism that can be used by agents to read and write content. It automatically injects the current state of all files in the canvas into the model context before each inference.