clerk-sdk 0.5.8__tar.gz → 0.5.9__tar.gz

{clerk_sdk-0.5.8 → clerk_sdk-0.5.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clerk-sdk
-Version: 0.5.8
+Version: 0.5.9
 Summary: Library for interacting with Clerk
 Project-URL: Homepage, https://github.com/F-ONE-Group/clerk_pypi
 Author-email: F-One <contact@f-one.group>

{clerk_sdk-0.5.8 → clerk_sdk-0.5.9}/clerk/__init__.py

@@ -1,4 +1,4 @@
 from .client import Clerk
 
 
-__version__ = "0.5.8"
+__version__ = "0.5.9"

{clerk_sdk-0.5.8 → clerk_sdk-0.5.9}/clerk/client.py

@@ -2,6 +2,7 @@ from typing import Any, Dict, List, Literal
 
 from clerk.base import BaseClerk
 from clerk.models.document import Document, GetDocumentsRequest, UploadDocumentRequest
+from clerk.models.prevalidation import FileClassificationResponse
 from .models.file import ParsedFile, UploadFile
 
 
@@ -141,3 +142,24 @@ class ClerkDocument(BaseClerk):
         params = {"type": type}
         files_data = [f.to_multipart_format() for f in files]
         self.post_request(endpoint, params=params, files=files_data)
+
+    def prevalidate_file(
+        self, project_id: str, workflow_id: str, file: UploadFile
+    ) -> Dict[str, Any]:
+        """Submit a prevalidation for a specific file. Returns the id for fetching the results later."""
+        endpoint = f"/prevalidation/file"
+        files_data = [file.to_multipart_format()]
+        res = self.post_request(
+            endpoint,
+            files=files_data,
+            data={"project_id": project_id, "workflow_id": workflow_id},
+        )
+        return res.data[0]
+
+    def get_prevalidation_results(
+        self, workflow_run_id: str
+    ) -> FileClassificationResponse:
+        """Fetch the results of a previously submitted prevalidation."""
+        endpoint = f"/prevalidation/file"
+        res = self.get_request(endpoint, params={"workflow_run_id": workflow_run_id})
+        return FileClassificationResponse(**res.data[0])

clerk_sdk-0.5.9/clerk/models/prevalidation.py

@@ -0,0 +1,33 @@
+from typing import Dict, List, Optional
+from pydantic import BaseModel, Field
+
+
+class LabelWithDescriptions(BaseModel):
+    label: str = Field(..., description="The label/category name")
+    description: Optional[str] = Field(
+        None, description="Optional description of the label/category"
+    )
+    attributes: Optional[List[str]] = Field(
+        None, description="Optional attributes for the label/category"
+    )
+    start_page: Optional[int] = Field(
+        None, description="Start page for classification (0-based, inclusive)"
+    )
+    end_page: Optional[int] = Field(
+        None, description="End page for classification (0-based, exclusive)"
+    )
+
+
+class FileClassificationResponse(BaseModel):
+    valid: bool = Field(False, description="Whether the file classification is valid")
+    filename: str = Field(..., description="The name of the file that was classified")
+    classification: Optional[str] = Field(
+        None, description="The selected classification category"
+    )
+    reason: Optional[str] = Field(
+        None,
+        description="The reasoning behind the classification. To be filled if no classification is made.",
+    )
+    possible_categories: Optional[Dict[str, LabelWithDescriptions]] = Field(
+        None, description="Possible categories for classification"
+    )

{clerk_sdk-0.5.8 → clerk_sdk-0.5.9}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "clerk-sdk"
-version = "0.5.8"
+version = "0.5.9"
 description = "Library for interacting with Clerk"
 readme = "README.md"
 authors = [

{clerk_sdk-0.5.8 → clerk_sdk-0.5.9}/setup.py

@@ -13,7 +13,7 @@ gui_requirements = get_requirements("./clerk/gui_automation")
 
 setup(
     name="clerk-sdk",
-    version="0.5.8",
+    version="0.5.9",
     description="Library for interacting with Clerk",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",