retab 0.0.82__py3-none-any.whl → 0.0.84__py3-none-any.whl

retab/resources/documents/client.py

@@ -119,14 +119,14 @@ class BaseDocumentsMixin:
 
     def _prepare_edit(
         self,
-        filling_instructions: str,
+        instructions: str,
         document: Path | str | IOBase | MIMEData | PIL.Image.Image | HttpUrl | None = None,
         model: str = FieldUnset,
         template_id: str | None = FieldUnset,
         **extra_body: Any,
     ) -> PreparedRequest:
         request_dict: dict[str, Any] = {
-            "filling_instructions": filling_instructions,
+            "instructions": instructions,
         }
         
         if document is not None:
@@ -598,7 +598,7 @@ class Documents(SyncAPIResource, BaseDocumentsMixin):
 
     def edit(
         self,
-        filling_instructions: str,
+        instructions: str,
         document: Path | str | IOBase | MIMEData | PIL.Image.Image | HttpUrl | None = None,
         model: str = FieldUnset,
         template_id: str | None = FieldUnset,
@@ -616,7 +616,7 @@ class Documents(SyncAPIResource, BaseDocumentsMixin):
         Either `document` OR `template_id` must be provided, but not both.
 
         Args:
-            filling_instructions: Instructions describing how to fill the form fields.
+            instructions: Instructions describing how to fill the form fields.
             document: The document to edit. Can be a file path (Path or str), file-like object, MIMEData, PIL Image, or URL.
                 Mutually exclusive with template_id.
             model: The LLM model to use for inference. Defaults to "retab-small".
@@ -632,7 +632,7 @@ class Documents(SyncAPIResource, BaseDocumentsMixin):
             HTTPException: If the request fails.
         """
         request = self._prepare_edit(
-            filling_instructions=filling_instructions,
+            instructions=instructions,
             document=document,
             model=model,
             template_id=template_id,
@@ -993,7 +993,7 @@ class AsyncDocuments(AsyncAPIResource, BaseDocumentsMixin):
 
     async def edit(
         self,
-        filling_instructions: str,
+        instructions: str,
         document: Path | str | IOBase | MIMEData | PIL.Image.Image | HttpUrl | None = None,
         model: str = FieldUnset,
         template_id: str | None = FieldUnset,
@@ -1011,7 +1011,7 @@ class AsyncDocuments(AsyncAPIResource, BaseDocumentsMixin):
         Either `document` OR `template_id` must be provided, but not both.
 
         Args:
-            filling_instructions: Instructions describing how to fill the form fields.
+            instructions: Instructions describing how to fill the form fields.
             document: The document to edit. Can be a file path (Path or str), file-like object, MIMEData, PIL Image, or URL.
                 Mutually exclusive with template_id.
             model: The LLM model to use for inference. Defaults to "gemini-2.5-pro".
@@ -1027,7 +1027,7 @@ class AsyncDocuments(AsyncAPIResource, BaseDocumentsMixin):
             HTTPException: If the request fails.
         """
         request = self._prepare_edit(
-            filling_instructions=filling_instructions,
+            instructions=instructions,
             document=document,
             model=model,
             template_id=template_id,

retab/resources/edit/client.py

@@ -25,14 +25,14 @@ class BaseEditMixin:
 
     def _prepare_fill_document(
         self,
-        filling_instructions: str,
+        instructions: str,
         document: Path | str | IOBase | MIMEData | PIL.Image.Image | HttpUrl | None = None,
         model: str = FieldUnset,
         template_id: str | None = FieldUnset,
         **extra_body: Any,
     ) -> PreparedRequest:
         request_dict: dict[str, Any] = {
-            "filling_instructions": filling_instructions,
+            "instructions": instructions,
         }
 
         if document is not None:
@@ -65,7 +65,7 @@ class Edit(SyncAPIResource, BaseEditMixin):
 
     def fill_document(
         self,
-        filling_instructions: str,
+        instructions: str,
         document: Path | str | IOBase | MIMEData | PIL.Image.Image | HttpUrl | None = None,
         model: str = FieldUnset,
         template_id: str | None = FieldUnset,
@@ -83,7 +83,7 @@ class Edit(SyncAPIResource, BaseEditMixin):
         Either `document` OR `template_id` must be provided, but not both.
 
         Args:
-            filling_instructions: Instructions describing how to fill the form fields.
+            instructions: Instructions describing how to fill the form fields.
             document: The document to edit. Can be a file path (Path or str), file-like object,
                 MIMEData, PIL Image, or URL. Mutually exclusive with template_id.
             model: The LLM model to use for inference. Defaults to "retab-small".
@@ -106,7 +106,7 @@ class Edit(SyncAPIResource, BaseEditMixin):
             - XLSX/XLS: Native editing for spreadsheets
         """
         request = self._prepare_fill_document(
-            filling_instructions=filling_instructions,
+            instructions=instructions,
             document=document,
             model=model,
             template_id=template_id,
@@ -125,7 +125,7 @@ class AsyncEdit(AsyncAPIResource, BaseEditMixin):
 
     async def fill_document(
         self,
-        filling_instructions: str,
+        instructions: str,
         document: Path | str | IOBase | MIMEData | PIL.Image.Image | HttpUrl | None = None,
         model: str = FieldUnset,
         template_id: str | None = FieldUnset,
@@ -143,7 +143,7 @@ class AsyncEdit(AsyncAPIResource, BaseEditMixin):
         Either `document` OR `template_id` must be provided, but not both.
 
         Args:
-            filling_instructions: Instructions describing how to fill the form fields.
+            instructions: Instructions describing how to fill the form fields.
             document: The document to edit. Can be a file path (Path or str), file-like object,
                 MIMEData, PIL Image, or URL. Mutually exclusive with template_id.
             model: The LLM model to use for inference. Defaults to "retab-small".
@@ -166,7 +166,7 @@ class AsyncEdit(AsyncAPIResource, BaseEditMixin):
             - XLSX/XLS: Native editing for spreadsheets
         """
         request = self._prepare_fill_document(
-            filling_instructions=filling_instructions,
+            instructions=instructions,
             document=document,
             model=model,
             template_id=template_id,

retab/resources/edit/templates/client.py

@@ -161,13 +161,13 @@ class BaseTemplatesMixin:
     def _prepare_fill(
         self,
         template_id: str,
-        filling_instructions: str,
+        instructions: str,
         model: str = FieldUnset,
         **extra_body: Any,
     ) -> PreparedRequest:
         request_dict: dict[str, Any] = {
             "template_id": template_id,
-            "filling_instructions": filling_instructions,
+            "instructions": instructions,
         }
 
         if model is not FieldUnset:
@@ -366,7 +366,7 @@ class Templates(SyncAPIResource, BaseTemplatesMixin):
     def fill(
         self,
         template_id: str,
-        filling_instructions: str,
+        instructions: str,
         model: str = FieldUnset,
         **extra_body: Any,
     ) -> EditResponse:
@@ -378,7 +378,7 @@ class Templates(SyncAPIResource, BaseTemplatesMixin):
 
         Args:
             template_id: The template ID to use for filling
-            filling_instructions: Instructions describing how to fill the form fields
+            instructions: Instructions describing how to fill the form fields
             model: The LLM model to use for inference (default: "retab-small")
 
         Returns:
@@ -393,7 +393,7 @@ class Templates(SyncAPIResource, BaseTemplatesMixin):
         """
         request = self._prepare_fill(
             template_id=template_id,
-            filling_instructions=filling_instructions,
+            instructions=instructions,
             model=model,
             **extra_body,
         )
@@ -584,7 +584,7 @@ class AsyncTemplates(AsyncAPIResource, BaseTemplatesMixin):
     async def fill(
         self,
         template_id: str,
-        filling_instructions: str,
+        instructions: str,
         model: str = FieldUnset,
         **extra_body: Any,
     ) -> EditResponse:
@@ -596,7 +596,7 @@ class AsyncTemplates(AsyncAPIResource, BaseTemplatesMixin):
 
         Args:
             template_id: The template ID to use for filling
-            filling_instructions: Instructions describing how to fill the form fields
+            instructions: Instructions describing how to fill the form fields
             model: The LLM model to use for inference (default: "retab-small")
 
         Returns:
@@ -611,7 +611,7 @@ class AsyncTemplates(AsyncAPIResource, BaseTemplatesMixin):
         """
         request = self._prepare_fill(
             template_id=template_id,
-            filling_instructions=filling_instructions,
+            instructions=instructions,
             model=model,
             **extra_body,
         )

retab/types/documents/edit.py

@@ -109,7 +109,6 @@ class InferFormSchemaRequest(BaseModel):
     
     document: MIMEData = Field(..., description="Input document (PDF or DOCX). DOCX files will be converted to PDF.")
     model: str = Field(default="retab-small", description="LLM model to use for inference")
-    instructions: Optional[str] = Field(default=None, description="Optional instructions to guide form field detection (e.g., which fields to focus on, specific areas to look for)")
 
 
 class EditRequest(BaseModel):
@@ -121,7 +120,7 @@ class EditRequest(BaseModel):
     """
     document: Optional[MIMEData] = Field(default=None, description="Input document (PDF or DOCX). DOCX files will be converted to PDF. Mutually exclusive with template_id.")
     model: str = Field(default="retab-small", description="LLM model to use for inference")
-    filling_instructions: str = Field(..., description="Instructions to fill the form")
+    instructions: str = Field(..., description="Instructions to fill the form")
     template_id: Optional[str] = Field(default=None, description="Template ID to use for filling. When provided, uses the template's pre-defined form fields and empty PDF. Only works for PDF documents. Mutually exclusive with document.")
 
 class EditResponse(BaseModel):

retab/types/edit/templates.py

@@ -46,5 +46,5 @@ class FillTemplateRequest(BaseModel):
     Uses pre-defined form fields from the template (PDF only)
     """
     model: str = Field(default="retab-small", description="LLM model to use for inference")
-    filling_instructions: str = Field(..., description="Instructions to fill the form")
+    instructions: str = Field(..., description="Instructions to fill the form")
     template_id: str = Field(..., description="Template ID to use for filling. When provided, uses the template's pre-defined form fields and empty PDF. Only works for PDF documents. Mutually exclusive with document.")

{retab-0.0.82.dist-info → retab-0.0.84.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: retab
-Version: 0.0.82
+Version: 0.0.84
 Summary: Retab official python library
 Home-page: https://github.com/retab-dev/retab
 Author: Retab

{retab-0.0.82.dist-info → retab-0.0.84.dist-info}/RECORD

@@ -7,11 +7,11 @@ retab/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 retab/resources/models.py,sha256=4WidFBnTGZEA65DSn2pLP2SRnCVXkMTw7o_m8xVCFC4,2469
 retab/resources/schemas.py,sha256=rZ6OzfmoYv-mGaRVzvXjO09dD-KxP74mZhOO8sMgcDQ,4632
 retab/resources/documents/__init__.py,sha256=OjXmngFN0RKqO4SI-mJBNzr6Ex6rMxfq0DxaqzP0RQs,89
-retab/resources/documents/client.py,sha256=E8v0aBF4-9ATYo5hkQ629OP5mm2AtodTzznlj2xRWtQ,49000
+retab/resources/documents/client.py,sha256=0ZOJojT4M9QZ53nheS_vuNZWcnmwTnKx3YqYyJ7_sGY,48912
 retab/resources/edit/__init__.py,sha256=yycIstpTSKsz2qXbrY3Buzd35UDcPWvb5hw6Eb2rLow,69
-retab/resources/edit/client.py,sha256=SQ4imyH_ZEhVUSccQtwOzHbkUDJYzybeFqMd1YlBs9k,6737
+retab/resources/edit/client.py,sha256=osWvuKj2SNH6-nQKsWcTYcm3jVENGlwGTvDnT45nDBY,6649
 retab/resources/edit/templates/__init__.py,sha256=n-zA_HXo7iGgeIclSwcsxmSueXJIRMo0iZjk_sax85I,90
-retab/resources/edit/templates/client.py,sha256=L3g2tyR6GRizZ7z5w37MCx5mWs5m0xIrOEZQuXrf9H4,19817
+retab/resources/edit/templates/client.py,sha256=Eevzy5JaQmG5-hEshugQvrhgIBAjgZ8ZYZkpBSKEdBQ,19729
 retab/resources/extractions/__init__.py,sha256=2H1ezUG8hI5SmTRy6NFzXdYLOdGFFsFrI60uzkitV20,97
 retab/resources/extractions/client.py,sha256=sEoNjOgX91FTOgoJUV-I1A9A9xl1ciCdPlhYwjhEjbA,11035
 retab/resources/projects/__init__.py,sha256=tPR3_3tr7bsoYd618qmGjnYN2R23PmF5oCFd7Z5_HGY,85
@@ -29,12 +29,12 @@ retab/types/documents/__init__.py,sha256=t1jXdpYqi-zQMC_9uM0m7eA1hRU0MCROwUx89cc
 retab/types/documents/classify.py,sha256=Tb6d_7kuTlWLr7bPn782dHrjtUVBCvXV3o9zm7j2lmE,1128
 retab/types/documents/correct_orientation.py,sha256=e-ivsslI6L6Gl0YkcslXw_DH620xMGEYVp4tdeviXeM,261
 retab/types/documents/create_messages.py,sha256=Uym0SnVUGkyt1C5AOD37BsZ3puyeu_igR6X9SboojfA,7267
-retab/types/documents/edit.py,sha256=zk49mzpZAz7u1bOuIQAWDL4XXtdCZv8Y-NdzQm6WmrI,5614
+retab/types/documents/edit.py,sha256=YOsLE4nDf5XLrgkoAxKvU5pivfTSHSjrQSIm2Ezyfn8,5424
 retab/types/documents/extract.py,sha256=x_59fm69-icsxxGRgpFd0NN-SLRoMYqbvfCZuG7zyGc,18033
 retab/types/documents/parse.py,sha256=MXe7zh3DusWQhGe0Sr95nPy6cB8DRX8MA4Hmjj_AP7E,1300
 retab/types/documents/split.py,sha256=xRdJ6IpSRAPi_ZtAG2FNqg5A-v5tzfb1QQkW5UfO2pY,1246
 retab/types/edit/__init__.py,sha256=M8hF97h7fX8RP9IsB6qpkw0eyvO0DFQvP6FmWL8caCQ,331
-retab/types/edit/templates.py,sha256=bXlqBgVQnt3xvah3CrulECY-y1z6mbgwTvtvXUzKEWw,2299
+retab/types/edit/templates.py,sha256=4ndnk-MlJE7roP_YktgxLpRSd68hdwNDWiqAFMy0Ddo,2291
 retab/types/extractions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 retab/types/extractions/types.py,sha256=mnCYSfJoEKsXN2eG-PrahnnQyR6RDjP5VO9sHC1Opmg,102
 retab/types/projects/__init__.py,sha256=I7P_dems5_LOLgYQ-4Bzt9B6P6jRlQwP-D_9GxRDhVk,155
@@ -55,7 +55,7 @@ retab/utils/hashing.py,sha256=_BMVUvftOcJav68QL0rLkH2dbhW9RRJPzeGC2akR0fc,757
 retab/utils/json_schema.py,sha256=zP4pQLpVHBKWo_abCjb_dU4kA0azhHopd-1TFUgVEvc,20655
 retab/utils/mime.py,sha256=mTP_lqSPttOP5DYJxopiWaeFXrUCPjhwd7y53nCVGO4,6189
 retab/utils/stream_context_managers.py,sha256=gI1gVQSj3nWz6Mvjz7Ix5AiY0g6vSL-c2tPfuP04izo,2314
-retab-0.0.82.dist-info/METADATA,sha256=9ZnkwsXcQRlhStUJRNU4J44td5GjZhIVdhL8vpxpHWg,4532
-retab-0.0.82.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-retab-0.0.82.dist-info/top_level.txt,sha256=waQR0EGdhLIQtztoE3AXg7ik5ONQ9q_bsKVpyFuJdq0,6
-retab-0.0.82.dist-info/RECORD,,
+retab-0.0.84.dist-info/METADATA,sha256=8UeP_dWkqP9GOjbR1vpSGZwa9m528VEYNqkxLvbFrfE,4532
+retab-0.0.84.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+retab-0.0.84.dist-info/top_level.txt,sha256=waQR0EGdhLIQtztoE3AXg7ik5ONQ9q_bsKVpyFuJdq0,6
+retab-0.0.84.dist-info/RECORD,,