retab 0.0.41__py3-none-any.whl → 0.0.43__py3-none-any.whl

retab/resources/processors/automations/outlook.py

@@ -1,9 +1,15 @@
 from typing import Any, Literal, List
 
-from pydantic_core import PydanticUndefined
+from ....types.standards import FieldUnset
 
 from ...._resource import AsyncAPIResource, SyncAPIResource
-from ....types.automations.outlook import FetchParams, ListOutlooks, MatchParams, Outlook, UpdateOutlookRequest
+from ....types.automations.outlook import (
+    FetchParams,
+    ListOutlooks,
+    MatchParams,
+    Outlook,
+    UpdateOutlookRequest,
+)
 from ....types.standards import PreparedRequest
 
 
@@ -15,33 +21,49 @@ class OutlooksMixin:
         name: str,
         processor_id: str,
         webhook_url: str,
-        default_language: str = PydanticUndefined,  # type: ignore[assignment]
-        webhook_headers: dict[str, str] = PydanticUndefined,  # type: ignore[assignment]
-        need_validation: bool = PydanticUndefined,  # type: ignore[assignment]
-        authorized_domains: list[str] = PydanticUndefined,  # type: ignore[assignment]
-        authorized_emails: list[str] = PydanticUndefined,  # type: ignore[assignment]
-        layout_schema: dict[str, Any] = PydanticUndefined,  # type: ignore[assignment]
-        match_params: list[MatchParams] = PydanticUndefined,  # type: ignore[assignment]
-        fetch_params: list[FetchParams] = PydanticUndefined,  # type: ignore[assignment]
+        default_language: str = FieldUnset,
+        webhook_headers: dict[str, str] = FieldUnset,
+        need_validation: bool = FieldUnset,
+        authorized_domains: list[str] = FieldUnset,
+        authorized_emails: list[str] = FieldUnset,
+        layout_schema: dict[str, Any] = FieldUnset,
+        match_params: list[MatchParams] = FieldUnset,
+        fetch_params: list[FetchParams] = FieldUnset,
     ) -> PreparedRequest:
+        # Build outlook dictionary with only provided fields
+        outlook_dict: dict[str, Any] = {
+            'processor_id': processor_id,
+            'name': name,
+            'webhook_url': webhook_url,
+        }
+        if default_language is not FieldUnset:
+            outlook_dict['default_language'] = default_language
+        if webhook_headers is not FieldUnset:
+            outlook_dict['webhook_headers'] = webhook_headers
+        if need_validation is not FieldUnset:
+            outlook_dict['need_validation'] = need_validation
+        if authorized_domains is not FieldUnset:
+            outlook_dict['authorized_domains'] = authorized_domains
+        if authorized_emails is not FieldUnset:
+            outlook_dict['authorized_emails'] = authorized_emails
+        if layout_schema is not FieldUnset:
+            outlook_dict['layout_schema'] = layout_schema
+        if match_params is not FieldUnset:
+            outlook_dict['match_params'] = match_params
+        if fetch_params is not FieldUnset:
+            outlook_dict['fetch_params'] = fetch_params
+
         # Validate the data
-        outlook_data = Outlook(
-            processor_id=processor_id,
-            name=name,
-            default_language=default_language,
-            webhook_url=webhook_url,
-            webhook_headers=webhook_headers,
-            need_validation=need_validation,
-            authorized_domains=authorized_domains,
-            authorized_emails=authorized_emails,
-            layout_schema=layout_schema,
-            match_params=match_params,
-            fetch_params=fetch_params,
+        outlook_data = Outlook(**outlook_dict)
+        return PreparedRequest(
+            method="POST",
+            url=self.outlooks_base_url,
+            data=outlook_data.model_dump(mode="json", exclude_unset=True),
         )
-        return PreparedRequest(method="POST", url=self.outlooks_base_url, data=outlook_data.model_dump(mode="json"))
 
     def prepare_list(
         self,
+        processor_id: str,
         before: str | None = None,
         after: str | None = None,
         limit: int = 10,
@@ -50,6 +72,7 @@ class OutlooksMixin:
         webhook_url: str | None = None,
     ) -> PreparedRequest:
         params = {
+            "processor_id": processor_id,
             "before": before,
             "after": after,
             "limit": limit,
@@ -68,32 +91,47 @@ class OutlooksMixin:
     def prepare_update(
         self,
         outlook_id: str,
-        name: str = PydanticUndefined,  # type: ignore[assignment]
-        default_language: str = PydanticUndefined,  # type: ignore[assignment]
-        webhook_url: str = PydanticUndefined,  # type: ignore[assignment]
-        webhook_headers: dict[str, str] = PydanticUndefined,  # type: ignore[assignment]
-        need_validation: bool = PydanticUndefined,  # type: ignore[assignment]
-        authorized_domains: list[str] = PydanticUndefined,  # type: ignore[assignment]
-        authorized_emails: list[str] = PydanticUndefined,  # type: ignore[assignment]
-        match_params: list[MatchParams] = PydanticUndefined,  # type: ignore[assignment]
-        fetch_params: list[FetchParams] = PydanticUndefined,  # type: ignore[assignment]
-        layout_schema: dict[str, Any] = PydanticUndefined,  # type: ignore[assignment]
+        name: str = FieldUnset,
+        default_language: str = FieldUnset,
+        webhook_url: str = FieldUnset,
+        webhook_headers: dict[str, str] = FieldUnset,
+        need_validation: bool = FieldUnset,
+        authorized_domains: list[str] = FieldUnset,
+        authorized_emails: list[str] = FieldUnset,
+        match_params: list[MatchParams] = FieldUnset,
+        fetch_params: list[FetchParams] = FieldUnset,
+        layout_schema: dict[str, Any] = FieldUnset,
     ) -> PreparedRequest:
-        update_outlook_request = UpdateOutlookRequest(
-            name=name,
-            default_language=default_language,
-            webhook_url=webhook_url,
-            webhook_headers=webhook_headers,
-            need_validation=need_validation,
-            authorized_domains=authorized_domains,
-            authorized_emails=authorized_emails,
-            layout_schema=layout_schema,
-            match_params=match_params,
-            fetch_params=fetch_params,
+        update_dict: dict[str, Any] = {}
+        if name is not FieldUnset:
+            update_dict['name'] = name
+        if default_language is not FieldUnset:
+            update_dict['default_language'] = default_language
+        if webhook_url is not FieldUnset:
+            update_dict['webhook_url'] = webhook_url
+        if webhook_headers is not FieldUnset:
+            update_dict['webhook_headers'] = webhook_headers
+        if need_validation is not FieldUnset:
+            update_dict['need_validation'] = need_validation
+        if authorized_domains is not FieldUnset:
+            update_dict['authorized_domains'] = authorized_domains
+        if authorized_emails is not FieldUnset:
+            update_dict['authorized_emails'] = authorized_emails
+        if layout_schema is not FieldUnset:
+            update_dict['layout_schema'] = layout_schema
+        if match_params is not FieldUnset:
+            update_dict['match_params'] = match_params
+        if fetch_params is not FieldUnset:
+            update_dict['fetch_params'] = fetch_params
+
+        update_outlook_request = UpdateOutlookRequest(**update_dict)
+
+        return PreparedRequest(
+            method="PUT",
+            url=f"{self.outlooks_base_url}/{outlook_id}",
+            data=update_outlook_request.model_dump(mode="json", exclude_unset=True),
         )
 
-        return PreparedRequest(method="PUT", url=f"{self.outlooks_base_url}/{outlook_id}", data=update_outlook_request.model_dump(mode="json"))
-
     def prepare_delete(self, outlook_id: str) -> PreparedRequest:
         return PreparedRequest(method="DELETE", url=f"{self.outlooks_base_url}/{outlook_id}")
 
@@ -109,14 +147,14 @@ class Outlooks(SyncAPIResource, OutlooksMixin):
         name: str,
         processor_id: str,
         webhook_url: str,
-        default_language: str = PydanticUndefined,  # type: ignore[assignment]
-        webhook_headers: dict[str, str] = PydanticUndefined,  # type: ignore[assignment]
-        need_validation: bool = PydanticUndefined,  # type: ignore[assignment]
-        authorized_domains: list[str] = PydanticUndefined,  # type: ignore[assignment]
-        authorized_emails: list[str] = PydanticUndefined,  # type: ignore[assignment]
-        layout_schema: dict[str, Any] = PydanticUndefined,  # type: ignore[assignment]
-        match_params: list[MatchParams] = PydanticUndefined,  # type: ignore[assignment]
-        fetch_params: list[FetchParams] = PydanticUndefined,  # type: ignore[assignment]
+        default_language: str = FieldUnset,
+        webhook_headers: dict[str, str] = FieldUnset,
+        need_validation: bool = FieldUnset,
+        authorized_domains: list[str] = FieldUnset,
+        authorized_emails: list[str] = FieldUnset,
+        layout_schema: dict[str, Any] = FieldUnset,
+        match_params: list[MatchParams] = FieldUnset,
+        fetch_params: list[FetchParams] = FieldUnset,
     ) -> Outlook:
         """Create a new outlook automation configuration.
 
@@ -149,12 +187,13 @@ class Outlooks(SyncAPIResource, OutlooksMixin):
         )
         response = self._client._prepared_request(request)
 
-        print(f"Outlook plugin created. Url: https://www.retab.dev/dashboard/processors/automations/{response['id']}")
+        print(f"Outlook plugin created. Url: https://www.retab.com/dashboard/processors/automations/{response['id']}")
 
         return Outlook.model_validate(response)
 
     def list(
         self,
+        processor_id: str,
         before: str | None = None,
         after: str | None = None,
         limit: int = 10,
@@ -174,7 +213,7 @@ class Outlooks(SyncAPIResource, OutlooksMixin):
         Returns:
             List[Outlook]: List of outlook plugin configurations
         """
-        request = self.prepare_list(before, after, limit, order, name, webhook_url)
+        request = self.prepare_list(processor_id, before, after, limit, order, name, webhook_url)
         response = self._client._prepared_request(request)
         return ListOutlooks.model_validate(response)
 
@@ -194,16 +233,16 @@ class Outlooks(SyncAPIResource, OutlooksMixin):
     def update(
         self,
         outlook_id: str,
-        name: str = PydanticUndefined,  # type: ignore[assignment]
-        default_language: str = PydanticUndefined,  # type: ignore[assignment]
-        webhook_url: str = PydanticUndefined,  # type: ignore[assignment]
-        webhook_headers: dict[str, str] = PydanticUndefined,  # type: ignore[assignment]
-        need_validation: bool = PydanticUndefined,  # type: ignore[assignment]
-        authorized_domains: List[str] = PydanticUndefined,  # type: ignore[assignment]
-        authorized_emails: List[str] = PydanticUndefined,  # type: ignore[assignment]
-        layout_schema: dict[str, Any] = PydanticUndefined,  # type: ignore[assignment]
-        match_params: List[MatchParams] = PydanticUndefined,  # type: ignore[assignment]
-        fetch_params: List[FetchParams] = PydanticUndefined,  # type: ignore[assignment]
+        name: str = FieldUnset,
+        default_language: str = FieldUnset,
+        webhook_url: str = FieldUnset,
+        webhook_headers: dict[str, str] = FieldUnset,
+        need_validation: bool = FieldUnset,
+        authorized_domains: List[str] = FieldUnset,
+        authorized_emails: List[str] = FieldUnset,
+        layout_schema: dict[str, Any] = FieldUnset,
+        match_params: List[MatchParams] = FieldUnset,
+        fetch_params: List[FetchParams] = FieldUnset,
     ) -> Outlook:
         """Update an outlook automation configuration.
 
@@ -257,14 +296,14 @@ class AsyncOutlooks(AsyncAPIResource, OutlooksMixin):
         name: str,
         processor_id: str,
         webhook_url: str,
-        default_language: str = PydanticUndefined,  # type: ignore[assignment]
-        webhook_headers: dict[str, str] = PydanticUndefined,  # type: ignore[assignment]
-        need_validation: bool = PydanticUndefined,  # type: ignore[assignment]
-        authorized_domains: list[str] = PydanticUndefined,  # type: ignore[assignment]
-        authorized_emails: list[str] = PydanticUndefined,  # type: ignore[assignment]
-        layout_schema: dict[str, Any] = PydanticUndefined,  # type: ignore[assignment]
-        match_params: list[MatchParams] = PydanticUndefined,  # type: ignore[assignment]
-        fetch_params: list[FetchParams] = PydanticUndefined,  # type: ignore[assignment]
+        default_language: str = FieldUnset,
+        webhook_headers: dict[str, str] = FieldUnset,
+        need_validation: bool = FieldUnset,
+        authorized_domains: list[str] = FieldUnset,
+        authorized_emails: list[str] = FieldUnset,
+        layout_schema: dict[str, Any] = FieldUnset,
+        match_params: list[MatchParams] = FieldUnset,
+        fetch_params: list[FetchParams] = FieldUnset,
     ) -> Outlook:
         request = self.prepare_create(
             name=name,
@@ -280,11 +319,12 @@ class AsyncOutlooks(AsyncAPIResource, OutlooksMixin):
             fetch_params=fetch_params,
         )
         response = await self._client._prepared_request(request)
-        print(f"Outlook plugin created. Url: https://www.retab.dev/dashboard/processors/automations/{response['id']}")
+        print(f"Outlook plugin created. Url: https://www.retab.com/dashboard/processors/automations/{response['id']}")
         return Outlook.model_validate(response)
 
     async def list(
         self,
+        processor_id: str,
         before: str | None = None,
         after: str | None = None,
         limit: int = 10,
@@ -292,7 +332,7 @@ class AsyncOutlooks(AsyncAPIResource, OutlooksMixin):
         name: str | None = None,
         webhook_url: str | None = None,
     ) -> ListOutlooks:
-        request = self.prepare_list(before, after, limit, order, name, webhook_url)
+        request = self.prepare_list(processor_id, before, after, limit, order, name, webhook_url)
         response = await self._client._prepared_request(request)
         return ListOutlooks.model_validate(response)
 
@@ -304,16 +344,16 @@ class AsyncOutlooks(AsyncAPIResource, OutlooksMixin):
     async def update(
         self,
         outlook_id: str,
-        name: str = PydanticUndefined,  # type: ignore[assignment]
-        default_language: str = PydanticUndefined,  # type: ignore[assignment]
-        webhook_url: str = PydanticUndefined,  # type: ignore[assignment]
-        webhook_headers: dict[str, str] = PydanticUndefined,  # type: ignore[assignment]
-        need_validation: bool = PydanticUndefined,  # type: ignore[assignment]
-        authorized_domains: List[str] = PydanticUndefined,  # type: ignore[assignment]
-        authorized_emails: List[str] = PydanticUndefined,  # type: ignore[assignment]
-        layout_schema: dict[str, Any] = PydanticUndefined,  # type: ignore[assignment]
-        match_params: List[MatchParams] = PydanticUndefined,  # type: ignore[assignment]
-        fetch_params: List[FetchParams] = PydanticUndefined,  # type: ignore[assignment]
+        name: str = FieldUnset,
+        default_language: str = FieldUnset,
+        webhook_url: str = FieldUnset,
+        webhook_headers: dict[str, str] = FieldUnset,
+        need_validation: bool = FieldUnset,
+        authorized_domains: List[str] = FieldUnset,
+        authorized_emails: List[str] = FieldUnset,
+        layout_schema: dict[str, Any] = FieldUnset,
+        match_params: List[MatchParams] = FieldUnset,
+        fetch_params: List[FetchParams] = FieldUnset,
     ) -> Outlook:
         request = self.prepare_update(
             outlook_id=outlook_id,

retab/resources/processors/automations/tests.py

@@ -1,4 +1,5 @@
 import json
+import base64
 from io import IOBase
 from pathlib import Path
 
@@ -15,7 +16,12 @@ from ....types.standards import PreparedRequest
 class TestsMixin:
     def prepare_upload(self, automation_id: str, document: Path | str | IOBase | HttpUrl | Image | MIMEData) -> PreparedRequest:
         mime_document = prepare_mime_document(document)
-        return PreparedRequest(method="POST", url=f"/v1/processors/automations/tests/upload/{automation_id}", data={"document": mime_document.model_dump(mode="json")})
+
+        # Convert MIME document to file upload format (similar to processors client)
+        files = {"file": (mime_document.filename, base64.b64decode(mime_document.content), mime_document.mime_type)}
+
+        # Send as multipart form data with file upload
+        return PreparedRequest(method="POST", url=f"/v1/processors/automations/tests/upload/{automation_id}", files=files)
 
     def prepare_webhook(self, automation_id: str) -> PreparedRequest:
         return PreparedRequest(method="POST", url=f"/v1/processors/automations/tests/webhook/{automation_id}", data=None)

retab/resources/processors/client.py

@@ -6,8 +6,6 @@ from typing import Any, List, Literal
 import PIL.Image
 from openai.types.chat.chat_completion_reasoning_effort import ChatCompletionReasoningEffort
 from pydantic import BaseModel, HttpUrl
-from pydantic_core import PydanticUndefined
-
 from ..._resource import AsyncAPIResource, SyncAPIResource
 from ...utils.ai_models import assert_valid_model_extraction
 from ...utils.json_schema import load_json_schema
@@ -17,7 +15,7 @@ from ...types.documents.extractions import RetabParsedChatCompletion
 from ...types.logs import ProcessorConfig, UpdateProcessorRequest
 from ...types.modalities import Modality
 from ...types.pagination import ListMetadata
-from ...types.standards import PreparedRequest
+from ...types.standards import PreparedRequest, FieldUnset
 from .automations.client import AsyncAutomations, Automations
 
 
@@ -35,30 +33,37 @@ class ProcessorsMixin:
         json_schema: dict[str, Any] | Path | str,
         modality: Modality = "native",
         model: str = "gpt-4o-mini",
-        temperature: float = PydanticUndefined,  # type: ignore[assignment]
-        reasoning_effort: ChatCompletionReasoningEffort = PydanticUndefined,  # type: ignore[assignment]
-        image_resolution_dpi: int = PydanticUndefined,  # type: ignore[assignment]
-        browser_canvas: BrowserCanvas = PydanticUndefined,  # type: ignore[assignment]
-        n_consensus: int = PydanticUndefined,  # type: ignore[assignment]
+        temperature: float = FieldUnset,
+        reasoning_effort: ChatCompletionReasoningEffort = FieldUnset,
+        image_resolution_dpi: int = FieldUnset,
+        browser_canvas: BrowserCanvas = FieldUnset,
+        n_consensus: int = FieldUnset,
     ) -> PreparedRequest:
         assert_valid_model_extraction(model)
 
         # Load the JSON schema from file path, string, or dict
         loaded_schema = load_json_schema(json_schema)
 
-        processor_config = ProcessorConfig(
-            name=name,
-            json_schema=loaded_schema,
-            modality=modality,
-            model=model,
-            temperature=temperature,
-            reasoning_effort=reasoning_effort,
-            image_resolution_dpi=image_resolution_dpi,
-            browser_canvas=browser_canvas,
-            n_consensus=n_consensus,
-        )
+        config_dict = {
+            'name': name,
+            'json_schema': loaded_schema,
+            'modality': modality,
+            'model': model,
+        }
+        if temperature is not FieldUnset:
+            config_dict['temperature'] = temperature
+        if reasoning_effort is not FieldUnset:
+            config_dict['reasoning_effort'] = reasoning_effort
+        if image_resolution_dpi is not FieldUnset:
+            config_dict['image_resolution_dpi'] = image_resolution_dpi
+        if browser_canvas is not FieldUnset:
+            config_dict['browser_canvas'] = browser_canvas
+        if n_consensus is not FieldUnset:
+            config_dict['n_consensus'] = n_consensus
+
+        processor_config = ProcessorConfig(**config_dict)
 
-        return PreparedRequest(method="POST", url="/v1/processors", data=processor_config.model_dump(mode="json"))
+        return PreparedRequest(method="POST", url="/v1/processors", data=processor_config.model_dump(mode="json", exclude_unset=True))
 
     def prepare_list(
         self,
@@ -215,11 +220,11 @@ class Processors(SyncAPIResource, ProcessorsMixin):
         json_schema: dict[str, Any] | Path | str,
         modality: Modality = "native",
         model: str = "gpt-4o-mini",
-        temperature: float = PydanticUndefined,  # type: ignore[assignment]
-        reasoning_effort: ChatCompletionReasoningEffort = PydanticUndefined,  # type: ignore[assignment]
-        image_resolution_dpi: int = PydanticUndefined,  # type: ignore[assignment]
-        browser_canvas: BrowserCanvas = PydanticUndefined,  # type: ignore[assignment]
-        n_consensus: int = PydanticUndefined,  # type: ignore[assignment]
+        temperature: float = FieldUnset,
+        reasoning_effort: ChatCompletionReasoningEffort = FieldUnset,
+        image_resolution_dpi: int = FieldUnset,
+        browser_canvas: BrowserCanvas = FieldUnset,
+        n_consensus: int = FieldUnset,
     ) -> ProcessorConfig:
         """Create a new processor configuration.
 
@@ -248,7 +253,7 @@ class Processors(SyncAPIResource, ProcessorsMixin):
             n_consensus=n_consensus,
         )
         response = self._client._prepared_request(request)
-        print(f"Processor ID: {response['id']}. Processor available at https://www.retab.dev/dashboard/processors/{response['id']}")
+        print(f"Processor ID: {response['id']}. Processor available at https://www.retab.com/dashboard/processors/{response['id']}")
         return ProcessorConfig.model_validate(response)
 
     def list(
@@ -390,11 +395,11 @@ class AsyncProcessors(AsyncAPIResource, ProcessorsMixin):
         json_schema: dict[str, Any] | Path | str,
         modality: Modality = "native",
         model: str = "gpt-4o-mini",
-        temperature: float = PydanticUndefined,  # type: ignore[assignment]
-        reasoning_effort: ChatCompletionReasoningEffort = PydanticUndefined,  # type: ignore[assignment]
-        image_resolution_dpi: int = PydanticUndefined,  # type: ignore[assignment]
-        browser_canvas: BrowserCanvas = PydanticUndefined,  # type: ignore[assignment]
-        n_consensus: int = PydanticUndefined,  # type: ignore[assignment]
+        temperature: float = FieldUnset,
+        reasoning_effort: ChatCompletionReasoningEffort = FieldUnset,
+        image_resolution_dpi: int = FieldUnset,
+        browser_canvas: BrowserCanvas = FieldUnset,
+        n_consensus: int = FieldUnset,
     ) -> ProcessorConfig:
         request = self.prepare_create(
             name=name,
@@ -408,7 +413,7 @@ class AsyncProcessors(AsyncAPIResource, ProcessorsMixin):
             n_consensus=n_consensus,
         )
         response = await self._client._prepared_request(request)
-        print(f"Processor ID: {response['id']}. Processor available at https://www.retab.dev/dashboard/processors/{response['id']}")
+        print(f"Processor ID: {response['id']}. Processor available at https://www.retab.com/dashboard/processors/{response['id']}")
 
         return ProcessorConfig.model_validate(response)
 

retab/resources/usage.py

@@ -84,6 +84,7 @@ class Usage(SyncAPIResource, UsageMixin):
     def monthly_credits_usage(self) -> MonthlyUsageResponse:
         """
         Get monthly credits usage information.
+        Credits are calculated dynamically based on MIME type and consumption.
 
         Returns:
             dict: Monthly usage data including credits consumed and limits
@@ -198,6 +199,7 @@ class AsyncUsage(AsyncAPIResource, UsageMixin):
     async def monthly_credits_usage(self) -> MonthlyUsageResponse:
         """
         Get monthly credits usage information.
+        Credits are calculated dynamically based on MIME type and consumption.
 
         Returns:
             dict: Monthly usage data including credits consumed and limits

retab/types/ai_models.py

@@ -79,7 +79,7 @@ class FinetunedModel(BaseModel):
 
 # Monthly Usage
 class MonthlyUsageResponseContent(BaseModel):
-    request_count: int
+    credits_count: float  # Changed to float to support decimal credits
 
 
 MonthlyUsageResponse = MonthlyUsageResponseContent

retab/types/automations/mailboxes.py

@@ -17,7 +17,7 @@ class Mailbox(AutomationConfig):
     def object(self) -> str:
         return "automation.mailbox"
 
-    EMAIL_PATTERN: ClassVar[str] = f".*@{os.getenv('EMAIL_DOMAIN', 'mailbox.retab.dev')}$"
+    EMAIL_PATTERN: ClassVar[str] = f".*@{os.getenv('EMAIL_DOMAIN', 'mailbox.retab.com')}$"
     id: str = Field(default_factory=lambda: "mb_" + nanoid.generate(), description="Unique identifier for the mailbox")
 
     # Email Specific config