feat: Updated agents-api/agents_api/models/docs/de

agents-api/agents_api/models/docs/delete_docs.py

@@ -13,11 +13,29 @@ def delete_docs_by_id_query(
     doc_id: UUID,
     client: CozoClient = client,
 ) -> pd.DataFrame:
+    """Constructs and returns a datalog query for deleting documents and associated information snippets.
+
+    This function targets the 'cozodb' database, allowing for the removal of documents and their related information snippets based on the provided document ID and owner (user or agent).
+
+    Parameters:
+        owner_type (Literal["user", "agent"]): The type of the owner, either 'user' or 'agent'.
+        owner_id (UUID): The UUID of the owner.
+        doc_id (UUID): The UUID of the document to be deleted.
+        client (CozoClient): An instance of the CozoClient to execute the query.
+
+    Returns:
+        pd.DataFrame: The result of the executed datalog query.
+    """
+    # Convert UUID parameters to string format for use in the datalog query
     owner_id = str(owner_id)
     doc_id = str(doc_id)
 
+    # The following query is divided into two main parts:
+    # 1. Deleting information snippets associated with the document
+    # 2. Deleting the document itself from the owner's collection
     query = f"""
     {{
+        # This section constructs the subquery for identifying and deleting all information snippets associated with the given document ID.
         # Delete snippets
         input[doc_id] <- [[to_uuid($doc_id)]]
         ?[doc_id, snippet_idx] :=
@@ -32,6 +50,7 @@ def delete_docs_by_id_query(
             snippet_idx
         }}
     }} {{
+        # This section constructs the subquery for deleting the document from the specified owner's (user or agent) document collection.
         # Delete the docs
         ?[doc_id, {owner_type}_id] <- [[
             to_uuid($doc_id),