retab 0.0.37__tar.gz → 0.0.39__tar.gz

{retab-0.0.37 → retab-0.0.39}/PKG-INFO

@@ -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