Add RunContext to doc and improve protocol description

Author: stellasia

docs/source/types.rst

@@ -177,3 +177,16 @@ EventCallbackProtocol
 
 .. autoclass:: neo4j_graphrag.experimental.pipeline.notification.EventCallbackProtocol
     :members: __call__
+
+
+TaskProgressCallbackProtocol
+============================
+
+.. autoclass:: neo4j_graphrag.experimental.pipeline.types.context.TaskProgressCallbackProtocol
+    :members: __call__
+
+
+RunContext
+==========
+
+.. autoclass:: neo4j_graphrag.experimental.pipeline.types.context.RunContext

src/neo4j_graphrag/experimental/pipeline/notification.py

@@ -68,6 +68,10 @@ class TaskEvent(Event):
 
 
 class EventCallbackProtocol(Protocol):
+    """This protocol is used to send events about pipeline progress
+    from the pipeline itself. It will receive either PipelineEvent or
+    TaskEvent depending on the event type.
+    """
     def __call__(self, event: Event) -> Awaitable[None]: ...
 
 

src/neo4j_graphrag/experimental/pipeline/types/context.py

@@ -20,6 +20,10 @@
 
 @runtime_checkable
 class TaskProgressCallbackProtocol(Protocol):
+    """This protocol is used to send events from within the component.
+    The final event will be of type TaskEvent, but event type and task name
+    are predefined and can not be changed by the user calling this protocol.
+    """
     def __call__(self, message: str, data: dict[str, Any]) -> Awaitable[None]: ...