retab 0.0.70__py3-none-any.whl → 0.0.72__py3-none-any.whl

retab/resources/documents/client.py

@@ -12,6 +12,7 @@ from ..._resource import AsyncAPIResource, SyncAPIResource
 from ...utils.mime import prepare_mime_document
 from ...utils.stream_context_managers import as_async_context_manager, as_context_manager
 from ...types.documents.create_messages import DocumentCreateInputRequest, DocumentCreateMessageRequest, DocumentMessage
+from ...types.chat import ChatCompletionRetabMessage
 from ...types.documents.extract import DocumentExtractRequest, RetabParsedChatCompletion, RetabParsedChatCompletionChunk, RetabParsedChoice, maybe_parse_to_pydantic
 from ...types.documents.parse import ParseRequest, ParseResult, TableParsingFormat
 from ...types.mime import MIMEData
@@ -125,6 +126,7 @@ class BaseDocumentsMixin:
         stream: bool = FieldUnset,
         store: bool = FieldUnset,
         metadata: dict[str, str] = FieldUnset,
+        additional_messages: list[ChatCompletionRetabMessage] = FieldUnset,
         **extra_body: Any,
     ) -> PreparedRequest:
         loaded_schema = load_json_schema(json_schema)
@@ -155,6 +157,8 @@ class BaseDocumentsMixin:
             request_dict["image_resolution_dpi"] = image_resolution_dpi
         if metadata is not FieldUnset:
             request_dict["metadata"] = metadata
+        if additional_messages is not FieldUnset:
+            request_dict["additional_messages"] = additional_messages
 
         # Merge any extra fields provided by the caller
         if extra_body:
@@ -240,6 +244,7 @@ class Documents(SyncAPIResource, BaseDocumentsMixin):
         n_consensus: int = FieldUnset,
         store: bool = FieldUnset,
         metadata: dict[str, str] = FieldUnset,
+        additional_messages: list[ChatCompletionRetabMessage] = FieldUnset,
         **extra_body: Any,
     ) -> RetabParsedChatCompletion:
         """
@@ -257,6 +262,7 @@ class Documents(SyncAPIResource, BaseDocumentsMixin):
             n_consensus: Number of consensus extractions to perform
             store: Whether to store the document in the Retab database
             metadata: User-defined metadata to associate with this extraction
+            additional_messages: Additional chat messages to append after the document content messages
 
         Returns:
             RetabParsedChatCompletion: Parsed response from the API
@@ -275,6 +281,7 @@ class Documents(SyncAPIResource, BaseDocumentsMixin):
             n_consensus=n_consensus,
             store=store,
             metadata=metadata,
+            additional_messages=additional_messages,
             **extra_body,
         )
         response = self._client._prepared_request(request)
@@ -381,6 +388,7 @@ class Documents(SyncAPIResource, BaseDocumentsMixin):
         n_consensus: int = FieldUnset,
         store: bool = FieldUnset,
         metadata: dict[str, str] = FieldUnset,
+        additional_messages: list[ChatCompletionRetabMessage] = FieldUnset,
         **extra_body: Any,
     ) -> Generator[RetabParsedChatCompletion, None, None]:
         """
@@ -396,6 +404,7 @@ class Documents(SyncAPIResource, BaseDocumentsMixin):
             n_consensus: Number of consensus extractions to perform (default: 1 which computes a single extraction and the likelihoods comes from the model logprobs)
             store: Whether to store the document in the Retab database
             metadata: User-defined metadata to associate with this extraction
+            additional_messages: Additional chat messages to append after the document content messages
 
         Returns:
             Generator[RetabParsedChatCompletion]: Stream of parsed responses
@@ -420,6 +429,7 @@ class Documents(SyncAPIResource, BaseDocumentsMixin):
             n_consensus=n_consensus,
             store=store,
             metadata=metadata,
+            additional_messages=additional_messages,
             **extra_body,
         )
         schema = load_json_schema(json_schema)
@@ -572,6 +582,7 @@ class AsyncDocuments(AsyncAPIResource, BaseDocumentsMixin):
         n_consensus: int = FieldUnset,
         store: bool = FieldUnset,
         metadata: dict[str, str] = FieldUnset,
+        additional_messages: list[ChatCompletionRetabMessage] = FieldUnset,
         **extra_body: Any,
     ) -> RetabParsedChatCompletion:
         """
@@ -589,6 +600,7 @@ class AsyncDocuments(AsyncAPIResource, BaseDocumentsMixin):
             n_consensus: Number of consensus extractions to perform
             store: Whether to store the document in the Retab database
             metadata: User-defined metadata to associate with this extraction
+            additional_messages: Additional chat messages to append after the document content messages
 
         Returns:
             RetabParsedChatCompletion: Parsed response from the API
@@ -607,6 +619,7 @@ class AsyncDocuments(AsyncAPIResource, BaseDocumentsMixin):
             n_consensus=n_consensus,
             store=store,
             metadata=metadata,
+            additional_messages=additional_messages,
             **extra_body,
         )
         response = await self._client._prepared_request(request)
@@ -625,6 +638,7 @@ class AsyncDocuments(AsyncAPIResource, BaseDocumentsMixin):
         n_consensus: int = FieldUnset,
         store: bool = FieldUnset,
         metadata: dict[str, str] = FieldUnset,
+        additional_messages: list[ChatCompletionRetabMessage] = FieldUnset,
         **extra_body: Any,
     ) -> AsyncGenerator[RetabParsedChatCompletion, None]:
         """
@@ -640,6 +654,7 @@ class AsyncDocuments(AsyncAPIResource, BaseDocumentsMixin):
             n_consensus: Number of consensus extractions to perform (default: 1 which computes a single extraction and the likelihoods comes from the model logprobs)
             store: Whether to store the document in the Retab database
             metadata: User-defined metadata to associate with this extraction
+            additional_messages: Additional chat messages to append after the document content messages
         Returns:
             AsyncGenerator[RetabParsedChatCompletion, None]: Stream of parsed responses.
         Raises:
@@ -663,6 +678,7 @@ class AsyncDocuments(AsyncAPIResource, BaseDocumentsMixin):
             n_consensus=n_consensus,
             store=store,
             metadata=metadata,
+            additional_messages=additional_messages,
             **extra_body,
         )
         schema = load_json_schema(json_schema)

retab/resources/projects/client.py

@@ -74,9 +74,9 @@ class ProjectsMixin:
     def prepare_delete(self, id: str) -> PreparedRequest:
         return PreparedRequest(method="DELETE", url=f"/v1/projects/{id}")
 
-    def prepare_publish(self, project_id: str, **extra_body: Any) -> PreparedRequest:
-        data = extra_body or None
-        return PreparedRequest(method="POST", url=f"/v1/projects/{project_id}/publish", data=data)
+    def prepare_publish(self, project_id: str, origin: Optional[str] = None) -> PreparedRequest:
+        params = {"origin": origin} if origin else None
+        return PreparedRequest(method="POST", url=f"/v1/projects/{project_id}/publish", params=params)
 
     def prepare_extract(
         self,
@@ -234,9 +234,15 @@ class Projects(SyncAPIResource, ProjectsMixin):
         request = self.prepare_delete(project_id)
         return self._client._prepared_request(request)
 
-    def publish(self, project_id: str, **extra_body: Any) -> Project:
-        """Publish a project's draft configuration."""
-        request = self.prepare_publish(project_id, **extra_body)
+    def publish(self, project_id: str, origin: Optional[str] = None) -> Project:
+        """Publish a project's draft configuration.
+        
+        Args:
+            project_id: The ID of the project to publish
+            origin: Optional origin identifier (e.g., iteration ID). If an iteration ID 
+                    is provided, the project will be published using that iteration's config.
+        """
+        request = self.prepare_publish(project_id, origin=origin)
         response = self._client._prepared_request(request)
         return Project(**response)
 
@@ -353,9 +359,15 @@ class AsyncProjects(AsyncAPIResource, ProjectsMixin):
         request = self.prepare_delete(project_id)
         return await self._client._prepared_request(request)
 
-    async def publish(self, project_id: str, **extra_body: Any) -> Project:
-        """Publish a project's draft configuration."""
-        request = self.prepare_publish(project_id, **extra_body)
+    async def publish(self, project_id: str, origin: Optional[str] = None) -> Project:
+        """Publish a project's draft configuration.
+        
+        Args:
+            project_id: The ID of the project to publish
+            origin: Optional origin identifier (e.g., iteration ID). If an iteration ID 
+                    is provided, the project will be published using that iteration's config.
+        """
+        request = self.prepare_publish(project_id, origin=origin)
         response = await self._client._prepared_request(request)
         return Project(**response)
 

retab/types/documents/extract.py

@@ -39,6 +39,7 @@ class DocumentExtractRequest(BaseModel):
     parallel_ocr_keys: Optional[dict[str, str]] = Field(default=None, description="If set, keys to be used for the extraction of long lists of data using Parallel OCR", examples=[{"properties": "ID", "products": "identity.id"}])
     metadata: dict[str, str] = Field(default_factory=dict, description="User-defined metadata to associate with this extraction")
     extraction_id: Optional[str] = Field(default=None, description="Extraction ID to use for this extraction. If not provided, a new ID will be generated.")
+    additional_messages: Optional[list[ChatCompletionRetabMessage]] = Field(default=None, description="Additional chat messages to append after the document content messages. Useful for providing extra context or instructions.")
 
     # Add a model validator that rejects n_consensus > 1 if temperature is 0
     @field_validator("n_consensus")

{retab-0.0.70.dist-info → retab-0.0.72.dist-info}/METADATA

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

{retab-0.0.70.dist-info → retab-0.0.72.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=H-ylTrFcaC36iVj5XSWbwJB489n3GEWwbqsPgQQ50G4,31980
+retab/resources/documents/client.py,sha256=8WT0-PwfrCgUaA6Pj2_VTDQ66zRTDexDxj9koMG0Ygo,33161
 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
-retab/resources/projects/client.py,sha256=nvqsDiVyeRrXsoYddwyXNmpZxaBLYWAGO2e0n6qkCzY,14988
+retab/resources/projects/client.py,sha256=5LPAhJt5-nqBP4VWYvo0k7cW6HLGF6K9xMiHKQzIXho,15593
 retab/types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 retab/types/chat.py,sha256=x9VbtPMa4w6Gc0HrFC3ILl6cCnfEn5ytDnwJtZmlcys,1436
 retab/types/inference_settings.py,sha256=e4NDZHFdtrqi30Za1z0JhRU5PBO94yKxUGoK7S2kA3M,1053
@@ -22,7 +22,7 @@ retab/types/standards.py,sha256=7aGtuvzzkKidvqY8JB2Cjfn43V80FeKwrTtp162kjKc,1477
 retab/types/documents/__init__.py,sha256=RaD6PnvRJw7QEVTh_PYNX6gckpLcxUJH7FKaopRKJzY,114
 retab/types/documents/correct_orientation.py,sha256=e-ivsslI6L6Gl0YkcslXw_DH620xMGEYVp4tdeviXeM,261
 retab/types/documents/create_messages.py,sha256=Cox0QgIyLhTXIvw1Nzd2BCnB9-5KAYgw_gads5eTaDw,7272
-retab/types/documents/extract.py,sha256=Z-Qsj5-lmWb9dkgyTTt3Z7Lpd4_7SZdRGErtV_aw8oE,16492
+retab/types/documents/extract.py,sha256=tc6SJSbHcZlDdKv67AdV2w5v-veXqze9ztFOorPkLVU,16721
 retab/types/documents/parse.py,sha256=Jd6i-1UXhAtgntRBZItEHGHeevyLdLmbTQa1-HNrico,1305
 retab/types/extractions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 retab/types/extractions/types.py,sha256=mnCYSfJoEKsXN2eG-PrahnnQyR6RDjP5VO9sHC1Opmg,102
@@ -44,7 +44,7 @@ retab/utils/mime.py,sha256=mTP_lqSPttOP5DYJxopiWaeFXrUCPjhwd7y53nCVGO4,6189
 retab/utils/stream_context_managers.py,sha256=gI1gVQSj3nWz6Mvjz7Ix5AiY0g6vSL-c2tPfuP04izo,2314
 retab/utils/usage/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 retab/utils/usage/json_schema.py,sha256=kRbL5E5OStlhlNlBXlxHNwaVHKd6MVhyqIb0y4aj8JA,84322
-retab-0.0.70.dist-info/METADATA,sha256=fmovHmnRSdICMGaxGo7aOrYiOXbqyMmXBxUiG7gtdEQ,4532
-retab-0.0.70.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-retab-0.0.70.dist-info/top_level.txt,sha256=waQR0EGdhLIQtztoE3AXg7ik5ONQ9q_bsKVpyFuJdq0,6
-retab-0.0.70.dist-info/RECORD,,
+retab-0.0.72.dist-info/METADATA,sha256=qHuMpSS3GS_6RZDt0jjrP9WX7OLr1BXA8EbkvorXaWM,4532
+retab-0.0.72.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+retab-0.0.72.dist-info/top_level.txt,sha256=waQR0EGdhLIQtztoE3AXg7ik5ONQ9q_bsKVpyFuJdq0,6
+retab-0.0.72.dist-info/RECORD,,