retab 0.0.85__tar.gz → 0.0.87__tar.gz

{retab-0.0.85 → retab-0.0.87}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: retab
-Version: 0.0.85
+Version: 0.0.87
 Summary: Retab official python library
 Home-page: https://github.com/retab-dev/retab
 Author: Retab

{retab-0.0.85 → retab-0.0.87}/retab/resources/edit/agent/client.py

@@ -12,6 +12,7 @@ from pydantic import HttpUrl
 from ...._resource import AsyncAPIResource, SyncAPIResource
 from ....utils.mime import prepare_mime_document
 from ....types.documents.edit import (
+    EditConfig,
     EditRequest,
     EditResponse,
 )
@@ -27,6 +28,7 @@ class BaseAgentMixin:
         instructions: str,
         document: Path | str | IOBase | MIMEData | PIL.Image.Image | HttpUrl | None = None,
         model: str = FieldUnset,
+        color: str = FieldUnset,
         **extra_body: Any,
     ) -> PreparedRequest:
         request_dict: dict[str, Any] = {
@@ -40,6 +42,9 @@ class BaseAgentMixin:
         if model is not FieldUnset:
             request_dict["model"] = model
 
+        if color is not FieldUnset:
+            request_dict["config"] = EditConfig(color=color)
+
         # Merge any extra fields provided by the caller
         if extra_body:
             request_dict.update(extra_body)
@@ -63,6 +68,7 @@ class Agent(SyncAPIResource, BaseAgentMixin):
         instructions: str,
         document: Path | str | IOBase | MIMEData | PIL.Image.Image | HttpUrl | None = None,
         model: str = FieldUnset,
+        color: str = FieldUnset,
         **extra_body: Any,
     ) -> EditResponse:
         """
@@ -79,6 +85,7 @@ class Agent(SyncAPIResource, BaseAgentMixin):
             document: The document to edit. Can be a file path (Path or str), file-like object,
                 MIMEData, PIL Image, or URL.
             model: The LLM model to use for inference. Defaults to "retab-small".
+            color: Hex color code for filled text (e.g. "#000080"). Defaults to dark blue.
 
         Returns:
             EditResponse: Response containing:
@@ -98,6 +105,7 @@ class Agent(SyncAPIResource, BaseAgentMixin):
             instructions=instructions,
             document=document,
             model=model,
+            color=color,
             **extra_body,
         )
         response = self._client._prepared_request(request)
@@ -115,6 +123,7 @@ class AsyncAgent(AsyncAPIResource, BaseAgentMixin):
         instructions: str,
         document: Path | str | IOBase | MIMEData | PIL.Image.Image | HttpUrl | None = None,
         model: str = FieldUnset,
+        color: str = FieldUnset,
         **extra_body: Any,
     ) -> EditResponse:
         """
@@ -131,6 +140,7 @@ class AsyncAgent(AsyncAPIResource, BaseAgentMixin):
             document: The document to edit. Can be a file path (Path or str), file-like object,
                 MIMEData, PIL Image, or URL.
             model: The LLM model to use for inference. Defaults to "retab-small".
+            color: Hex color code for filled text (e.g. "#000080"). Defaults to dark blue.
 
         Returns:
             EditResponse: Response containing:
@@ -150,6 +160,7 @@ class AsyncAgent(AsyncAPIResource, BaseAgentMixin):
             instructions=instructions,
             document=document,
             model=model,
+            color=color,
             **extra_body,
         )
         response = await self._client._prepared_request(request)

{retab-0.0.85 → retab-0.0.87}/retab/resources/edit/templates/client.py

@@ -12,6 +12,7 @@ from pydantic import HttpUrl
 from ...._resource import AsyncAPIResource, SyncAPIResource
 from ....utils.mime import prepare_mime_document
 from ....types.documents.edit import (
+    EditConfig,
     FormField,
     InferFormSchemaRequest,
     InferFormSchemaResponse,
@@ -163,6 +164,7 @@ class BaseTemplatesMixin:
         template_id: str,
         instructions: str,
         model: str = FieldUnset,
+        color: str = FieldUnset,
         **extra_body: Any,
     ) -> PreparedRequest:
         request_dict: dict[str, Any] = {
@@ -172,6 +174,8 @@ class BaseTemplatesMixin:
 
         if model is not FieldUnset:
             request_dict["model"] = model
+        if color is not FieldUnset:
+            request_dict["config"] = EditConfig(color=color)
         if extra_body:
             request_dict.update(extra_body)
 
@@ -368,6 +372,7 @@ class Templates(SyncAPIResource, BaseTemplatesMixin):
         template_id: str,
         instructions: str,
         model: str = FieldUnset,
+        color: str = FieldUnset,
         **extra_body: Any,
     ) -> EditResponse:
         """
@@ -380,6 +385,7 @@ class Templates(SyncAPIResource, BaseTemplatesMixin):
             template_id: The template ID to use for filling
             instructions: Instructions describing how to fill the form fields
             model: The LLM model to use for inference (default: "retab-small")
+            color: Hex color code for filled text (e.g. "#000080"). Defaults to dark blue.
 
         Returns:
             EditResponse: Response containing:
@@ -395,6 +401,7 @@ class Templates(SyncAPIResource, BaseTemplatesMixin):
             template_id=template_id,
             instructions=instructions,
             model=model,
+            color=color,
             **extra_body,
         )
         response = self._client._prepared_request(request)
@@ -586,6 +593,7 @@ class AsyncTemplates(AsyncAPIResource, BaseTemplatesMixin):
         template_id: str,
         instructions: str,
         model: str = FieldUnset,
+        color: str = FieldUnset,
         **extra_body: Any,
     ) -> EditResponse:
         """
@@ -598,6 +606,7 @@ class AsyncTemplates(AsyncAPIResource, BaseTemplatesMixin):
             template_id: The template ID to use for filling
             instructions: Instructions describing how to fill the form fields
             model: The LLM model to use for inference (default: "retab-small")
+            color: Hex color code for filled text (e.g. "#000080"). Defaults to dark blue.
 
         Returns:
             EditResponse: Response containing:
@@ -613,6 +622,7 @@ class AsyncTemplates(AsyncAPIResource, BaseTemplatesMixin):
             template_id=template_id,
             instructions=instructions,
             model=model,
+            color=color,
             **extra_body,
         )
         response = await self._client._prepared_request(request)

retab-0.0.87/retab/resources/workflows/client.py

@@ -0,0 +1,28 @@
+from typing import Any
+
+from ..._resource import AsyncAPIResource, SyncAPIResource
+from .runs import WorkflowRuns, AsyncWorkflowRuns
+
+
+class Workflows(SyncAPIResource):
+    """Workflows API wrapper for synchronous operations.
+
+    Sub-clients:
+        runs: Workflow run operations (create, get)
+    """
+
+    def __init__(self, client: Any) -> None:
+        super().__init__(client=client)
+        self.runs = WorkflowRuns(client=client)
+
+
+class AsyncWorkflows(AsyncAPIResource):
+    """Workflows API wrapper for asynchronous operations.
+
+    Sub-clients:
+        runs: Workflow run operations (create, get)
+    """
+
+    def __init__(self, client: Any) -> None:
+        super().__init__(client=client)
+        self.runs = AsyncWorkflowRuns(client=client)

retab-0.0.87/retab/resources/workflows/runs/__init__.py

@@ -0,0 +1,3 @@
+from .client import AsyncWorkflowRuns, WorkflowRuns
+
+__all__ = ["WorkflowRuns", "AsyncWorkflowRuns"]

{retab-0.0.85/retab/resources/workflows → retab-0.0.87/retab/resources/workflows/runs}/client.py

@@ -5,20 +5,20 @@ from typing import Any, Dict
 import PIL.Image
 from pydantic import HttpUrl
 
-from ..._resource import AsyncAPIResource, SyncAPIResource
-from ...utils.mime import MIMEData, prepare_mime_document
-from ...types.standards import PreparedRequest
-from ...types.workflows import WorkflowRun
+from ...._resource import AsyncAPIResource, SyncAPIResource
+from ....utils.mime import MIMEData, prepare_mime_document
+from ....types.standards import PreparedRequest
+from ....types.workflows import WorkflowRun
 
 
 # Type alias for document inputs
 DocumentInput = Path | str | bytes | IOBase | MIMEData | PIL.Image.Image | HttpUrl
 
 
-class WorkflowsMixin:
-    """Mixin providing shared methods for workflow operations."""
+class WorkflowRunsMixin:
+    """Mixin providing shared methods for workflow run operations."""
 
-    def prepare_run(
+    def prepare_create(
         self,
         workflow_id: str,
         documents: Dict[str, DocumentInput],
@@ -33,9 +33,9 @@ class WorkflowsMixin:
 
         Returns:
             PreparedRequest: The prepared request
-            
+
         Example:
-            >>> client.workflows.run(
+            >>> client.workflows.runs.create(
             ...     workflow_id="wf_abc123",
             ...     documents={
             ...         "start-node-1": Path("invoice.pdf"),
@@ -56,7 +56,7 @@ class WorkflowsMixin:
         data = {"documents": documents_payload}
         return PreparedRequest(method="POST", url=f"/v1/workflows/{workflow_id}/run", data=data)
 
-    def prepare_get_run(self, run_id: str) -> PreparedRequest:
+    def prepare_get(self, run_id: str) -> PreparedRequest:
         """Prepare a request to get a workflow run by ID.
 
         Args:
@@ -68,13 +68,13 @@ class WorkflowsMixin:
         return PreparedRequest(method="GET", url=f"/v1/workflows/runs/{run_id}")
 
 
-class Workflows(SyncAPIResource, WorkflowsMixin):
-    """Workflows API wrapper for synchronous operations."""
+class WorkflowRuns(SyncAPIResource, WorkflowRunsMixin):
+    """Workflow Runs API wrapper for synchronous operations."""
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
-    def run(
+    def create(
         self,
         workflow_id: str,
         documents: Dict[str, DocumentInput],
@@ -82,7 +82,7 @@ class Workflows(SyncAPIResource, WorkflowsMixin):
         """Run a workflow with the provided input documents.
 
         This creates a workflow run and starts execution in the background.
-        The returned WorkflowRun will have status "running" - use get_run() 
+        The returned WorkflowRun will have status "running" - use get()
         to check for updates on the run status.
 
         Args:
@@ -99,7 +99,7 @@ class Workflows(SyncAPIResource, WorkflowsMixin):
                           missing input documents for start nodes)
 
         Example:
-            >>> run = client.workflows.run(
+            >>> run = client.workflows.runs.create(
             ...     workflow_id="wf_abc123",
             ...     documents={
             ...         "start-node-1": Path("invoice.pdf"),
@@ -108,11 +108,11 @@ class Workflows(SyncAPIResource, WorkflowsMixin):
             ... )
             >>> print(f"Run started: {run.id}, status: {run.status}")
         """
-        request = self.prepare_run(workflow_id=workflow_id, documents=documents)
+        request = self.prepare_create(workflow_id=workflow_id, documents=documents)
         response = self._client._prepared_request(request)
         return WorkflowRun.model_validate(response)
 
-    def get_run(self, run_id: str) -> WorkflowRun:
+    def get(self, run_id: str) -> WorkflowRun:
         """Get a workflow run by ID.
 
         Args:
@@ -124,18 +124,18 @@ class Workflows(SyncAPIResource, WorkflowsMixin):
         Raises:
             HTTPException: If the request fails (e.g., run not found)
         """
-        request = self.prepare_get_run(run_id)
+        request = self.prepare_get(run_id)
         response = self._client._prepared_request(request)
         return WorkflowRun.model_validate(response)
 
 
-class AsyncWorkflows(AsyncAPIResource, WorkflowsMixin):
-    """Workflows API wrapper for asynchronous operations."""
+class AsyncWorkflowRuns(AsyncAPIResource, WorkflowRunsMixin):
+    """Workflow Runs API wrapper for asynchronous operations."""
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
-    async def run(
+    async def create(
         self,
         workflow_id: str,
         documents: Dict[str, DocumentInput],
@@ -143,7 +143,7 @@ class AsyncWorkflows(AsyncAPIResource, WorkflowsMixin):
         """Run a workflow with the provided input documents.
 
         This creates a workflow run and starts execution in the background.
-        The returned WorkflowRun will have status "running" - use get_run() 
+        The returned WorkflowRun will have status "running" - use get()
         to check for updates on the run status.
 
         Args:
@@ -160,7 +160,7 @@ class AsyncWorkflows(AsyncAPIResource, WorkflowsMixin):
                           missing input documents for start nodes)
 
         Example:
-            >>> run = await client.workflows.run(
+            >>> run = await client.workflows.runs.create(
             ...     workflow_id="wf_abc123",
             ...     documents={
             ...         "start-node-1": Path("invoice.pdf"),
@@ -169,11 +169,11 @@ class AsyncWorkflows(AsyncAPIResource, WorkflowsMixin):
             ... )
             >>> print(f"Run started: {run.id}, status: {run.status}")
         """
-        request = self.prepare_run(workflow_id=workflow_id, documents=documents)
+        request = self.prepare_create(workflow_id=workflow_id, documents=documents)
         response = await self._client._prepared_request(request)
         return WorkflowRun.model_validate(response)
 
-    async def get_run(self, run_id: str) -> WorkflowRun:
+    async def get(self, run_id: str) -> WorkflowRun:
         """Get a workflow run by ID.
 
         Args:
@@ -185,6 +185,6 @@ class AsyncWorkflows(AsyncAPIResource, WorkflowsMixin):
         Raises:
             HTTPException: If the request fails (e.g., run not found)
         """
-        request = self.prepare_get_run(run_id)
+        request = self.prepare_get(run_id)
         response = await self._client._prepared_request(request)
         return WorkflowRun.model_validate(response)

{retab-0.0.85 → retab-0.0.87}/retab/types/documents/classify.py

@@ -7,6 +7,7 @@ class ClassifyRequest(BaseModel):
     document: MIMEData = Field(..., description="The document to classify")
     categories: list[Category] = Field(..., description="The categories to classify the document into")
     model: str = Field(default="retab-small", description="The model to use for classification")
+    first_n_pages: int | None = Field(default=None, description="Only use the first N pages of the document for classification. Useful for large documents where classification can be determined from early pages.")
 
 
 class ClassifyResult(BaseModel):

{retab-0.0.85 → retab-0.0.87}/retab/types/documents/edit.py

@@ -111,6 +111,11 @@ class InferFormSchemaRequest(BaseModel):
     model: str = Field(default="retab-small", description="LLM model to use for inference")
 
 
+class EditConfig(BaseModel):
+    """Configuration for edit requests."""
+    color: str = Field(default="#000080", description="Hex code of the color to use for the filled text")
+
+
 class EditRequest(BaseModel):
     """Request for the infer_and_fill_schema endpoint.
     
@@ -122,6 +127,7 @@ class EditRequest(BaseModel):
     model: str = Field(default="retab-small", description="LLM model to use for inference")
     instructions: str = Field(..., description="Instructions to fill the form")
     template_id: Optional[str] = Field(default=None, description="Template ID to use for filling. When provided, uses the template's pre-defined form fields and empty PDF. Only works for PDF documents. Mutually exclusive with document.")
+    config: EditConfig = Field(default_factory=EditConfig, description="Configuration for the edit request")
 
 class EditResponse(BaseModel):
     """Response from the fill_form endpoint.

{retab-0.0.85 → retab-0.0.87}/retab/types/edit/templates.py

@@ -5,7 +5,7 @@ from pydantic import BaseModel, Field
 import datetime
 
 from ..mime import BaseMIMEData, MIMEData
-from ..documents.edit import FormField
+from ..documents.edit import FormField, EditConfig
 
 
 class EditTemplate(BaseModel):
@@ -48,3 +48,4 @@ class FillTemplateRequest(BaseModel):
     model: str = Field(default="retab-small", description="LLM model to use for inference")
     instructions: str = Field(..., description="Instructions to fill the form")
     template_id: str = Field(..., description="Template ID to use for filling. When provided, uses the template's pre-defined form fields and empty PDF. Only works for PDF documents. Mutually exclusive with document.")
+    config: EditConfig = Field(default_factory=EditConfig, description="Configuration for the fill request")

{retab-0.0.85 → retab-0.0.87}/retab.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: retab
-Version: 0.0.85
+Version: 0.0.87
 Summary: Retab official python library
 Home-page: https://github.com/retab-dev/retab
 Author: Retab

{retab-0.0.85 → retab-0.0.87}/retab.egg-info/SOURCES.txt

@@ -28,6 +28,8 @@ retab/resources/projects/__init__.py
 retab/resources/projects/client.py
 retab/resources/workflows/__init__.py
 retab/resources/workflows/client.py
+retab/resources/workflows/runs/__init__.py
+retab/resources/workflows/runs/client.py
 retab/types/__init__.py
 retab/types/chat.py
 retab/types/inference_settings.py

{retab-0.0.85 → retab-0.0.87}/setup.py

@@ -6,7 +6,7 @@ with open("requirements.txt") as f:
 
 setup(
     name="retab",
-    version="0.0.85",
+    version="0.0.87",
     author="Retab",
     author_email="contact@retab.com",
     description="Retab official python library",