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

retab/resources/consensus/completions.py

@@ -6,9 +6,9 @@ from pydantic import BaseModel as ResponseFormatT
 
 from ..._resource import AsyncAPIResource, SyncAPIResource
 from ..._utils.ai_models import assert_valid_model_extraction
-from ...types.chat import ChatCompletionUiformMessage
-from ...types.completions import UiChatCompletionsRequest
-from ...types.documents.extractions import UiParsedChatCompletion
+from ...types.chat import ChatCompletionRetabMessage
+from ...types.completions import RetabChatCompletionsRequest
+from ...types.documents.extractions import RetabParsedChatCompletion
 from ...types.schemas.object import Schema
 from ...types.standards import PreparedRequest
 
@@ -17,7 +17,7 @@ class BaseCompletionsMixin:
     def prepare_parse(
         self,
         response_format: type[ResponseFormatT],
-        messages: list[ChatCompletionUiformMessage],
+        messages: list[ChatCompletionRetabMessage],
         model: str,
         temperature: float,
         reasoning_effort: ChatCompletionReasoningEffort,
@@ -31,7 +31,7 @@ class BaseCompletionsMixin:
 
         schema_obj = Schema(json_schema=json_schema)
 
-        request = UiChatCompletionsRequest(
+        request = RetabChatCompletionsRequest(
             model=model,
             messages=messages,
             response_format={
@@ -52,7 +52,7 @@ class BaseCompletionsMixin:
     def prepare_create(
         self,
         response_format: ResponseFormatJSONSchema,
-        messages: list[ChatCompletionUiformMessage],
+        messages: list[ChatCompletionRetabMessage],
         model: str,
         temperature: float,
         reasoning_effort: ChatCompletionReasoningEffort,
@@ -66,7 +66,7 @@ class BaseCompletionsMixin:
 
         schema_obj = Schema(json_schema=json_schema)
 
-        request = UiChatCompletionsRequest(
+        request = RetabChatCompletionsRequest(
             model=model,
             messages=messages,
             response_format={
@@ -91,16 +91,16 @@ class Completions(SyncAPIResource, BaseCompletionsMixin):
     def create(
         self,
         response_format: ResponseFormatJSONSchema,
-        messages: list[ChatCompletionUiformMessage],
+        messages: list[ChatCompletionRetabMessage],
         model: str = "gpt-4o-2024-08-06",
         temperature: float = 0,
         reasoning_effort: ChatCompletionReasoningEffort = "medium",
         n_consensus: int = 1,
         idempotency_key: str | None = None,
         stream: bool = False,
-    ) -> UiParsedChatCompletion:
+    ) -> RetabParsedChatCompletion:
         """
-        Create a completion using the UiForm API.
+        Create a completion using the Retab API.
         """
 
         request = self.prepare_create(
@@ -116,20 +116,20 @@ class Completions(SyncAPIResource, BaseCompletionsMixin):
 
         response = self._client._prepared_request(request)
 
-        return UiParsedChatCompletion.model_validate(response)
+        return RetabParsedChatCompletion.model_validate(response)
 
     def parse(
         self,
         response_format: type[ResponseFormatT],
-        messages: list[ChatCompletionUiformMessage],
+        messages: list[ChatCompletionRetabMessage],
         model: str = "gpt-4o-2024-08-06",
         temperature: float = 0,
         reasoning_effort: ChatCompletionReasoningEffort = "medium",
         n_consensus: int = 1,
         idempotency_key: str | None = None,
-    ) -> UiParsedChatCompletion:
+    ) -> RetabParsedChatCompletion:
         """
-        Parse messages using the UiForm API to extract structured data according to the provided JSON schema.
+        Parse messages using the Retab API to extract structured data according to the provided JSON schema.
 
         Args:
             response_format: JSON schema defining the expected data structure
@@ -138,10 +138,10 @@ class Completions(SyncAPIResource, BaseCompletionsMixin):
             temperature: Model temperature setting (0-1)
             reasoning_effort: The effort level for the model to reason about the input data
             idempotency_key: Idempotency key for request
-            store: Whether to store the data in the UiForm database
+            store: Whether to store the data in the Retab database
 
         Returns:
-            UiParsedChatCompletion: Parsed response from the API
+            RetabParsedChatCompletion: Parsed response from the API
         """
         request = self.prepare_parse(
             response_format=response_format,
@@ -155,7 +155,7 @@ class Completions(SyncAPIResource, BaseCompletionsMixin):
         )
         response = self._client._prepared_request(request)
 
-        return UiParsedChatCompletion.model_validate(response)
+        return RetabParsedChatCompletion.model_validate(response)
 
 
 class AsyncCompletions(AsyncAPIResource, BaseCompletionsMixin):
@@ -164,16 +164,16 @@ class AsyncCompletions(AsyncAPIResource, BaseCompletionsMixin):
     async def create(
         self,
         response_format: ResponseFormatJSONSchema,
-        messages: list[ChatCompletionUiformMessage],
+        messages: list[ChatCompletionRetabMessage],
         model: str = "gpt-4o-2024-08-06",
         temperature: float = 0,
         reasoning_effort: ChatCompletionReasoningEffort = "medium",
         n_consensus: int = 1,
         idempotency_key: str | None = None,
         stream: bool = False,
-    ) -> UiParsedChatCompletion:
+    ) -> RetabParsedChatCompletion:
         """
-        Create a completion using the UiForm API.
+        Create a completion using the Retab API.
         """
 
         request = self.prepare_create(
@@ -188,20 +188,20 @@ class AsyncCompletions(AsyncAPIResource, BaseCompletionsMixin):
         )
 
         response = await self._client._prepared_request(request)
-        return UiParsedChatCompletion.model_validate(response)
+        return RetabParsedChatCompletion.model_validate(response)
 
     async def parse(
         self,
         response_format: type[ResponseFormatT],
-        messages: list[ChatCompletionUiformMessage],
+        messages: list[ChatCompletionRetabMessage],
         model: str = "gpt-4o-2024-08-06",
         temperature: float = 0,
         reasoning_effort: ChatCompletionReasoningEffort = "medium",
         n_consensus: int = 1,
         idempotency_key: str | None = None,
-    ) -> UiParsedChatCompletion:
+    ) -> RetabParsedChatCompletion:
         """
-        Parse messages using the UiForm API asynchronously.
+        Parse messages using the Retab API asynchronously.
 
         Args:
             json_schema: JSON schema defining the expected data structure
@@ -213,7 +213,7 @@ class AsyncCompletions(AsyncAPIResource, BaseCompletionsMixin):
             idempotency_key: Idempotency key for request
 
         Returns:
-            UiParsedChatCompletion: Parsed response from the API
+            RetabParsedChatCompletion: Parsed response from the API
         """
         request = self.prepare_parse(
             response_format=response_format,
@@ -226,4 +226,4 @@ class AsyncCompletions(AsyncAPIResource, BaseCompletionsMixin):
             idempotency_key=idempotency_key,
         )
         response = await self._client._prepared_request(request)
-        return UiParsedChatCompletion.model_validate(response)
+        return RetabParsedChatCompletion.model_validate(response)

retab/resources/consensus/completions_stream.py

@@ -12,9 +12,9 @@ from ..._resource import AsyncAPIResource, SyncAPIResource
 from ..._utils.ai_models import assert_valid_model_extraction
 from ..._utils.json_schema import unflatten_dict
 from ..._utils.stream_context_managers import as_async_context_manager, as_context_manager
-from ...types.chat import ChatCompletionUiformMessage
-from ...types.completions import UiChatCompletionsRequest
-from ...types.documents.extractions import UiParsedChatCompletion, UiParsedChatCompletionChunk, UiParsedChoice
+from ...types.chat import ChatCompletionRetabMessage
+from ...types.completions import RetabChatCompletionsRequest
+from ...types.documents.extractions import RetabParsedChatCompletion, RetabParsedChatCompletionChunk, RetabParsedChoice
 from ...types.schemas.object import Schema
 from ...types.standards import PreparedRequest
 
@@ -23,7 +23,7 @@ class BaseCompletionsMixin:
     def prepare_parse(
         self,
         response_format: type[ResponseFormatT],
-        messages: list[ChatCompletionUiformMessage],
+        messages: list[ChatCompletionRetabMessage],
         model: str,
         temperature: float,
         reasoning_effort: ChatCompletionReasoningEffort,
@@ -36,7 +36,7 @@ class BaseCompletionsMixin:
         json_schema = response_format.model_json_schema()
         schema_obj = Schema(json_schema=json_schema)
 
-        request = UiChatCompletionsRequest(
+        request = RetabChatCompletionsRequest(
             messages=messages,
             response_format={
                 "type": "json_schema",
@@ -58,7 +58,7 @@ class BaseCompletionsMixin:
     def prepare_create(
         self,
         response_format: ResponseFormatJSONSchema,
-        messages: list[ChatCompletionUiformMessage],
+        messages: list[ChatCompletionRetabMessage],
         model: str,
         temperature: float,
         reasoning_effort: ChatCompletionReasoningEffort,
@@ -73,7 +73,7 @@ class BaseCompletionsMixin:
         schema_obj = Schema(json_schema=json_schema)
 
         # Validate DocumentAPIRequest data (raises exception if invalid)
-        request = UiChatCompletionsRequest(
+        request = RetabChatCompletionsRequest(
             model=model,
             messages=messages,
             response_format={
@@ -100,15 +100,15 @@ class Completions(SyncAPIResource, BaseCompletionsMixin):
     def stream(
         self,
         response_format: type[ResponseFormatT],
-        messages: list[ChatCompletionUiformMessage],
+        messages: list[ChatCompletionRetabMessage],
         model: str = "gpt-4o-2024-08-06",
         temperature: float = 0,
         reasoning_effort: ChatCompletionReasoningEffort = "medium",
         n_consensus: int = 1,
         idempotency_key: str | None = None,
-    ) -> Generator[UiParsedChatCompletion, None, None]:
+    ) -> Generator[RetabParsedChatCompletion, None, None]:
         """
-        Process messages using the UiForm API with streaming enabled.
+        Process messages using the Retab API with streaming enabled.
 
         Args:
             response_format: JSON schema defining the expected data structure
@@ -119,11 +119,11 @@ class Completions(SyncAPIResource, BaseCompletionsMixin):
             idempotency_key: Idempotency key for request
 
         Returns:
-            Generator[UiParsedChatCompletion]: Stream of parsed responses
+            Generator[RetabParsedChatCompletion]: Stream of parsed responses
 
         Usage:
         ```python
-        with uiform.completions.stream(json_schema, messages, model, temperature, reasoning_effort) as stream:
+        with retab.devpletions.stream(json_schema, messages, model, temperature, reasoning_effort) as stream:
             for response in stream:
                 print(response)
         ```
@@ -140,16 +140,16 @@ class Completions(SyncAPIResource, BaseCompletionsMixin):
         )
 
         # 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,
@@ -160,7 +160,7 @@ class Completions(SyncAPIResource, BaseCompletionsMixin):
         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
@@ -186,15 +186,15 @@ class AsyncCompletions(AsyncAPIResource, BaseCompletionsMixin):
     async def stream(
         self,
         response_format: type[ResponseFormatT],
-        messages: list[ChatCompletionUiformMessage],
+        messages: list[ChatCompletionRetabMessage],
         model: str = "gpt-4o-2024-08-06",
         temperature: float = 0,
         reasoning_effort: ChatCompletionReasoningEffort = "medium",
         n_consensus: int = 1,
         idempotency_key: str | None = None,
-    ) -> AsyncGenerator[UiParsedChatCompletion, None]:
+    ) -> AsyncGenerator[RetabParsedChatCompletion, None]:
         """
-        Parse messages using the UiForm API asynchronously with streaming.
+        Parse messages using the Retab API asynchronously with streaming.
 
         Args:
             json_schema: JSON schema defining the expected data structure
@@ -206,11 +206,11 @@ class AsyncCompletions(AsyncAPIResource, BaseCompletionsMixin):
             idempotency_key: Idempotency key for request
 
         Returns:
-            AsyncGenerator[UiParsedChatCompletion]: Stream of parsed responses
+            AsyncGenerator[RetabParsedChatCompletion]: Stream of parsed responses
 
         Usage:
         ```python
-        async with uiform.completions.stream(json_schema, messages, model, temperature, reasoning_effort, n_consensus) as stream:
+        async with retab.devpletions.stream(json_schema, messages, model, temperature, reasoning_effort, n_consensus) as stream:
             async for response in stream:
                 print(response)
         ```
@@ -227,16 +227,16 @@ class AsyncCompletions(AsyncAPIResource, BaseCompletionsMixin):
         )
 
         # 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,
@@ -247,7 +247,7 @@ class AsyncCompletions(AsyncAPIResource, BaseCompletionsMixin):
         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

retab/resources/consensus/responses.py

@@ -8,7 +8,7 @@ from pydantic import BaseModel
 
 from ..._resource import AsyncAPIResource, SyncAPIResource
 from ..._utils.ai_models import assert_valid_model_extraction
-from ...types.completions import UiChatResponseCreateRequest
+from ...types.completions import RetabChatResponseCreateRequest
 from ...types.documents.extractions import UiResponse
 from ...types.schemas.object import Schema
 from ...types.standards import PreparedRequest
@@ -43,8 +43,8 @@ class BaseResponsesMixin:
         if instructions is None:
             instructions = schema_obj.developer_system_prompt
 
-        # Create the request object based on the UiChatResponseCreateRequest model
-        request = UiChatResponseCreateRequest(
+        # Create the request object based on the RetabChatResponseCreateRequest model
+        request = RetabChatResponseCreateRequest(
             model=model,
             input=input,
             temperature=temperature,
@@ -79,8 +79,8 @@ class BaseResponsesMixin:
         if instructions is None:
             instructions = schema_obj.developer_system_prompt
 
-        # Create the request object based on the UiChatResponseCreateRequest model
-        request = UiChatResponseCreateRequest(
+        # Create the request object based on the RetabChatResponseCreateRequest model
+        request = RetabChatResponseCreateRequest(
             model=model,
             input=input,
             temperature=temperature,
@@ -100,7 +100,7 @@ class BaseResponsesMixin:
 
 
 class Responses(SyncAPIResource, BaseResponsesMixin):
-    """UiForm Responses API compatible with OpenAI Responses API"""
+    """Retab Responses API compatible with OpenAI Responses API"""
 
     def create(
         self,
@@ -114,7 +114,7 @@ class Responses(SyncAPIResource, BaseResponsesMixin):
         idempotency_key: Optional[str] = None,
     ) -> Response:
         """
-        Create a completion using the UiForm API with OpenAI Responses API compatible interface.
+        Create a completion using the Retab API with OpenAI Responses API compatible interface.
 
         Args:
             model: The model to use
@@ -156,7 +156,7 @@ class Responses(SyncAPIResource, BaseResponsesMixin):
         idempotency_key: Optional[str] = None,
     ) -> Response:
         """
-        Parse content using the UiForm API with OpenAI Responses API compatible interface.
+        Parse content using the Retab API with OpenAI Responses API compatible interface.
 
         Args:
             model: The model to use
@@ -189,7 +189,7 @@ class Responses(SyncAPIResource, BaseResponsesMixin):
 
 
 class AsyncResponses(AsyncAPIResource, BaseResponsesMixin):
-    """UiForm Responses API compatible with OpenAI Responses API for async usage"""
+    """Retab Responses API compatible with OpenAI Responses API for async usage"""
 
     async def create(
         self,
@@ -203,7 +203,7 @@ class AsyncResponses(AsyncAPIResource, BaseResponsesMixin):
         idempotency_key: Optional[str] = None,
     ) -> UiResponse:
         """
-        Create a completion using the UiForm API asynchronously with OpenAI Responses API compatible interface.
+        Create a completion using the Retab API asynchronously with OpenAI Responses API compatible interface.
 
         Args:
             model: The model to use
@@ -245,7 +245,7 @@ class AsyncResponses(AsyncAPIResource, BaseResponsesMixin):
         idempotency_key: Optional[str] = None,
     ) -> UiResponse:
         """
-        Parse content using the UiForm API asynchronously with OpenAI Responses API compatible interface.
+        Parse content using the Retab API asynchronously with OpenAI Responses API compatible interface.
 
         Args:
             model: The model to use

retab/resources/consensus/responses_stream.py

@@ -8,7 +8,7 @@ from pydantic import BaseModel
 from ..._resource import AsyncAPIResource, SyncAPIResource
 from ..._utils.ai_models import assert_valid_model_extraction
 from ..._utils.stream_context_managers import as_async_context_manager, as_context_manager
-from ...types.completions import UiChatResponseCreateRequest
+from ...types.completions import RetabChatResponseCreateRequest
 from ...types.documents.extractions import UiResponse
 from ...types.schemas.object import Schema
 from ...types.standards import PreparedRequest
@@ -44,8 +44,8 @@ class BaseResponsesMixin:
         if instructions is None:
             instructions = schema_obj.developer_system_prompt
 
-        # Create the request object based on the UiChatResponseCreateRequest model
-        request = UiChatResponseCreateRequest(
+        # Create the request object based on the RetabChatResponseCreateRequest model
+        request = RetabChatResponseCreateRequest(
             model=model,
             input=input,
             temperature=temperature,
@@ -81,8 +81,8 @@ class BaseResponsesMixin:
         if instructions is None:
             instructions = schema_obj.developer_system_prompt
 
-        # Create the request object based on the UiChatResponseCreateRequest model
-        request = UiChatResponseCreateRequest(
+        # Create the request object based on the RetabChatResponseCreateRequest model
+        request = RetabChatResponseCreateRequest(
             model=model,
             input=input,
             temperature=temperature,
@@ -102,7 +102,7 @@ class BaseResponsesMixin:
 
 
 class Responses(SyncAPIResource, BaseResponsesMixin):
-    """UiForm Responses API compatible with OpenAI Responses API"""
+    """Retab Responses API compatible with OpenAI Responses API"""
 
     @as_context_manager
     def stream(
@@ -117,7 +117,7 @@ class Responses(SyncAPIResource, BaseResponsesMixin):
         idempotency_key: Optional[str] = None,
     ) -> Generator[UiResponse, None, None]:
         """
-        Create a completion using the UiForm API with streaming enabled.
+        Create a completion using the Retab API with streaming enabled.
 
         Args:
             model: The model to use
@@ -134,7 +134,7 @@ class Responses(SyncAPIResource, BaseResponsesMixin):
 
         Usage:
         ```python
-        with uiform.responses.stream(model, input, text, temperature, reasoning) as stream:
+        with retab.responses.stream(model, input, text, temperature, reasoning) as stream:
             for response in stream:
                 print(response)
         ```
@@ -171,7 +171,7 @@ class Responses(SyncAPIResource, BaseResponsesMixin):
         idempotency_key: Optional[str] = None,
     ) -> Generator[UiResponse, None, None]:
         """
-        Parse content using the UiForm API with streaming enabled.
+        Parse content using the Retab API with streaming enabled.
 
         Args:
             model: The model to use
@@ -188,7 +188,7 @@ class Responses(SyncAPIResource, BaseResponsesMixin):
 
         Usage:
         ```python
-        with uiform.responses.stream_parse(model, input, MyModel, temperature, reasoning) as stream:
+        with retab.responses.stream_parse(model, input, MyModel, temperature, reasoning) as stream:
             for response in stream:
                 print(response)
         ```
@@ -214,7 +214,7 @@ class Responses(SyncAPIResource, BaseResponsesMixin):
 
 
 class AsyncResponses(AsyncAPIResource, BaseResponsesMixin):
-    """UiForm Responses API compatible with OpenAI Responses API for async usage"""
+    """Retab Responses API compatible with OpenAI Responses API for async usage"""
 
     @as_async_context_manager
     async def stream(
@@ -229,7 +229,7 @@ class AsyncResponses(AsyncAPIResource, BaseResponsesMixin):
         idempotency_key: Optional[str] = None,
     ) -> AsyncGenerator[UiResponse, None]:
         """
-        Create a completion using the UiForm API asynchronously with streaming enabled.
+        Create a completion using the Retab API asynchronously with streaming enabled.
 
         Args:
             model: The model to use
@@ -246,7 +246,7 @@ class AsyncResponses(AsyncAPIResource, BaseResponsesMixin):
 
         Usage:
         ```python
-        async with uiform.responses.async_stream(model, input, text, temperature, reasoning) as stream:
+        async with retab.responses.async_stream(model, input, text, temperature, reasoning) as stream:
             async for response in stream:
                 print(response)
         ```
@@ -283,7 +283,7 @@ class AsyncResponses(AsyncAPIResource, BaseResponsesMixin):
         idempotency_key: Optional[str] = None,
     ) -> AsyncGenerator[UiResponse, None]:
         """
-        Parse content using the UiForm API asynchronously with streaming enabled.
+        Parse content using the Retab API asynchronously with streaming enabled.
 
         Args:
             model: The model to use
@@ -300,7 +300,7 @@ class AsyncResponses(AsyncAPIResource, BaseResponsesMixin):
 
         Usage:
         ```python
-        async with uiform.responses.async_stream_parse(model, input, MyModel, temperature, reasoning) as stream:
+        async with retab.responses.async_stream_parse(model, input, MyModel, temperature, reasoning) as stream:
             async for response in stream:
                 print(response)
         ```