add docstrings

deeppavlov · Nov 13, 2024 · e6a6a34 · e6a6a34
1 parent c22a98c
commit e6a6a34
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/chatsky/core/context.py b/chatsky/core/context.py
@@ -148,6 +148,9 @@ class Context(BaseModel):
     """
 
     origin_interface: Optional[str] = Field(default=None)
+    """
+    Name of the interface that produced the first request in this context.
+    """
 
     @classmethod
     def init(cls, start_label: AbsoluteNodeLabelInitTypes, id: Optional[Union[UUID, int, str]] = None):

diff --git a/chatsky/core/message.py b/chatsky/core/message.py
@@ -258,8 +258,19 @@ class MediaGroup(Attachment):
 
 
 class Origin(BaseModel):
+    """
+    Denotes the origin of the message.
+    """
+
     message: Optional[Any] = None
+    """
+    Original data that the message is created from.
+    E.g. telegram update.
+    """
     interface: Optional[str] = None
+    """
+    Name of the interface that produced the message.
+    """
 
     @field_serializer("message", when_used="json")
     def pickle_serialize_message(self, value):