retab 0.0.35__py3-none-any.whl → 0.0.37__py3-none-any.whl

uiform/resources/processors/automations/outlook.py

@@ -1,444 +0,0 @@
-import json
-from io import IOBase
-from pathlib import Path
-from typing import Any, Dict, List, Literal, Optional
-
-from openai.types.chat.chat_completion_reasoning_effort import ChatCompletionReasoningEffort
-from PIL.Image import Image
-from pydantic import HttpUrl
-
-from ...._resource import AsyncAPIResource, SyncAPIResource
-from ...._utils.ai_models import assert_valid_model_extraction
-from ....types.automations.outlook import FetchParams, ListOutlooks, MatchParams, Outlook, UpdateOutlookRequest
-from ....types.logs import AutomationLog
-from ....types.modalities import Modality
-from ....types.standards import PreparedRequest
-
-
-class OutlooksMixin:
-    def prepare_create(
-        self,
-        name: str,
-        json_schema: Dict[str, Any],
-        webhook_url: HttpUrl,
-        # email specific opitonals Fields
-        authorized_domains: List[str] = [],
-        authorized_emails: List[str] = [],
-        # HTTP Config Optional Fields
-        webhook_headers: Dict[str, str] = {},
-        # DocumentExtraction Config
-        image_resolution_dpi: Optional[int] = None,
-        browser_canvas: Optional[Literal['A3', 'A4', 'A5']] = None,
-        modality: Modality = "native",
-        model: str = "gpt-4o-mini",
-        temperature: float = 0,
-        reasoning_effort: ChatCompletionReasoningEffort = "medium",
-        # Optional Fields for data integration
-        match_params: Optional[List[MatchParams]] = None,
-        fetch_params: Optional[List[FetchParams]] = None,
-        layout_schema: Optional[Dict[str, Any]] = None,
-    ) -> PreparedRequest:
-        assert_valid_model_extraction(model)
-
-        data = {
-            "name": name,
-            "webhook_url": webhook_url,
-            "webhook_headers": webhook_headers,
-            "json_schema": json_schema,
-            "authorized_domains": authorized_domains,
-            "authorized_emails": authorized_emails,
-            "image_resolution_dpi": image_resolution_dpi,
-            "browser_canvas": browser_canvas,
-            "modality": modality,
-            "model": model,
-            "temperature": temperature,
-            "reasoning_effort": reasoning_effort,
-            "layout_schema": layout_schema,
-        }
-
-        if match_params is not None:
-            data["match_params"] = match_params
-        if fetch_params is not None:
-            data["fetch_params"] = fetch_params
-
-        # Validate the data
-        outlook_data = Outlook.model_validate(data)
-        return PreparedRequest(method="POST", url="/v1/deployments/outlook", data=outlook_data.model_dump(mode="json"))
-
-    def prepare_list(
-        self,
-        before: str | None = None,
-        after: str | None = None,
-        limit: int = 10,
-        order: Literal["asc", "desc"] | None = "desc",
-        name: Optional[str] = None,
-        webhook_url: Optional[str] = None,
-        schema_id: Optional[str] = None,
-        schema_data_id: Optional[str] = None,
-    ) -> PreparedRequest:
-        params = {
-            "before": before,
-            "after": after,
-            "limit": limit,
-            "order": order,
-            "name": name,
-            "webhook_url": webhook_url,
-            "schema_id": schema_id,
-            "schema_data_id": schema_data_id,
-        }
-        # Remove None values
-        params = {k: v for k, v in params.items() if v is not None}
-
-        return PreparedRequest(method="GET", url="/v1/deployments/outlook", params=params)
-
-    def prepare_get(self, outlook_id: str) -> PreparedRequest:
-        return PreparedRequest(method="GET", url=f"/v1/processors/automations/outlook/{outlook_id}")
-
-    def prepare_update(
-        self,
-        outlook_id: str,
-        name: Optional[str] = None,
-        webhook_url: Optional[HttpUrl] = None,
-        webhook_headers: Optional[Dict[str, str]] = None,
-        authorized_domains: Optional[List[str]] = None,
-        authorized_emails: Optional[List[str]] = None,
-        image_resolution_dpi: Optional[int] = None,
-        browser_canvas: Optional[Literal['A3', 'A4', 'A5']] = None,
-        modality: Optional[Modality] = None,
-        model: Optional[str] = None,
-        temperature: Optional[float] = None,
-        reasoning_effort: Optional[ChatCompletionReasoningEffort] = None,
-        json_schema: Optional[Dict[str, Any]] = None,
-        match_params: Optional[List[MatchParams]] = None,
-        fetch_params: Optional[List[FetchParams]] = None,
-        layout_schema: Optional[Dict[str, Any]] = None,
-    ) -> PreparedRequest:
-        data: dict[str, Any] = {}
-        if name is not None:
-            data["name"] = name
-        if webhook_url is not None:
-            data["webhook_url"] = webhook_url
-        if webhook_headers is not None:
-            data["webhook_headers"] = webhook_headers
-        if authorized_domains is not None:
-            data["authorized_domains"] = authorized_domains
-        if authorized_emails is not None:
-            data["authorized_emails"] = authorized_emails
-        if image_resolution_dpi is not None:
-            data["image_resolution_dpi"] = image_resolution_dpi
-        if browser_canvas is not None:
-            data["browser_canvas"] = browser_canvas
-        if modality is not None:
-            data["modality"] = modality
-        if model is not None:
-            assert_valid_model_extraction(model)
-            data["model"] = model
-        if temperature is not None:
-            data["temperature"] = temperature
-        if json_schema is not None:
-            data["json_schema"] = json_schema
-        if match_params is not None:
-            data["match_params"] = match_params
-        if fetch_params is not None:
-            data["fetch_params"] = fetch_params
-        if reasoning_effort is not None:
-            data["reasoning_effort"] = reasoning_effort
-        if layout_schema is not None:
-            data["layout_schema"] = layout_schema
-
-        update_outlook_request = UpdateOutlookRequest.model_validate(data)
-
-        return PreparedRequest(method="PUT", url=f"/v1/processors/automations/outlook/{outlook_id}", data=update_outlook_request.model_dump(mode="json"))
-
-    def prepare_delete(self, outlook_id: str) -> PreparedRequest:
-        return PreparedRequest(method="DELETE", url=f"/v1/processors/automations/outlook/{outlook_id}")
-
-class Outlooks(SyncAPIResource, OutlooksMixin):
-    """Outlook API wrapper for managing outlook automation configurations"""
-
-    def __init__(self, client: Any) -> None:
-        super().__init__(client=client)
-
-    def create(
-        self,
-        name: str,
-        json_schema: Dict[str, Any],
-        webhook_url: HttpUrl,
-        authorized_domains: List[str] = [],
-        authorized_emails: List[str] = [],
-        webhook_headers: Dict[str, str] = {},
-        image_resolution_dpi: Optional[int] = None,
-        browser_canvas: Optional[Literal['A3', 'A4', 'A5']] = None,
-        modality: Modality = "native",
-        model: str = "gpt-4o-mini",
-        temperature: float = 0,
-        reasoning_effort: ChatCompletionReasoningEffort = "medium",
-        match_params: Optional[List[MatchParams]] = None,
-        fetch_params: Optional[List[FetchParams]] = None,
-    ) -> Outlook:
-        """Create a new outlook automation configuration.
-
-        Args:
-            name: Name of the outlook plugin
-            json_schema: JSON schema to validate extracted data
-            webhook_url: Webhook URL to receive processed data
-            webhook_headers: Webhook headers to send with processed data
-            authorized_domains: List of authorized domains
-            authorized_emails: List of authorized emails
-            image_resolution_dpi: Optional image resolution DPI
-            browser_canvas: Optional browser canvas size
-            modality: Processing modality (currently only "native" supported)
-            model: AI model to use for processing
-            temperature: Model temperature setting
-            reasoning_effort: The effort level for the model to reason about the input data.
-            match_params: List of match parameters for the outlook automation
-            fetch_params: List of fetch parameters for the outlook automation
-        Returns:
-            Outlook: The created outlook plugin configuration
-        """
-
-        request = self.prepare_create(
-            name,
-            json_schema,
-            webhook_url,
-            authorized_domains,
-            authorized_emails,
-            webhook_headers,
-            image_resolution_dpi,
-            browser_canvas,
-            modality,
-            model,
-            temperature,
-            reasoning_effort,
-            match_params,
-            fetch_params,
-        )
-        response = self._client._prepared_request(request)
-
-        print(f"Outlook automation created. Outlook available at https://www.uiform.com/dashboard/processors/{response['id']}")
-
-        return Outlook.model_validate(response)
-
-    def list(
-        self,
-        before: str | None = None,
-        after: str | None = None,
-        limit: int = 10,
-        order: Literal["asc", "desc"] | None = "desc",
-        name: Optional[str] = None,
-        webhook_url: Optional[str] = None,
-        schema_id: Optional[str] = None,
-        schema_data_id: Optional[str] = None,
-    ) -> ListOutlooks:
-        """List all outlook automation configurations.
-
-        Args:
-            before: Optional cursor for pagination - get results before this log ID
-            after: Optional cursor for pagination - get results after this log ID
-            limit: Maximum number of logs to return (1-100, default 10)
-            order: Sort order by creation time - "asc" or "desc" (default "desc")
-            name: Optional name filter
-            webhook_url: Optional webhook URL filter
-            schema_id: Optional schema ID filter
-            schema_data_id: Optional schema data ID filter
-            match_params: Optional list of match parameters for the outlook automation
-            fetch_params: Optional list of fetch parameters for the outlook automation
-        Returns:
-            List[Outlook]: List of outlook plugin configurations
-        """
-        request = self.prepare_list(before, after, limit, order, name, webhook_url, schema_id, schema_data_id)
-        response = self._client._prepared_request(request)
-        return ListOutlooks.model_validate(response)
-
-    def get(self, id: str) -> Outlook:
-        """Get a specific outlook automation configuration.
-
-        Args:
-            id: ID of the outlook plugin
-
-        Returns:
-            Outlook: The outlook plugin configuration
-        """
-        request = self.prepare_get(id)
-        response = self._client._prepared_request(request)
-        return Outlook.model_validate(response)
-
-    def update(
-        self,
-        outlook_id: str,
-        name: Optional[str] = None,
-        webhook_url: Optional[HttpUrl] = None,
-        webhook_headers: Optional[Dict[str, str]] = None,
-        authorized_domains: Optional[List[str]] = None,
-        authorized_emails: Optional[List[str]] = None,
-        image_resolution_dpi: Optional[int] = None,
-        browser_canvas: Optional[Literal['A3', 'A4', 'A5']] = None,
-        modality: Optional[Modality] = None,
-        model: Optional[str] = None,
-        temperature: Optional[float] = None,
-        reasoning_effort: Optional[ChatCompletionReasoningEffort] = None,
-        json_schema: Optional[Dict[str, Any]] = None,
-        match_params: Optional[List[MatchParams]] = None,
-        fetch_params: Optional[List[FetchParams]] = None,
-        layout_schema: Optional[Dict[str, Any]] = None,
-    ) -> Outlook:
-        """Update an outlook automation configuration.
-
-        Args:
-            outlook_id: ID of the outlook plugin to update
-            name: New name for the outlook plugin
-            webhook_url: New webhook URL
-            webhook_headers: New webhook headers
-            authorized_domains: New authorized domains
-            authorized_emails: New authorized emails
-            image_resolution_dpi: New image resolution DPI
-            browser_canvas: New browser canvas size
-            modality: New processing modality
-            model: New AI model
-            temperature: New temperature setting
-            reasoning_effort: New reasoning effort
-            json_schema: New JSON schema
-            match_params: New match parameters for the outlook automation
-            fetch_params: New fetch parameters for the outlook automation
-            layout_schema: New layout schema for the outlook automation
-
-        Returns:
-            Outlook: The updated outlook plugin configuration
-        """
-        request = self.prepare_update(
-            outlook_id,
-            name,
-            webhook_url,
-            webhook_headers,
-            authorized_domains,
-            authorized_emails,
-            image_resolution_dpi,
-            browser_canvas,
-            modality,
-            model,
-            temperature,
-            reasoning_effort,
-            json_schema,
-            match_params,
-            fetch_params,
-            layout_schema,
-        )
-        response = self._client._prepared_request(request)
-        return Outlook.model_validate(response)
-
-    def delete(self, outlook_id: str) -> None:
-        """Delete an outlook automation configuration.
-
-        Args:
-            outlook_id: ID of the outlook plugin to delete
-        """
-        request = self.prepare_delete(outlook_id)
-        response = self._client._prepared_request(request)
-        return None
-
-
-class AsyncOutlooks(AsyncAPIResource, OutlooksMixin):
-    def __init__(self, client: Any) -> None:
-        super().__init__(client=client)
-
-    async def create(
-        self,
-        name: str,
-        json_schema: Dict[str, Any],
-        webhook_url: HttpUrl,
-        authorized_domains: List[str] = [],
-        authorized_emails: List[str] = [],
-        webhook_headers: Dict[str, str] = {},
-        image_resolution_dpi: Optional[int] = None,
-        browser_canvas: Optional[Literal['A3', 'A4', 'A5']] = None,
-        modality: Modality = "native",
-        model: str = "gpt-4o-mini",
-        temperature: float = 0,
-        reasoning_effort: ChatCompletionReasoningEffort = "medium",
-        match_params: List[MatchParams] = [],
-        fetch_params: List[FetchParams] = [],
-    ) -> Outlook:
-        request = self.prepare_create(
-            name,
-            json_schema,
-            webhook_url,
-            authorized_domains,
-            authorized_emails,
-            webhook_headers,
-            image_resolution_dpi,
-            browser_canvas,
-            modality,
-            model,
-            temperature,
-            reasoning_effort,
-            match_params,
-            fetch_params,
-        )
-        response = await self._client._prepared_request(request)
-        print(f"Outlook automation created. Outlook available at https://www.uiform.com/dashboard/processors/{response['id']}")
-        return Outlook.model_validate(response)
-
-    async def list(
-        self,
-        before: str | None = None,
-        after: str | None = None,
-        limit: int = 10,
-        order: Literal["asc", "desc"] | None = "desc",
-        name: Optional[str] = None,
-        webhook_url: Optional[str] = None,
-        schema_id: Optional[str] = None,
-        schema_data_id: Optional[str] = None,
-    ) -> ListOutlooks:
-        request = self.prepare_list(before, after, limit, order, name, webhook_url, schema_id, schema_data_id)
-        response = await self._client._prepared_request(request)
-        return ListOutlooks.model_validate(response)
-
-    async def get(self, outlook_id: str) -> Outlook:
-        request = self.prepare_get(outlook_id)
-        response = await self._client._prepared_request(request)
-        return Outlook.model_validate(response)
-
-    async def update(
-        self,
-        outlook_id: str,
-        name: Optional[str] = None,
-        webhook_url: Optional[HttpUrl] = None,
-        webhook_headers: Optional[Dict[str, str]] = None,
-        authorized_domains: Optional[List[str]] = None,
-        authorized_emails: Optional[List[str]] = None,
-        image_resolution_dpi: Optional[int] = None,
-        browser_canvas: Optional[Literal['A3', 'A4', 'A5']] = None,
-        modality: Optional[Modality] = None,
-        model: Optional[str] = None,
-        temperature: Optional[float] = None,
-        reasoning_effort: Optional[ChatCompletionReasoningEffort] = None,
-        json_schema: Optional[Dict[str, Any]] = None,
-        match_params: Optional[List[MatchParams]] = None,
-        fetch_params: Optional[List[FetchParams]] = None,
-        layout_schema: Optional[Dict[str, Any]] = None,
-    ) -> Outlook:
-        request = self.prepare_update(
-            outlook_id,
-            name,
-            webhook_url,
-            webhook_headers,
-            authorized_domains,
-            authorized_emails,
-            image_resolution_dpi,
-            browser_canvas,
-            modality,
-            model,
-            temperature,
-            reasoning_effort,
-            json_schema,
-            match_params,
-            fetch_params,
-            layout_schema,
-        )
-        response = await self._client._prepared_request(request)
-        return Outlook.model_validate(response)
-
-    async def delete(self, outlook_id: str) -> None:
-        request = self.prepare_delete(outlook_id)
-        await self._client._prepared_request(request)
-        return None

uiform/resources/secrets/webhook.py

@@ -1,62 +0,0 @@
-from ..._resource import AsyncAPIResource, SyncAPIResource
-from ...types.standards import PreparedRequest
-
-
-class WebhookMixin:
-    def prepare_create(self) -> PreparedRequest:
-        return PreparedRequest(method="POST", url="/v1/secrets/webhook")
-
-    def prepare_delete(self) -> PreparedRequest:
-        return PreparedRequest(method="DELETE", url="/v1/secrets/webhook")
-
-
-class Webhook(SyncAPIResource, WebhookMixin):
-    """Webhook secret management wrapper"""
-
-    def create(
-        self,
-    ) -> dict:
-        """Create a webhook secret.
-
-        Returns:
-            dict: Response indicating success
-        """
-        request = self.prepare_create()
-        response = self._client._prepared_request(request)
-
-        return response
-
-    def delete(self) -> dict:
-        """Delete a webhook secret.
-
-        Returns:
-            dict: Response indicating success
-        """
-        request = self.prepare_delete()
-        response = self._client._prepared_request(request)
-
-        return response
-
-
-class AsyncWebhook(AsyncAPIResource, WebhookMixin):
-    """Webhook secret management wrapper"""
-
-    async def create(self) -> dict:
-        """Create a webhook secret.
-
-        Returns:
-            dict: Response indicating success
-        """
-        request = self.prepare_create()
-        response = await self._client._prepared_request(request)
-        return response
-
-    async def delete(self) -> dict:
-        """Delete a webhook secret.
-
-        Returns:
-            dict: Response indicating success
-        """
-        request = self.prepare_delete()
-        response = await self._client._prepared_request(request)
-        return response

uiform/types/consensus.py

@@ -1,10 +0,0 @@
-from pydantic import BaseModel, Field
-
-
-class ReconciliationResponse(BaseModel):
-    consensus_dict: dict = Field(
-        description="The consensus dictionary containing the reconciled values from the input dictionaries."
-    )
-    likelihoods: dict = Field(
-        description="A dictionary containing the likelihood/confidence scores for each field in the consensus dictionary."
-    )

uiform/types/deployments/cron.py

@@ -1,59 +0,0 @@
-import datetime
-from typing import Any, Literal, Optional
-
-import nanoid  # type: ignore
-from openai.types.chat.chat_completion_reasoning_effort import ChatCompletionReasoningEffort
-from pydantic import BaseModel, Field, HttpUrl, field_serializer
-from pydantic_core import Url
-
-from ..modalities import Modality
-
-
-def scrapping_action(link: HttpUrl) -> dict[str, Any]:
-    raise NotImplementedError("Scrapping action not implemented")
-
-
-class CronSchedule(BaseModel):
-    second: Optional[int] = Field(0, ge=0, le=59, description="Second (0-59), defaults to 0")
-    minute: int = Field(..., ge=0, le=59, description="Minute (0-59)")
-    hour: int = Field(..., ge=0, le=23, description="Hour (0-23)")
-    day_of_month: Optional[int] = Field(None, ge=1, le=31, description="Day of the month (1-31), None means any day")
-    month: Optional[int] = Field(None, ge=1, le=12, description="Month (1-12), None means every month")
-    day_of_week: Optional[int] = Field(None, ge=0, le=6, description="Day of the week (0-6, Sunday = 0), None means any day")
-
-    def to_cron_string(self) -> str:
-        return f"{self.second or '*'} {self.minute} {self.hour} {self.day_of_month or '*'} {self.month or '*'} {self.day_of_week or '*'}"
-
-
-from ..logs import AutomationConfig
-
-
-class ScrappingConfig(AutomationConfig):
-    object: Literal['deployment.scrapping_cron'] = "deployment.scrapping_cron"
-    id: str = Field(default_factory=lambda: "scrapping_" + nanoid.generate(), description="Unique identifier for the scrapping job")
-
-    # Scrapping Specific Config
-    link: HttpUrl = Field(..., description="Link to be scrapped")
-    schedule: CronSchedule
-
-    updated_at: datetime.datetime = Field(default_factory=lambda: datetime.datetime.now(datetime.timezone.utc))
-
-    # HTTP Config
-    webhook_url: HttpUrl = Field(..., description="Url of the webhook to send the data to")
-    webhook_headers: dict[str, str] = Field(default_factory=dict, description="Headers to send with the request")
-
-    modality: Modality
-    image_resolution_dpi: int = Field(default=96, description="Resolution of the image sent to the LLM")
-    browser_canvas: Literal['A3', 'A4', 'A5'] = Field(default='A4', description="Sets the size of the browser canvas for rendering documents in browser-based processing. Choose a size that matches the document type.")
-
-    # New attributes
-    model: str = Field(..., description="Model used for chat completion")
-    json_schema: dict[str, Any] = Field(..., description="JSON schema format used to validate the output data.")
-    temperature: float = Field(default=0.0, description="Temperature for sampling. If not provided, the default temperature for the model will be used.", examples=[0.0])
-    reasoning_effort: ChatCompletionReasoningEffort = Field(
-        default="medium", description="The effort level for the model to reason about the input data. If not provided, the default reasoning effort for the model will be used."
-    )
-
-    @field_serializer('webhook_url', 'link')
-    def url2str(self, val: HttpUrl) -> str:
-        return str(val)

uiform/types/deployments/endpoints.py

@@ -1,28 +0,0 @@
-import copy
-import datetime
-import json
-from typing import Any, Literal, Optional
-
-import nanoid  # type: ignore
-from openai.types.chat.chat_completion_reasoning_effort import ChatCompletionReasoningEffort
-from pydantic import BaseModel, Field, HttpUrl, computed_field, field_serializer
-
-from ..._utils.json_schema import clean_schema
-from ..._utils.mime import generate_blake2b_hash_from_string
-from ..logs import AutomationConfig, UpdateAutomationRequest
-from ..modalities import Modality
-from ..pagination import ListMetadata
-
-
-class Endpoint(AutomationConfig):
-    object: Literal['deployment.endpoint'] = "deployment.endpoint"
-    id: str = Field(default_factory=lambda: "endp_" + nanoid.generate(), description="Unique identifier for the extraction endpoint")
-
-class ListEndpoints(BaseModel):
-    data: list[Endpoint]
-    list_metadata: ListMetadata
-
-
-# Inherits from the methods of UpdateAutomationRequest
-class UpdateEndpointRequest(UpdateAutomationRequest):
-    pass

uiform/types/deployments/links.py

@@ -1,36 +0,0 @@
-import copy
-import datetime
-import json
-from typing import Any, Dict, Literal, Optional
-
-import nanoid  # type: ignore
-from openai.types.chat.chat_completion_reasoning_effort import ChatCompletionReasoningEffort
-from pydantic import BaseModel, Field, HttpUrl, computed_field, field_serializer
-from pydantic_core import Url
-
-from ..._utils.json_schema import clean_schema
-from ..._utils.mime import generate_blake2b_hash_from_string
-from ..logs import AutomationConfig, UpdateAutomationRequest
-from ..modalities import Modality
-from ..pagination import ListMetadata
-
-
-class Link(AutomationConfig):
-    object: Literal['deployment.link'] = "deployment.link"
-    id: str = Field(default_factory=lambda: "lnk_" + nanoid.generate(), description="Unique identifier for the extraction link")
-
-    # Link Specific Config
-    password: Optional[str] = Field(None, description="Password to access the link")
-
-
-class ListLinks(BaseModel):
-    data: list[Link]
-    list_metadata: ListMetadata
-
-
-# Inherits from the methods of UpdateAutomationRequest
-class UpdateLinkRequest(UpdateAutomationRequest):
-    # ------------------------------
-    # Link Config
-    # ------------------------------
-    password: Optional[str] = None