retab 0.0.82__tar.gz → 0.0.84__tar.gz

{retab-0.0.82 → retab-0.0.84}/PKG-INFO

@@ -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 → retab-0.0.84}/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-0.0.82 → retab-0.0.84}/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-0.0.82 → retab-0.0.84}/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-0.0.82 → retab-0.0.84}/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-0.0.82 → retab-0.0.84}/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 → retab-0.0.84}/retab.egg-info/PKG-INFO

@@ -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 → retab-0.0.84}/setup.py

@@ -6,7 +6,7 @@ with open("requirements.txt") as f:
 
 setup(
     name="retab",
-    version="0.0.82",
+    version="0.0.84",
     author="Retab",
     author_email="contact@retab.com",
     description="Retab official python library",