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

retab/types/completions.py

@@ -7,15 +7,15 @@ from openai.types.shared_params.reasoning import Reasoning
 from openai.types.shared_params.response_format_json_schema import ResponseFormatJSONSchema
 from pydantic import BaseModel, ConfigDict, Field
 
-from .._utils.ai_models import find_provider_from_model
+from .._utils.ai_models import get_provider_for_model
 from .ai_models import AIProvider
-from .chat import ChatCompletionUiformMessage
+from .chat import ChatCompletionRetabMessage
 
 
-class UiChatCompletionsRequest(BaseModel):
+class RetabChatCompletionsRequest(BaseModel):
     model_config = ConfigDict(arbitrary_types_allowed=True)
     model: str = Field(..., description="Model used for chat completion")
-    messages: list[ChatCompletionUiformMessage] = Field(..., description="Messages to be parsed")
+    messages: list[ChatCompletionRetabMessage] = Field(..., description="Messages to be parsed")
     response_format: ResponseFormatJSONSchema = Field(..., description="response 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(
@@ -34,13 +34,13 @@ class UiChatCompletionsRequest(BaseModel):
         Returns:
             AIProvider: The AI provider corresponding to the given model.
         """
-        return find_provider_from_model(self.model)
+        return get_provider_for_model(self.model)
 
 
-class UiChatCompletionsParseRequest(BaseModel):
+class RetabChatCompletionsParseRequest(BaseModel):
     model_config = ConfigDict(arbitrary_types_allowed=True)
     model: str = Field(..., description="Model used for chat completion")
-    messages: list[ChatCompletionUiformMessage] = Field(..., description="Messages to be parsed")
+    messages: list[ChatCompletionRetabMessage] = Field(..., description="Messages to be parsed")
     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(
@@ -59,10 +59,10 @@ class UiChatCompletionsParseRequest(BaseModel):
         Returns:
             AIProvider: The AI provider corresponding to the given model.
         """
-        return find_provider_from_model(self.model)
+        return get_provider_for_model(self.model)
 
 
-class UiChatResponseCreateRequest(BaseModel):
+class RetabChatResponseCreateRequest(BaseModel):
     input: Union[str, ResponseInputParam] = Field(..., description="Input to be parsed")
     instructions: Optional[str] = None
 
@@ -87,4 +87,4 @@ class UiChatResponseCreateRequest(BaseModel):
         Returns:
             AIProvider: The AI provider corresponding to the given model.
         """
-        return find_provider_from_model(self.model)
+        return get_provider_for_model(self.model)

retab/types/documents/__init__.py

@@ -0,0 +1,3 @@
+from .parse import ParseRequest, ParseResult, RetabUsage
+
+__all__ = ["ParseRequest", "ParseResult", "RetabUsage"]

retab/types/documents/create_messages.py

@@ -14,7 +14,7 @@ from ..._utils.chat import convert_to_anthropic_format, convert_to_google_genai_
 from ..._utils.chat import convert_to_openai_format as convert_to_openai_completions_api_format
 from ..._utils.display import count_image_tokens, count_text_tokens
 from ..._utils.responses import convert_to_openai_format as convert_to_openai_responses_api_format
-from ..chat import ChatCompletionUiformMessage
+from ..chat import ChatCompletionRetabMessage
 from ..mime import MIMEData
 from ..modalities import Modality
 from ..browser_canvas import BrowserCanvas
@@ -44,7 +44,7 @@ class DocumentCreateInputRequest(DocumentCreateMessageRequest):
 class DocumentMessage(BaseModel):
     id: str = Field(description="A unique identifier for the document loading.")
     object: Literal["document_message"] = Field(default="document_message", description="The type of object being loaded.")
-    messages: List[ChatCompletionUiformMessage] = Field(description="A list of messages containing the document content and metadata.")
+    messages: List[ChatCompletionRetabMessage] = Field(description="A list of messages containing the document content and metadata.")
     created: int = Field(description="The Unix timestamp (in seconds) of when the document was loaded.")
     modality: Modality = Field(description="The modality of the document to load.")
 

retab/types/documents/extractions.py

@@ -17,7 +17,7 @@ from pydantic import BaseModel, ConfigDict, Field, ValidationInfo, computed_fiel
 
 from ..._utils.usage.usage import CostBreakdown, compute_cost_from_model, compute_cost_from_model_with_breakdown
 from ..ai_models import Amount
-from ..chat import ChatCompletionUiformMessage
+from ..chat import ChatCompletionRetabMessage
 from ..mime import MIMEData
 from ..modalities import Modality
 from ..browser_canvas import BrowserCanvas
@@ -96,7 +96,7 @@ class FieldLocation(BaseModel):
     match_level: Literal["token", "line", "block"] | None = Field(default=None, description="The level of the match (token, line, block)")
 
 
-class UiParsedChoice(ParsedChoice):
+class RetabParsedChoice(ParsedChoice):
     # Adaptable ParsedChoice that allows None for the finish_reason
     finish_reason: Literal["stop", "length", "tool_calls", "content_filter", "function_call"] | None = None  # type: ignore
     field_locations: dict[str, list[FieldLocation]] | None = Field(default=None, description="The locations of the fields in the document, if available")
@@ -106,9 +106,9 @@ class UiParsedChoice(ParsedChoice):
 LikelihoodsSource = Literal["consensus", "log_probs"]
 
 
-class UiParsedChatCompletion(ParsedChatCompletion):
+class RetabParsedChatCompletion(ParsedChatCompletion):
     extraction_id: str | None = None
-    choices: list[UiParsedChoice]  # type: ignore
+    choices: list[RetabParsedChoice]  # type: ignore
     # Additional metadata fields (UIForm)
     likelihoods: Optional[dict[str, Any]] = Field(
         default=None, description="Object defining the uncertainties of the fields extracted when using consensus. Follows the same structure as the extraction object."
@@ -146,7 +146,7 @@ class UiResponse(Response):
 
 
 class LogExtractionRequest(BaseModel):
-    messages: list[ChatCompletionUiformMessage] | None = None  # TODO: compatibility with Anthropic
+    messages: list[ChatCompletionRetabMessage] | None = None  # TODO: compatibility with Anthropic
     openai_messages: list[ChatCompletionMessageParam] | None = None
     openai_responses_input: list[ResponseInputItemParam] | None = None
     anthropic_messages: list[MessageParam] | None = None
@@ -159,7 +159,7 @@ class LogExtractionRequest(BaseModel):
         ),
         description="Document analyzed, if not provided a dummy one will be created with the text 'No document provided'",
     )
-    completion: dict | UiParsedChatCompletion | Message | ParsedChatCompletion | ChatCompletion | None = None
+    completion: dict | RetabParsedChatCompletion | Message | ParsedChatCompletion | ChatCompletion | None = None
     openai_responses_output: Response | None = None
     json_schema: dict[str, Any]
     model: str
@@ -215,7 +215,7 @@ class LogExtractionResponse(BaseModel):
     error_message: str | None = None
 
 
-# DocumentExtractResponse = UiParsedChatCompletion
+# DocumentExtractResponse = RetabParsedChatCompletion
 
 
 ###### I'll place here for now -- New Streaming API
@@ -227,7 +227,7 @@ class LogExtractionResponse(BaseModel):
 # - schema_validation_error: ErrorDetail | None = None #  The error in the schema validation of the total accumulated content
 
 
-class UiParsedChoiceDeltaChunk(ChoiceDeltaChunk):
+class RetabParsedChoiceDeltaChunk(ChoiceDeltaChunk):
     flat_likelihoods: dict[str, float] = {}
     flat_parsed: dict[str, Any] = {}
     flat_deleted_keys: list[str] = []
@@ -236,13 +236,13 @@ class UiParsedChoiceDeltaChunk(ChoiceDeltaChunk):
     key_mapping: dict[str, Optional[str]] | None = Field(default=None, description="Mapping of consensus keys to original model keys")
 
 
-class UiParsedChoiceChunk(ChoiceChunk):
-    delta: UiParsedChoiceDeltaChunk  # type: ignore
+class RetabParsedChoiceChunk(ChoiceChunk):
+    delta: RetabParsedChoiceDeltaChunk  # type: ignore
 
 
-class UiParsedChatCompletionChunk(StreamingBaseModel, ChatCompletionChunk):
+class RetabParsedChatCompletionChunk(StreamingBaseModel, ChatCompletionChunk):
     extraction_id: str | None = None
-    choices: list[UiParsedChoiceChunk]  # type: ignore
+    choices: list[RetabParsedChoiceChunk]  # type: ignore
     schema_validation_error: ErrorDetail | None = None
     # Timestamps
     request_at: datetime.datetime | None = Field(default=None, description="Timestamp of the request")
@@ -273,16 +273,16 @@ class UiParsedChatCompletionChunk(StreamingBaseModel, ChatCompletionChunk):
                 return None
         return None
 
-    def chunk_accumulator(self, previous_cumulated_chunk: "UiParsedChatCompletionChunk | None" = None) -> "UiParsedChatCompletionChunk":
+    def chunk_accumulator(self, previous_cumulated_chunk: "RetabParsedChatCompletionChunk | None" = None) -> "RetabParsedChatCompletionChunk":
         """
-        Accumulate the chunk into the state, returning a new UiParsedChatCompletionChunk with the accumulated content that could be yielded alone to generate the same state.
+        Accumulate the chunk into the state, returning a new RetabParsedChatCompletionChunk with the accumulated content that could be yielded alone to generate the same state.
         """
 
-        def safe_get_delta(chnk: "UiParsedChatCompletionChunk | None", index: int) -> UiParsedChoiceDeltaChunk:
+        def safe_get_delta(chnk: "RetabParsedChatCompletionChunk | None", index: int) -> RetabParsedChoiceDeltaChunk:
             if chnk is not None and index < len(chnk.choices):
                 return chnk.choices[index].delta
             else:
-                return UiParsedChoiceDeltaChunk(
+                return RetabParsedChoiceDeltaChunk(
                     content="",
                     flat_parsed={},
                     flat_likelihoods={},
@@ -313,7 +313,7 @@ class UiParsedChatCompletionChunk(StreamingBaseModel, ChatCompletionChunk):
         last_token_at = self.last_token_at
         request_at = self.request_at
 
-        return UiParsedChatCompletionChunk(
+        return RetabParsedChatCompletionChunk(
             extraction_id=self.extraction_id,
             id=self.id,
             created=self.created,
@@ -321,8 +321,8 @@ class UiParsedChatCompletionChunk(StreamingBaseModel, ChatCompletionChunk):
             object=self.object,
             usage=usage,
             choices=[
-                UiParsedChoiceChunk(
-                    delta=UiParsedChoiceDeltaChunk(
+                RetabParsedChoiceChunk(
+                    delta=RetabParsedChoiceDeltaChunk(
                         content=acc_content[i],
                         flat_parsed=acc_flat_parsed[i],
                         flat_likelihoods=acc_flat_likelihoods[i],

retab/types/documents/parse.py

@@ -0,0 +1,32 @@
+from typing import Literal
+from pydantic import BaseModel, Field
+
+from ..mime import MIMEData, BaseMIMEData
+from ..browser_canvas import BrowserCanvas
+
+TableParsingFormat = Literal["markdown", "yaml", "html", "json"]
+
+
+class RetabUsage(BaseModel):
+    """Usage information for document processing."""
+
+    page_count: int = Field(..., description="Number of pages processed")
+    credits: float = Field(..., description="Credits consumed for processing")
+
+
+class ParseRequest(BaseModel):
+    """Request model for document parsing."""
+
+    document: MIMEData = Field(..., description="Document to parse")
+    fast_mode: bool = Field(default=False, description="Use fast mode for parsing (may reduce quality)")
+    table_parsing_format: TableParsingFormat = Field(default="html", description="Format for parsing tables")
+    image_resolution_dpi: int = Field(default=72, description="DPI for image processing")
+    browser_canvas: BrowserCanvas = Field(default="A4", description="Canvas size for document rendering")
+
+
+class ParseResult(BaseModel):
+    """Result of document parsing."""
+
+    document: BaseMIMEData = Field(..., description="Processed document metadata")
+    usage: RetabUsage = Field(..., description="Processing usage information")
+    pages: list[str] = Field(..., description="Text content of each page")

retab/types/extractions.py

@@ -6,8 +6,8 @@ from openai.types.chat import ChatCompletion
 from openai.types.chat.chat_completion_reasoning_effort import ChatCompletionReasoningEffort
 from pydantic import BaseModel, Field, computed_field, model_validator
 
-from uiform.types.chat import ChatCompletionUiformMessage
-from uiform.types.documents.extractions import UiParsedChatCompletion
+from retab.types.chat import ChatCompletionRetabMessage
+from retab.types.documents.extractions import RetabParsedChatCompletion
 
 from .._utils.usage.usage import CostBreakdown, compute_cost_from_model, compute_cost_from_model_with_breakdown
 from .ai_models import Amount
@@ -35,7 +35,7 @@ class ExtractionTimingStep(BaseModel):
 
 class Extraction(BaseModel):
     id: str = Field(default_factory=lambda: "extr_" + nanoid.generate(), description="Unique identifier of the analysis")
-    messages: list[ChatCompletionUiformMessage] = Field(default_factory=list)
+    messages: list[ChatCompletionRetabMessage] = Field(default_factory=list)
     messages_gcs: str = Field(..., description="GCS path to the messages")
     file_gcs_paths: list[str] = Field(..., description="GCS paths to the files")
     file_ids: list[str] = Field(..., description="IDs of the files")
@@ -44,7 +44,7 @@ class Extraction(BaseModel):
     file_id: str = Field(default="", description="ID of the first file (deprecated)")
 
     status: Literal["success", "failed"] = Field(..., description="Whether the analysis was successful")
-    completion: UiParsedChatCompletion | ChatCompletion = Field(..., description="Response generated by the analysis")
+    completion: RetabParsedChatCompletion | ChatCompletion = Field(..., description="Response generated by the analysis")
     json_schema: Any = Field(..., description="Response format (JSON Schema or pydantic_v2.BaseModel)")
     model: str = Field(..., description="Model used for the analysis")
     temperature: float = Field(default=0.0, description="Temperature used for the analysis")

retab/types/logs.py

@@ -11,7 +11,7 @@ from .._utils.json_schema import compute_schema_data_id
 from .._utils.mime import generate_blake2b_hash_from_string
 from .._utils.usage.usage import CostBreakdown, compute_cost_from_model, compute_cost_from_model_with_breakdown
 from .ai_models import Amount
-from .documents.extractions import UiParsedChatCompletion
+from .documents.extractions import RetabParsedChatCompletion
 from .mime import BaseMIMEData
 from .modalities import Modality
 from .pagination import ListMetadata
@@ -199,7 +199,7 @@ class AutomationLog(BaseModel):
     organization_id: str
     created_at: datetime.datetime = Field(default_factory=lambda: datetime.datetime.now(datetime.timezone.utc))
     automation_snapshot: AutomationConfig
-    completion: UiParsedChatCompletion | ChatCompletion
+    completion: RetabParsedChatCompletion | ChatCompletion
     file_metadata: Optional[BaseMIMEData]
     external_request_log: Optional[ExternalRequestLog]
     extraction_id: Optional[str] = Field(default=None, description="ID of the extraction")

retab/types/schemas/object.py

@@ -27,7 +27,7 @@ from ..._utils.json_schema import (
 )
 from ..._utils.responses import convert_to_openai_format as convert_to_openai_responses_api_format
 from ...types.standards import StreamingBaseModel
-from ..chat import ChatCompletionUiformMessage
+from ..chat import ChatCompletionRetabMessage
 
 
 class PartialSchema(BaseModel):
@@ -609,8 +609,8 @@ You can easily identify the fields that require a source by the `quote___[attrib
         return data
 
     @property
-    def messages(self) -> list[ChatCompletionUiformMessage]:
-        return [ChatCompletionUiformMessage(role="developer", content=self.system_prompt)]
+    def messages(self) -> list[ChatCompletionRetabMessage]:
+        return [ChatCompletionRetabMessage(role="developer", content=self.system_prompt)]
 
     @model_validator(mode="after")
     def model_after_validator(self) -> Self:

{retab-0.0.37.dist-info → retab-0.0.39.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: retab
-Version: 0.0.37
+Version: 0.0.39
 Summary: Retab official python library
 Home-page: https://github.com/Retab-dev/retab
 Author: Retab
@@ -41,18 +41,18 @@ Requires-Dist: tiktoken
 Requires-Dist: truststore
 Requires-Dist: ruff
 
-# UiForm
+# Retab
 
 <div align="center" style="margin-bottom: 1em;">
 
-<img src="https://raw.githubusercontent.com/UiForm/uiform/refs/heads/main/assets/uiform-logo.png" alt="UiForm Logo" width="150">
+<img src="https://raw.githubusercontent.com/Retab/retab/refs/heads/main/assets/retab-logo.png" alt="Retab Logo" width="150">
 
 
   *The AI Automation Platform*
 
-Made with love by the team at [UiForm](https://uiform.com) 🤍.
+Made with love by the team at [Retab](https://retab.dev) 🤍.
 
-[Our Website](https://uiform.com) | [Documentation](https://docs.uiform.com/get-started/introduction) | [Discord](https://discord.com/invite/vc5tWRPqag) | [Twitter](https://x.com/uiformAPI)
+[Our Website](https://retab.dev) | [Documentation](https://docs.retab.dev/get-started/introduction) | [Discord](https://discord.com/invite/vc5tWRPqag) | [Twitter](https://x.com/retabdev)
 
 
 </div>
@@ -61,16 +61,16 @@ Made with love by the team at [UiForm](https://uiform.com) 🤍.
 
 ## How It Works
 
-UiForm allows you to easily create document processing automations. Here is the general workflow:
+Retab allows you to easily create document processing automations. Here is the general workflow:
 
 ```mermaid
 sequenceDiagram
-    User ->> UiForm: File Upload
-    UiForm -->> UiForm: Preprocessing
-    UiForm ->> AI Provider: Request on your behalf
-    AI Provider -->> UiForm:  Structured Generation
-    UiForm ->> Webhook: Send result
-    UiForm ->> User: Send Confirmation
+    User ->> Retab: File Upload
+    Retab -->> Retab: Preprocessing
+    Retab ->> AI Provider: Request on your behalf
+    AI Provider -->> Retab:  Structured Generation
+    Retab ->> Webhook: Send result
+    Retab ->> User: Send Confirmation
 ```
 
 ---
@@ -95,17 +95,17 @@ You come with your own API key from your favorite AI provider, and we handle the
 We currently support [OpenAI](https://platform.openai.com/docs/overview), [Anthropic](https://www.anthropic.com/api), [Gemini](https://aistudio.google.com/prompts/new_chat) and [xAI](https://x.ai/api) models.
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/UiForm/uiform/refs/heads/main/assets/supported_models.png" alt="Supported Models" width="600">
+  <img src="https://raw.githubusercontent.com/Retab/retab/refs/heads/main/assets/supported_models.png" alt="Supported Models" width="600">
 </p>
 
 ---
 
 ## Quickstart
 
-Explore our [Playground](https://www.uiform.com/dashboard/playground) and create your first automations easily 🚀!
+Explore our [Playground](https://www.retab.dev/dashboard/playground) and create your first automations easily 🚀!
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/UiForm/uiform/refs/heads/main/assets/uiform-playground.png" alt="UiForm Playground" width="600">
+  <img src="https://raw.githubusercontent.com/Retab/retab/refs/heads/main/assets/retab-playground.png" alt="Retab Playground" width="600">
 </p>
 
 ---
@@ -114,10 +114,10 @@ Explore our [Playground](https://www.uiform.com/dashboard/playground) and create
 
 ## Dev Mode 🔧
 
-You need more control? You can access the [Documentation](https://docs.uiform.com/get-started/introduction) of our **Python SDK**.
+You need more control? You can access the [Documentation](https://docs.retab.dev/get-started/introduction) of our **Python SDK**.
 
 1. **Setup the Python SDK**
-> Install the UiForm Python SDK and configure your API keys to start processing documents with your preferred AI provider.
+> Install the Retab Python SDK and configure your API keys to start processing documents with your preferred AI provider.
 
 2. **Create your JSON schema**
 > Define the structure of the data you want to extract from your documents using our schema format with custom prompting capabilities.
@@ -133,32 +133,32 @@ You need more control? You can access the [Documentation](https://docs.uiform.co
 
 ### Step 1: Setup of the Python SDK
 
-To get started, install the `uiform` package using pip:
+To get started, install the `retab` package using pip:
 
 ```bash
-pip install uiform
+pip install retab
 ```
 
-Then, [create your API key on uiform.com](https://www.uiform.com).
+Then, [create your API key on retab.dev](https://www.retab.dev).
 
 Create another API key by you favorite API key provider. 
 
 **Reminder**: We currently support [OpenAI](https://platform.openai.com/docs/overview), [Anthropic](https://www.anthropic.com/api), [Gemini](https://aistudio.google.com/prompts/new_chat) and [xAI](https://x.ai/api) models.
 
-As we will use your API key to make requests to OpenAI on your behalf within an automation, you need to store your API key in the UiForm secrets manager:
+As we will use your API key to make requests to OpenAI on your behalf within an automation, you need to store your API key in the Retab secrets manager:
 
 ```
 OPENAI_API_KEY=sk-xxxxxxxxx
-UIFORM_API_KEY=sk_uiform_xxxxxxxxx
+RETAB_API_KEY=sk_retab_xxxxxxxxx
 ```
 
 ```bash
-import uiform
+import retab
 import os
 
-uiclient = uiform.UiForm()
+reclient = retab.Retab()
 
-uiclient.secrets.external_api_keys.create(
+reclient.secrets.external_api_keys.create(
     provider="OpenAI", 
     api_key=os.getenv("OPENAI_API_KEY")
 )
@@ -167,14 +167,14 @@ uiclient.secrets.external_api_keys.create(
 #### Process your first document with the create_messages method:
 
 ```bash
-from uiform import UiForm
+from retab import Retab
 from openai import OpenAI
 
-# Initialize UiForm client
-uiclient = UiForm()
+# Initialize Retab client
+reclient = Retab()
 
 # Convert any document into LLM-ready format
-doc_msg = uiclient.documents.create_messages(
+doc_msg = reclient.documents.create_messages(
     document = "invoice.pdf"  # Works with PDFs, Excel, emails, etc.
 )
 
@@ -196,10 +196,10 @@ We use a standard JSON Schema with custom annotations (`X-SystemPrompt`, `X-Fiel
 
 These annotations help guide the LLM’s behavior and improve extraction accuracy. 
 
-You can learn more about these in our [JSON Schema documentation](https://docs.uiform.com/get-started/prompting-with-the-JSON-schema).
+You can learn more about these in our [JSON Schema documentation](https://docs.retab.dev/get-started/prompting-with-the-JSON-schema).
 
 ```bash
-from uiform import UiForm
+from retab import Retab
 from openai import OpenAI
 from pydantic import BaseModel, Field, ConfigDict
 
@@ -225,11 +225,11 @@ class Invoice(BaseModel):
     )
 
 # Process document and extract data
-uiclient = UiForm()
-doc_msg = uiclient.documents.create_messages(
+reclient = Retab()
+doc_msg = reclient.documents.create_messages(
     document = "invoice.pdf"
 )
-schema_obj = uiclient.schemas.load(
+schema_obj = reclient.schemas.load(
     pydantic_model = Invoice
 )
 
@@ -244,7 +244,7 @@ completion = client.beta.chat.completions.parse(
 print("Extracted data:", completion.choices[0].message.parsed)
 
 # Validate the response against the original schema if you want to remove the reasoning fields
-from uiform._utils.json_schema import filter_auxiliary_fields_json
+from retab._utils.json_schema import filter_auxiliary_fields_json
 assert completion.choices[0].message.content is not None
 extraction = schema_obj.pydantic_model.model_validate(
     filter_auxiliary_fields_json(completion.choices[0].message.content, schema_obj.pydantic_model)
@@ -262,7 +262,7 @@ Below is an example of a simple FastAPI application with a webhook endpoint:
 ```bash
 from fastapi import FastAPI, Request
 from fastapi.responses import JSONResponse
-from uiform.types.automations.webhooks import WebhookRequest
+from retab.types.automations.webhooks import WebhookRequest
 from pydantic import BaseModel, Field, ConfigDict
 
 app = FastAPI()
@@ -293,53 +293,53 @@ curl -X POST "http://localhost:8000/webhook" \
 
 ### Step 4: Create your automation
 
-Finally, integrate the webhook with your automation system using the `uiform` client. 
+Finally, integrate the webhook with your automation system using the `retab` client. 
 
 This example demonstrates how to create an automation that triggers the webhook when a matching event occurs:
 
 ```bash
-from uiform import UiForm
+from retab import Retab
 
-# Initialize the UiForm client
-uiclient = UiForm()
+# Initialize the Retab client
+reclient = Retab()
 
 # Create an automation that uses the webhook URL from Step 2
-automation = uiclient.processors.automations.mailboxes.create(
-    email="invoices@mailbox.uiform.com",
+automation = reclient.processors.automations.mailboxes.create(
+    email="invoices@mailbox.retab.dev",
     model="gpt-4.1-nano",
     json_schema=Invoice.model_json_schema(), # use the pydantic model to create the json schema
     webhook_url="https://your-server.com/webhook",  # Replace with your actual webhook URL
 )
 ```
 
-At any email sent to `invoices@mailbox.uiform.com`, the automation will send a POST request to your FastAPI webhook endpoint, where the payload can be processed.
+At any email sent to `invoices@mailbox.retab.dev`, the automation will send a POST request to your FastAPI webhook endpoint, where the payload can be processed.
 
-You can see the automation you just created on your [dashboard](https://www.uiform.com/dashboard/processors)!
+You can see the automation you just created on your [dashboard](https://www.retab.dev/dashboard/processors)!
 
 ### Step 5: Test your automation
 
 Finally, you can test the automation rapidly with the test functions of the sdk:
 
 ```bash
-from uiform import UiForm
+from retab import Retab
 
-# Initialize the UiForm client
-uiclient = UiForm()
+# Initialize the Retab client
+reclient = Retab()
 
 # If you just want to send a test request to your webhook
-log = uiclient.processors.automations.mailboxes.tests.webhook(
-    email="test-mailbox-local@devmail.uiform.com", 
+log = reclient.processors.automations.mailboxes.tests.webhook(
+    email="test-mailbox-local@devmail.retab.dev", 
 )
 
 # If you want to test the file processing logic: 
-log = uiclient.processors.automations.mailboxes.tests.process(
-    email="test-mailbox-local@devmail.uiform.com", 
+log = reclient.processors.automations.mailboxes.tests.process(
+    email="test-mailbox-local@devmail.retab.dev", 
     document="your_invoice_email.eml"
 )
 
 # If you want to test a full email forwarding
-log = uiclient.processors.automations.mailboxes.tests.forward(
-    email="uiform-quickstart@mailbox.uiform.com", 
+log = reclient.processors.automations.mailboxes.tests.forward(
+    email="retab-quickstart@mailbox.retab.dev", 
     document="your_invoice_email.eml"
 )
 ```
@@ -347,33 +347,33 @@ log = uiclient.processors.automations.mailboxes.tests.forward(
 > 💡 **Tip:** You can also test your webhook locally by overriding the webhook URL set in the automation.
 
 ```bash
-from uiform import UiForm
+from retab import Retab
 
-uiclient = UiForm()
+reclient = Retab()
 
 # If you just want to send a test request to your webhook
-log = uiclient.processors.automations.mailboxes.tests.webhook(
-    email="test-mailbox-local@devmail.uiform.com", 
+log = reclient.processors.automations.mailboxes.tests.webhook(
+    email="test-mailbox-local@devmail.retab.dev", 
     webhook_url="http://localhost:8000/webhook" # If you want to try your webhook locally, you can override the webhook url set in the automation
 )
 ```
 
 And that's it! You can start processing documents at scale! 
-You have 1000 free requests to get started, and you can [subscribe](https://www.uiform.com) to the pro plan to get more.
+You have 1000 free requests to get started, and you can [subscribe](https://www.retab.dev) to the pro plan to get more.
 
 But this minimalistic example is just the beginning. 
 
-Continue reading to learn more about how to use UiForm **to its full potential** 🔥.
+Continue reading to learn more about how to use Retab **to its full potential** 🔥.
 
 ---
 
 ## Go further
 
-- [Prompt Engineering Guide](https://docs.uiform.com/get-started/prompting-with-the-json-schema)
-- [General Concepts](https://docs.uiform.com/get-started/General-Concepts)
-    - [Consensus](https://docs.uiform.com/SDK/General-Concepts#consensus)
-- [Create mailboxes](https://docs.uiform.com/SDK/Automations#mailbox)
-- [Create links](https://docs.uiform.com/SDK/Automations#link)
+- [Prompt Engineering Guide](https://docs.retab.dev/get-started/prompting-with-the-json-schema)
+- [General Concepts](https://docs.retab.dev/get-started/General-Concepts)
+    - [Consensus](https://docs.retab.dev/SDK/General-Concepts#consensus)
+- [Create mailboxes](https://docs.retab.dev/SDK/Automations#mailbox)
+- [Create links](https://docs.retab.dev/SDK/Automations#link)
 - Finetuning (coming soon)
 - Prompt optimization (coming soon)
 - Data-Labelling with our AI-powered annotator (coming soon)
@@ -382,12 +382,12 @@ Continue reading to learn more about how to use UiForm **to its full potential**
 
 ## Jupyter Notebooks
 
-You can view minimal notebooks that demonstrate how to use UiForm to process documents:
+You can view minimal notebooks that demonstrate how to use Retab to process documents:
 
-- [Mailbox creation quickstart](https://github.com/UiForm/uiform/blob/main/notebooks/mailboxes_quickstart.ipynb)
-- [Upload Links creation quickstart](https://github.com/UiForm/uiform/blob/main/notebooks/links_quickstart.ipynb)
-- [Document Extractions quickstart](https://github.com/UiForm/uiform/blob/main/notebooks/Quickstart.ipynb)
-- [Document Extractions quickstart - Async](https://github.com/UiForm/uiform/blob/main/notebooks/Quickstart-Async.ipynb)
+- [Mailbox creation quickstart](https://github.com/Retab-dev/retab/blob/main/notebooks/mailboxes_quickstart.ipynb)
+- [Upload Links creation quickstart](https://github.com/Retab-dev/retab/blob/main/notebooks/links_quickstart.ipynb)
+- [Document Extractions quickstart](https://github.com/Retab-dev/retab/blob/main/notebooks/Quickstart.ipynb)
+- [Document Extractions quickstart - Async](https://github.com/Retab-dev/retab/blob/main/notebooks/Quickstart-Async.ipynb)
 
 --- 
 
@@ -395,12 +395,12 @@ You can view minimal notebooks that demonstrate how to use UiForm to process doc
 
 Let's create the future of document processing together!
 
-Join our [discord community](https://discord.com/invite/vc5tWRPqag) to share tips, discuss best practices, and showcase what you build. Or just [tweet](https://x.com/uiformAPI) at us.
+Join our [discord community](https://discord.com/invite/vc5tWRPqag) to share tips, discuss best practices, and showcase what you build. Or just [tweet](https://x.com/retabdev) at us.
 
-We can't wait to see how you'll use UiForm.
+We can't wait to see how you'll use Retab.
 
 - [Discord](https://discord.com/invite/vc5tWRPqag)
-- [Twitter](https://x.com/uiformAPI)
+- [Twitter](https://x.com/retabdev)
 
 
 ## Roadmap