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

retab/resources/documents/extractions.py

@@ -18,15 +18,15 @@ from ..._utils.ai_models import assert_valid_model_extraction
 from ..._utils.json_schema import filter_auxiliary_fields_json, load_json_schema, unflatten_dict
 from ..._utils.mime import MIMEData, prepare_mime_document
 from ..._utils.stream_context_managers import as_async_context_manager, as_context_manager
-from ...types.chat import ChatCompletionUiformMessage
-from ...types.documents.extractions import DocumentExtractRequest, LogExtractionRequest, UiParsedChatCompletion, UiParsedChatCompletionChunk, UiParsedChoice
+from ...types.chat import ChatCompletionRetabMessage
+from ...types.documents.extractions import DocumentExtractRequest, LogExtractionRequest, RetabParsedChatCompletion, RetabParsedChatCompletionChunk, RetabParsedChoice
 from ...types.browser_canvas import BrowserCanvas
 from ...types.modalities import Modality
 from ...types.schemas.object import Schema
 from ...types.standards import PreparedRequest
 
 
-def maybe_parse_to_pydantic(schema: Schema, response: UiParsedChatCompletion, allow_partial: bool = False) -> UiParsedChatCompletion:
+def maybe_parse_to_pydantic(schema: Schema, response: RetabParsedChatCompletion, allow_partial: bool = False) -> RetabParsedChatCompletion:
     if response.choices[0].message.content:
         try:
             if allow_partial:
@@ -97,8 +97,8 @@ class BaseExtractionsMixin:
         model: str,
         temperature: float,
         completion: Any | None = None,
-        # The messages can be provided in different formats, we will convert them to the UiForm-compatible format
-        messages: list[ChatCompletionUiformMessage] | None = None,
+        # The messages can be provided in different formats, we will convert them to the Retab-compatible format
+        messages: list[ChatCompletionRetabMessage] | None = None,
         openai_messages: list[ChatCompletionMessageParam] | None = None,
         anthropic_messages: list[MessageParam] | None = None,
         anthropic_system_prompt: str | None = None,
@@ -152,9 +152,9 @@ class Extractions(SyncAPIResource, BaseExtractionsMixin):
         n_consensus: int = PydanticUndefined,  # type: ignore[assignment]
         idempotency_key: str | None = None,
         store: bool = False,
-    ) -> UiParsedChatCompletion:
+    ) -> RetabParsedChatCompletion:
         """
-        Process one or more documents using the UiForm API.
+        Process one or more documents using the Retab API.
 
         Args:
             json_schema: JSON schema defining the expected data structure
@@ -168,9 +168,9 @@ class Extractions(SyncAPIResource, BaseExtractionsMixin):
             reasoning_effort: The effort level for the model to reason about the input data.
             n_consensus: Number of consensus extractions to perform (default: 1 which computes a single extraction and the likelihoods comes from the model logprobs)
             idempotency_key: Idempotency key for request
-            store: Whether to store the document in the UiForm database
+            store: Whether to store the document in the Retab database
         Returns:
-            UiParsedChatCompletion: Parsed response from the API
+            RetabParsedChatCompletion: Parsed response from the API
         Raises:
             ValueError: If neither document nor documents is provided, or if both are provided
             HTTPException: If the request fails
@@ -195,7 +195,7 @@ class Extractions(SyncAPIResource, BaseExtractionsMixin):
         response = self._client._prepared_request(request)
 
         schema = Schema(json_schema=load_json_schema(json_schema))
-        return maybe_parse_to_pydantic(schema, UiParsedChatCompletion.model_validate(response))
+        return maybe_parse_to_pydantic(schema, RetabParsedChatCompletion.model_validate(response))
 
     @as_context_manager
     def stream(
@@ -212,9 +212,9 @@ class Extractions(SyncAPIResource, BaseExtractionsMixin):
         n_consensus: int = PydanticUndefined,  # type: ignore[assignment]
         idempotency_key: str | None = None,
         store: bool = False,
-    ) -> Generator[UiParsedChatCompletion, None, None]:
+    ) -> Generator[RetabParsedChatCompletion, None, None]:
         """
-        Process one or more documents using the UiForm API with streaming enabled.
+        Process one or more documents using the Retab API with streaming enabled.
 
         Args:
             json_schema: JSON schema defining the expected data structure
@@ -228,22 +228,22 @@ class Extractions(SyncAPIResource, BaseExtractionsMixin):
             reasoning_effort: The effort level for the model to reason about the input data.
             n_consensus: Number of consensus extractions to perform (default: 1 which computes a single extraction and the likelihoods comes from the model logprobs)
             idempotency_key: Idempotency key for request
-            store: Whether to store the document in the UiForm database
+            store: Whether to store the document in the Retab database
 
         Returns:
-            Generator[UiParsedChatCompletion]: Stream of parsed responses
+            Generator[RetabParsedChatCompletion]: Stream of parsed responses
         Raises:
             ValueError: If neither document nor documents is provided, or if both are provided
             HTTPException: If the request fails
         Usage:
         ```python
         # Single document
-        with uiform.documents.extractions.stream(json_schema, model, document=document) as stream:
+        with retab.documents.extractions.stream(json_schema, model, document=document) as stream:
             for response in stream:
                 print(response)
 
         # Multiple documents
-        with uiform.documents.extractions.stream(json_schema, model, documents=[doc1, doc2]) as stream:
+        with retab.documents.extractions.stream(json_schema, model, documents=[doc1, doc2]) as stream:
             for response in stream:
                 print(response)
         ```
@@ -266,16 +266,16 @@ class Extractions(SyncAPIResource, BaseExtractionsMixin):
         schema = Schema(json_schema=load_json_schema(json_schema))
 
         # Request the stream and return a context manager
-        ui_parsed_chat_completion_cum_chunk: UiParsedChatCompletionChunk | None = None
-        # Initialize the UiParsedChatCompletion object
-        ui_parsed_completion: UiParsedChatCompletion = UiParsedChatCompletion(
+        ui_parsed_chat_completion_cum_chunk: RetabParsedChatCompletionChunk | None = None
+        # Initialize the RetabParsedChatCompletion object
+        ui_parsed_completion: RetabParsedChatCompletion = RetabParsedChatCompletion(
             id="",
             created=0,
             model="",
             object="chat.completion",
             likelihoods={},
             choices=[
-                UiParsedChoice(
+                RetabParsedChoice(
                     index=0,
                     message=ParsedChatCompletionMessage(content="", role="assistant"),
                     finish_reason=None,
@@ -286,7 +286,7 @@ class Extractions(SyncAPIResource, BaseExtractionsMixin):
         for chunk_json in self._client._prepared_request_stream(request):
             if not chunk_json:
                 continue
-            ui_parsed_chat_completion_cum_chunk = UiParsedChatCompletionChunk.model_validate(chunk_json).chunk_accumulator(ui_parsed_chat_completion_cum_chunk)
+            ui_parsed_chat_completion_cum_chunk = RetabParsedChatCompletionChunk.model_validate(chunk_json).chunk_accumulator(ui_parsed_chat_completion_cum_chunk)
             # Basic stuff
             ui_parsed_completion.id = ui_parsed_chat_completion_cum_chunk.id
             ui_parsed_completion.created = ui_parsed_chat_completion_cum_chunk.created
@@ -311,8 +311,8 @@ class Extractions(SyncAPIResource, BaseExtractionsMixin):
         model: str,
         temperature: float,
         completion: Any | None = None,
-        # The messages can be provided in different formats, we will convert them to the UiForm-compatible format
-        messages: list[ChatCompletionUiformMessage] | None = None,
+        # The messages can be provided in different formats, we will convert them to the Retab-compatible format
+        messages: list[ChatCompletionRetabMessage] | None = None,
         openai_messages: list[ChatCompletionMessageParam] | None = None,
         anthropic_messages: list[MessageParam] | None = None,
         anthropic_system_prompt: str | None = None,
@@ -353,7 +353,7 @@ class AsyncExtractions(AsyncAPIResource, BaseExtractionsMixin):
         n_consensus: int = PydanticUndefined,  # type: ignore[assignment]
         idempotency_key: str | None = None,
         store: bool = False,
-    ) -> UiParsedChatCompletion:
+    ) -> RetabParsedChatCompletion:
         """
         Extract structured data from one or more documents asynchronously.
 
@@ -369,9 +369,9 @@ class AsyncExtractions(AsyncAPIResource, BaseExtractionsMixin):
             reasoning_effort: The effort level for the model to reason about the input data.
             n_consensus: Number of consensus extractions to perform (default: 1 which computes a single extraction and the likelihoods comes from the model logprobs)
             idempotency_key: Idempotency key for request
-            store: Whether to store the document in the UiForm database
+            store: Whether to store the document in the Retab database
         Returns:
-            UiParsedChatCompletion: Parsed response from the API.
+            RetabParsedChatCompletion: Parsed response from the API.
         Raises:
             ValueError: If neither document nor documents is provided, or if both are provided
         """
@@ -392,7 +392,7 @@ class AsyncExtractions(AsyncAPIResource, BaseExtractionsMixin):
         )
         response = await self._client._prepared_request(request)
         schema = Schema(json_schema=load_json_schema(json_schema))
-        return maybe_parse_to_pydantic(schema, UiParsedChatCompletion.model_validate(response))
+        return maybe_parse_to_pydantic(schema, RetabParsedChatCompletion.model_validate(response))
 
     @as_async_context_manager
     async def stream(
@@ -409,7 +409,7 @@ class AsyncExtractions(AsyncAPIResource, BaseExtractionsMixin):
         n_consensus: int = PydanticUndefined,  # type: ignore[assignment]
         idempotency_key: str | None = None,
         store: bool = False,
-    ) -> AsyncGenerator[UiParsedChatCompletion, None]:
+    ) -> AsyncGenerator[RetabParsedChatCompletion, None]:
         """
         Extract structured data from one or more documents asynchronously with streaming.
 
@@ -425,21 +425,21 @@ class AsyncExtractions(AsyncAPIResource, BaseExtractionsMixin):
             reasoning_effort: The effort level for the model to reason about the input data.
             n_consensus: Number of consensus extractions to perform (default: 1 which computes a single extraction and the likelihoods comes from the model logprobs)
             idempotency_key: Idempotency key for request
-            store: Whether to store the document in the UiForm database
+            store: Whether to store the document in the Retab database
         Returns:
-            AsyncGenerator[UiParsedChatCompletion, None]: Stream of parsed responses.
+            AsyncGenerator[RetabParsedChatCompletion, None]: Stream of parsed responses.
         Raises:
             ValueError: If neither document nor documents is provided, or if both are provided
 
         Usage:
         ```python
         # Single document
-        async with uiform.documents.extractions.stream(json_schema, model, document=document) as stream:
+        async with retab.documents.extractions.stream(json_schema, model, document=document) as stream:
             async for response in stream:
                 print(response)
 
         # Multiple documents
-        async with uiform.documents.extractions.stream(json_schema, model, documents=[doc1, doc2]) as stream:
+        async with retab.documents.extractions.stream(json_schema, model, documents=[doc1, doc2]) as stream:
             async for response in stream:
                 print(response)
         ```
@@ -460,16 +460,16 @@ class AsyncExtractions(AsyncAPIResource, BaseExtractionsMixin):
             idempotency_key=idempotency_key,
         )
         schema = Schema(json_schema=load_json_schema(json_schema))
-        ui_parsed_chat_completion_cum_chunk: UiParsedChatCompletionChunk | None = None
-        # Initialize the UiParsedChatCompletion object
-        ui_parsed_completion: UiParsedChatCompletion = UiParsedChatCompletion(
+        ui_parsed_chat_completion_cum_chunk: RetabParsedChatCompletionChunk | None = None
+        # Initialize the RetabParsedChatCompletion object
+        ui_parsed_completion: RetabParsedChatCompletion = RetabParsedChatCompletion(
             id="",
             created=0,
             model="",
             object="chat.completion",
             likelihoods={},
             choices=[
-                UiParsedChoice(
+                RetabParsedChoice(
                     index=0,
                     message=ParsedChatCompletionMessage(content="", role="assistant"),
                     finish_reason=None,
@@ -481,7 +481,7 @@ class AsyncExtractions(AsyncAPIResource, BaseExtractionsMixin):
         async for chunk_json in self._client._prepared_request_stream(request):
             if not chunk_json:
                 continue
-            ui_parsed_chat_completion_cum_chunk = UiParsedChatCompletionChunk.model_validate(chunk_json).chunk_accumulator(ui_parsed_chat_completion_cum_chunk)
+            ui_parsed_chat_completion_cum_chunk = RetabParsedChatCompletionChunk.model_validate(chunk_json).chunk_accumulator(ui_parsed_chat_completion_cum_chunk)
             # Basic stuff
             ui_parsed_completion.id = ui_parsed_chat_completion_cum_chunk.id
             ui_parsed_completion.created = ui_parsed_chat_completion_cum_chunk.created
@@ -507,8 +507,8 @@ class AsyncExtractions(AsyncAPIResource, BaseExtractionsMixin):
         model: str,
         temperature: float,
         completion: Any | None = None,
-        # The messages can be provided in different formats, we will convert them to the UiForm-compatible format
-        messages: list[ChatCompletionUiformMessage] | None = None,
+        # The messages can be provided in different formats, we will convert them to the Retab-compatible format
+        messages: list[ChatCompletionRetabMessage] | None = None,
         openai_messages: list[ChatCompletionMessageParam] | None = None,
         anthropic_messages: list[MessageParam] | None = None,
         anthropic_system_prompt: str | None = None,

retab/resources/evaluations/documents.py

@@ -10,7 +10,7 @@ from ..._utils.mime import prepare_mime_document
 from ...types.evaluations import DocumentItem, EvaluationDocument, PatchEvaluationDocumentRequest
 from ...types.mime import MIMEData
 from ...types.standards import PreparedRequest, DeleteResponse, FieldUnset
-from ...types.documents.extractions import UiParsedChatCompletion
+from ...types.documents.extractions import RetabParsedChatCompletion
 
 
 class DocumentsMixin:
@@ -134,13 +134,13 @@ class Documents(SyncAPIResource, DocumentsMixin):
         request = self.prepare_delete(evaluation_id, document_id)
         return self._client._prepared_request(request)
 
-    def llm_annotate(self, evaluation_id: str, document_id: str) -> UiParsedChatCompletion:
+    def llm_annotate(self, evaluation_id: str, document_id: str) -> RetabParsedChatCompletion:
         """
         Annotate a document with an LLM. This method updates the document (within the evaluation) with the latest extraction.
         """
         request = self.prepare_llm_annotate(evaluation_id, document_id)
         response = self._client._prepared_request(request)
-        return UiParsedChatCompletion(**response)
+        return RetabParsedChatCompletion(**response)
 
 
 class AsyncDocuments(AsyncAPIResource, DocumentsMixin):
@@ -223,11 +223,11 @@ class AsyncDocuments(AsyncAPIResource, DocumentsMixin):
         request = self.prepare_delete(evaluation_id, document_id)
         return await self._client._prepared_request(request)
 
-    async def llm_annotate(self, evaluation_id: str, document_id: str) -> UiParsedChatCompletion:
+    async def llm_annotate(self, evaluation_id: str, document_id: str) -> RetabParsedChatCompletion:
         """
         Annotate a document with an LLM.
         This method updates the document (within the evaluation) with the latest extraction.
         """
         request = self.prepare_llm_annotate(evaluation_id, document_id)
         response = await self._client._prepared_request(request)
-        return UiParsedChatCompletion(**response)
+        return RetabParsedChatCompletion(**response)

retab/resources/evaluations/iterations.py

@@ -9,7 +9,7 @@ from ...types.inference_settings import InferenceSettings
 from ...types.metrics import DistancesResult
 from ...types.modalities import Modality
 from ...types.standards import DeleteResponse, PreparedRequest, FieldUnset
-from ...types.documents.extractions import UiParsedChatCompletion
+from ...types.documents.extractions import RetabParsedChatCompletion
 
 
 class IterationsMixin:
@@ -238,7 +238,7 @@ class Iterations(SyncAPIResource, IterationsMixin):
         response = self._client._prepared_request(request)
         return Iteration(**response)
 
-    def process_document(self, evaluation_id: str, iteration_id: str, document_id: str) -> UiParsedChatCompletion:
+    def process_document(self, evaluation_id: str, iteration_id: str, document_id: str) -> RetabParsedChatCompletion:
         """
         Process a single document within an iteration.
         This method updates the iteration document with the latest extraction.
@@ -248,13 +248,13 @@ class Iterations(SyncAPIResource, IterationsMixin):
             document_id: The ID of the document
 
         Returns:
-            UiParsedChatCompletion: The parsed chat completion
+            RetabParsedChatCompletion: The parsed chat completion
         Raises:
             HTTPException if the request fails
         """
         request = self.prepare_process_document(evaluation_id, iteration_id, document_id)
         response = self._client._prepared_request(request)
-        return UiParsedChatCompletion(**response)
+        return RetabParsedChatCompletion(**response)
 
     def status(self, evaluation_id: str, iteration_id: str) -> IterationDocumentStatusResponse:
         """
@@ -417,7 +417,7 @@ class AsyncIterations(AsyncAPIResource, IterationsMixin):
         response = await self._client._prepared_request(request)
         return Iteration(**response)
 
-    async def process_document(self, evaluation_id: str, iteration_id: str, document_id: str) -> UiParsedChatCompletion:
+    async def process_document(self, evaluation_id: str, iteration_id: str, document_id: str) -> RetabParsedChatCompletion:
         """
         Process a single document within an iteration.
         This method updates the iteration document with the latest extraction.
@@ -427,13 +427,13 @@ class AsyncIterations(AsyncAPIResource, IterationsMixin):
             document_id: The ID of the document
 
         Returns:
-            UiParsedChatCompletion: The parsed chat completion
+            RetabParsedChatCompletion: The parsed chat completion
         Raises:
             HTTPException if the request fails
         """
         request = self.prepare_process_document(evaluation_id, iteration_id, document_id)
         response = await self._client._prepared_request(request)
-        return UiParsedChatCompletion(**response)
+        return RetabParsedChatCompletion(**response)
 
     async def status(self, evaluation_id: str, iteration_id: str) -> IterationDocumentStatusResponse:
         """

retab/resources/jsonlUtils.py

@@ -18,18 +18,18 @@ from pydantic_core import PydanticUndefined
 from tqdm import tqdm
 
 from .._resource import AsyncAPIResource, SyncAPIResource
-from .._utils.ai_models import assert_valid_model_extraction, find_provider_from_model
+from .._utils.ai_models import assert_valid_model_extraction, get_provider_for_model
 from .._utils.chat import convert_to_anthropic_format, convert_to_openai_format, separate_messages
 from .._utils.display import Metrics, display_metrics, process_dataset_and_compute_metrics
 from .._utils.json_schema import load_json_schema
-from ..types.chat import ChatCompletionUiformMessage
+from ..types.chat import ChatCompletionRetabMessage
 from ..types.modalities import Modality
 from ..types.schemas.object import Schema
 from ..types.browser_canvas import BrowserCanvas
 
 
 class FinetuningJSON(BaseModel):
-    messages: list[ChatCompletionUiformMessage]
+    messages: list[ChatCompletionRetabMessage]
 
 
 FinetuningJSONL = list[FinetuningJSON]
@@ -242,7 +242,7 @@ class Datasets(SyncAPIResource, BaseDatasetsMixin):
         training_set = []
 
         for pair_paths in tqdm(pairs_paths):
-            document_messages: list[ChatCompletionUiformMessage] = []
+            document_messages: list[ChatCompletionRetabMessage] = []
 
             if isinstance(pair_paths["document_fpath"], str) or isinstance(pair_paths["document_fpath"], Path):
                 document_message = self._client.documents.create_messages(document=pair_paths["document_fpath"], modality=modality)
@@ -278,7 +278,7 @@ class Datasets(SyncAPIResource, BaseDatasetsMixin):
         Returns:
             A tuple of (client instance, provider type string)
         """
-        provider = find_provider_from_model(model)
+        provider = get_provider_for_model(model)
 
         if provider == "OpenAI":
             return OpenAI(api_key=self._client.headers["OpenAI-Api-Key"]), provider
@@ -299,7 +299,7 @@ class Datasets(SyncAPIResource, BaseDatasetsMixin):
         provider: str,
         model: str,
         temperature: float,
-        messages: list[ChatCompletionUiformMessage],
+        messages: list[ChatCompletionRetabMessage],
         schema_obj: Schema,
     ) -> str:
         """Get completion from the appropriate model provider.
@@ -659,7 +659,7 @@ class Datasets(SyncAPIResource, BaseDatasetsMixin):
             system_message, user_messages, assistant_messages = separate_messages(messages)
             system_and_user_messages = messages[:-1]
 
-            previous_annotation_message: ChatCompletionUiformMessage = {
+            previous_annotation_message: ChatCompletionRetabMessage = {
                 "role": "user",
                 "content": "Here is an old annotation using a different schema. Use it as a reference to update the annotation: " + messages[-1]["content"],
             }

retab/resources/processors/automations/endpoints.py

@@ -120,7 +120,7 @@ class Endpoints(SyncAPIResource, EndpointsMixin):
             need_validation=need_validation,
         )
         response = self._client._prepared_request(request)
-        print(f"Endpoint ID: {response['id']}. Endpoint available at https://www.uiform.com/dashboard/processors/{response['id']}")
+        print(f"Endpoint ID: {response['id']}. Endpoint available at https://www.retab.dev/dashboard/processors/{response['id']}")
         return Endpoint.model_validate(response)
 
     def list(
@@ -229,7 +229,7 @@ class AsyncEndpoints(AsyncAPIResource, EndpointsMixin):
             need_validation=need_validation,
         )
         response = await self._client._prepared_request(request)
-        print(f"Endpoint ID: {response['id']}. Endpoint available at https://www.uiform.com/dashboard/processors/{response['id']}")
+        print(f"Endpoint ID: {response['id']}. Endpoint available at https://www.retab.dev/dashboard/processors/{response['id']}")
 
         return Endpoint.model_validate(response)
 

retab/resources/processors/automations/links.py

@@ -128,7 +128,7 @@ class Links(SyncAPIResource, LinksMixin):
         )
         response = self._client._prepared_request(request)
 
-        print(f"Extraction Link Created. Link available at https://www.uiform.com/dashboard/processors/{response['id']}")
+        print(f"Extraction Link Created. Link available at https://www.retab.dev/dashboard/processors/{response['id']}")
         return Link.model_validate(response)
 
     def list(
@@ -248,7 +248,7 @@ class AsyncLinks(AsyncAPIResource, LinksMixin):
             password=password,
         )
         response = await self._client._prepared_request(request)
-        print(f"Extraction Link Created. Link available at https://www.uiform.com/dashboard/processors/{response['id']}")
+        print(f"Extraction Link Created. Link available at https://www.retab.dev/dashboard/processors/{response['id']}")
         return Link.model_validate(response)
 
     async def list(

retab/resources/processors/automations/logs.py

@@ -147,7 +147,7 @@ class Logs(SyncAPIResource, LogsMixin):
         request = self.prepare_rerun(processor_id, log_id)
         response = self._client._prepared_request(request)
 
-        print(f"Webhook call run successfully. Log available at https://www.uiform.com/dashboard/processors/{processor_id}/logs/{log_id}")
+        print(f"Webhook call run successfully. Log available at https://www.retab.dev/dashboard/processors/{processor_id}/logs/{log_id}")
 
         return ExternalRequestLog.model_validate(response)
 
@@ -217,6 +217,6 @@ class AsyncLogs(AsyncAPIResource, LogsMixin):
         request = self.prepare_rerun(processor_id, log_id)
         response = await self._client._prepared_request(request)
 
-        print(f"Webhook call run successfully. Log available at https://www.uiform.com/dashboard/processors/{processor_id}/logs/{log_id}")
+        print(f"Webhook call run successfully. Log available at https://www.retab.dev/dashboard/processors/{processor_id}/logs/{log_id}")
 
         return ExternalRequestLog.model_validate(response)

retab/resources/processors/automations/mailboxes.py

@@ -144,7 +144,7 @@ class Mailboxes(SyncAPIResource, MailBoxesMixin):
         )
         response = self._client._prepared_request(request)
 
-        print(f"Email automation created. Mailbox available at https://www.uiform.com/dashboard/processors/{response['id']}")
+        print(f"Email automation created. Mailbox available at https://www.retab.dev/dashboard/processors/{response['id']}")
 
         return Mailbox.model_validate(response)
 
@@ -278,7 +278,7 @@ class AsyncMailboxes(AsyncAPIResource, MailBoxesMixin):
         )
         response = await self._client._prepared_request(request)
 
-        print(f"Email automation created. Mailbox available at https://www.uiform.com/dashboard/processors/{response['id']}")
+        print(f"Email automation created. Mailbox available at https://www.retab.dev/dashboard/processors/{response['id']}")
 
         return Mailbox.model_validate(response)
 

retab/resources/processors/automations/outlook.py

@@ -149,7 +149,7 @@ class Outlooks(SyncAPIResource, OutlooksMixin):
         )
         response = self._client._prepared_request(request)
 
-        print(f"Outlook automation created. Outlook available at https://www.uiform.com/dashboard/processors/{response['id']}")
+        print(f"Outlook automation created. Outlook available at https://www.retab.dev/dashboard/processors/{response['id']}")
 
         return Outlook.model_validate(response)
 
@@ -280,7 +280,7 @@ class AsyncOutlooks(AsyncAPIResource, OutlooksMixin):
             fetch_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']}")
+        print(f"Outlook automation created. Outlook available at https://www.retab.dev/dashboard/processors/{response['id']}")
         return Outlook.model_validate(response)
 
     async def list(

retab/resources/processors/client.py

@@ -12,7 +12,7 @@ from ..._resource import AsyncAPIResource, SyncAPIResource
 from ..._utils.ai_models import assert_valid_model_extraction
 from ..._utils.mime import MIMEData, prepare_mime_document
 from ...types.browser_canvas import BrowserCanvas
-from ...types.documents.extractions import UiParsedChatCompletion
+from ...types.documents.extractions import RetabParsedChatCompletion
 from ...types.logs import ProcessorConfig, UpdateProcessorRequest
 from ...types.modalities import Modality
 from ...types.pagination import ListMetadata
@@ -239,7 +239,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.uiform.com/dashboard/processors/{response['id']}")
+        print(f"Processor ID: {response['id']}. Processor available at https://www.retab.dev/dashboard/processors/{response['id']}")
         return ProcessorConfig.model_validate(response)
 
     def list(
@@ -349,7 +349,7 @@ class Processors(SyncAPIResource, ProcessorsMixin):
         temperature: float | None = None,
         seed: int | None = None,
         store: bool = True,
-    ) -> UiParsedChatCompletion:
+    ) -> RetabParsedChatCompletion:
         """Submit documents to a processor for processing.
 
         Args:
@@ -361,11 +361,11 @@ class Processors(SyncAPIResource, ProcessorsMixin):
             store: Whether to store the results
 
         Returns:
-            UiParsedChatCompletion: The processing result
+            RetabParsedChatCompletion: The processing result
         """
         request = self.prepare_submit(processor_id=processor_id, document=document, documents=documents, temperature=temperature, seed=seed, store=store)
         response = self._client._prepared_request(request)
-        return UiParsedChatCompletion.model_validate(response)
+        return RetabParsedChatCompletion.model_validate(response)
 
 
 class AsyncProcessors(AsyncAPIResource, ProcessorsMixin):
@@ -399,7 +399,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.uiform.com/dashboard/processors/{response['id']}")
+        print(f"Processor ID: {response['id']}. Processor available at https://www.retab.dev/dashboard/processors/{response['id']}")
 
         return ProcessorConfig.model_validate(response)
 
@@ -470,7 +470,7 @@ class AsyncProcessors(AsyncAPIResource, ProcessorsMixin):
         temperature: float | None = None,
         seed: int | None = None,
         store: bool = True,
-    ) -> UiParsedChatCompletion:
+    ) -> RetabParsedChatCompletion:
         """Submit documents to a processor for processing.
 
         Args:
@@ -482,8 +482,8 @@ class AsyncProcessors(AsyncAPIResource, ProcessorsMixin):
             store: Whether to store the results
 
         Returns:
-            UiParsedChatCompletion: The processing result
+            RetabParsedChatCompletion: The processing result
         """
         request = self.prepare_submit(processor_id=processor_id, document=document, documents=documents, temperature=temperature, seed=seed, store=store)
         response = await self._client._prepared_request(request)
-        return UiParsedChatCompletion.model_validate(response)
+        return RetabParsedChatCompletion.model_validate(response)

retab/resources/usage.py

@@ -89,7 +89,7 @@ class Usage(SyncAPIResource, UsageMixin):
             dict: Monthly usage data including credits consumed and limits
 
         Raises:
-            UiformAPIError: If the API request fails
+            RetabAPIError: If the API request fails
         """
         request = self.prepare_monthly_credits_usage()
         response = self._client._request(request.method, request.url, request.data, request.params)
@@ -176,7 +176,7 @@ class Usage(SyncAPIResource, UsageMixin):
             ],
             response_format=CalendarEvent,
         )
-        uiclient.usage.log(
+        reclient.usage.log(
             response_format=CalendarEvent,
             completion=completion
         )
@@ -203,7 +203,7 @@ class AsyncUsage(AsyncAPIResource, UsageMixin):
             dict: Monthly usage data including credits consumed and limits
 
         Raises:
-            UiformAPIError: If the API request fails
+            RetabAPIError: If the API request fails
         """
         request = self.prepare_monthly_credits_usage()
         response = await self._client._request(request.method, request.url, request.data, request.params)
@@ -290,7 +290,7 @@ class AsyncUsage(AsyncAPIResource, UsageMixin):
             ],
             response_format=CalendarEvent,
         )
-        uiclient.usage.log(
+        reclient.usage.log(
             response_format=CalendarEvent,
             completion=completion
         )