retab 0.0.44__tar.gz → 0.0.46__tar.gz

{retab-0.0.44 → retab-0.0.46}/PKG-INFO

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

{retab-0.0.44 → retab-0.0.46}/retab/generate_types.py

@@ -49,7 +49,7 @@ def type_to_zod(field_type: Any, put_names: bool = True, ts: bool = False) -> st
             excluded_fields = set()
             typename = "z.object({\n"
             ts_typename = "{\n"
-            props = [(n, f.annotation, f.default) for n, f in origin.model_fields.items()] if issubclass(origin, BaseModel) else \
+            props = [(n, f.annotation, f.default) for n, f in origin.model_fields.items() if not f.exclude] if issubclass(origin, BaseModel) else \
                     [(n, f, PydanticUndefined) for n, f in origin.__annotations__.items()]
 
             for field_name, field, default in props:

{retab-0.0.44 → retab-0.0.46}/retab/resources/deployments/client.py

@@ -12,7 +12,7 @@ from ...types.standards import PreparedRequest
 
 
 class DeploymentsMixin:
-    def prepare_submit(
+    def prepare_extract(
         self,
         project_id: str,
         iteration_id: str,
@@ -22,7 +22,7 @@ class DeploymentsMixin:
         seed: int | None = None,
         store: bool = True,
     ) -> PreparedRequest:
-        """Prepare a request to submit documents to a processor.
+        """Prepare a request to extract documents from a deployment.
 
         Args:
             project_id: ID of the project
@@ -73,7 +73,7 @@ class DeploymentsMixin:
                 )
             files = files_list
 
-        url = f"/v1/deployments/{project_id}/{iteration_id}/submit"
+        url = f"/v1/deployments/extract/{project_id}/{iteration_id}"
 
         return PreparedRequest(method="POST", url=url, form_data=form_data, files=files)
 
@@ -84,7 +84,7 @@ class Deployments(SyncAPIResource, DeploymentsMixin):
     def __init__(self, client: Any) -> None:
         super().__init__(client=client)
 
-    def submit(
+    def extract(
         self,
         project_id: str,
         iteration_id: str,
@@ -94,7 +94,7 @@ class Deployments(SyncAPIResource, DeploymentsMixin):
         seed: int | None = None,
         store: bool = True,
     ) -> RetabParsedChatCompletion:
-        """Submit documents to a deployment for processing.
+        """Extract documents from a deployment.
 
         Args:
             project_id: ID of the project
@@ -108,7 +108,7 @@ class Deployments(SyncAPIResource, DeploymentsMixin):
         Returns:
             RetabParsedChatCompletion: The processing result
         """
-        request = self.prepare_submit(project_id=project_id, iteration_id=iteration_id, document=document, documents=documents, temperature=temperature, seed=seed, store=store)
+        request = self.prepare_extract(project_id=project_id, iteration_id=iteration_id, document=document, documents=documents, temperature=temperature, seed=seed, store=store)
         response = self._client._prepared_request(request)
         return RetabParsedChatCompletion.model_validate(response)
 
@@ -119,7 +119,7 @@ class AsyncDeployments(AsyncAPIResource, DeploymentsMixin):
     def __init__(self, client: Any) -> None:
         super().__init__(client=client)
 
-    async def submit(
+    async def extract(
         self,
         project_id: str,
         iteration_id: str,
@@ -129,7 +129,7 @@ class AsyncDeployments(AsyncAPIResource, DeploymentsMixin):
         seed: int | None = None,
         store: bool = True,
     ) -> RetabParsedChatCompletion:
-        """Submit documents to a deployment for processing.
+        """Extract documents from a deployment.
 
         Args:
             project_id: ID of the project
@@ -143,6 +143,6 @@ class AsyncDeployments(AsyncAPIResource, DeploymentsMixin):
         Returns:
             RetabParsedChatCompletion: The processing result
         """
-        request = self.prepare_submit(project_id=project_id, iteration_id=iteration_id, document=document, documents=documents, temperature=temperature, seed=seed, store=store)
+        request = self.prepare_extract(project_id=project_id, iteration_id=iteration_id, document=document, documents=documents, temperature=temperature, seed=seed, store=store)
         response = await self._client._prepared_request(request)
         return RetabParsedChatCompletion.model_validate(response)

{retab-0.0.44 → retab-0.0.46}/retab/resources/projects/client.py

@@ -26,12 +26,12 @@ class ProjectsMixin:
         eval_data = BaseProject(**eval_dict)
         return PreparedRequest(method="POST", url="/v1/projects", data=eval_data.model_dump(exclude_unset=True, mode="json"))
 
-    def prepare_get(self, evaluation_id: str) -> PreparedRequest:
-        return PreparedRequest(method="GET", url=f"/v1/projects/{evaluation_id}")
+    def prepare_get(self, project_id: str) -> PreparedRequest:
+        return PreparedRequest(method="GET", url=f"/v1/projects/{project_id}")
 
     def prepare_update(
         self,
-        evaluation_id: str,
+        project_id: str,
         name: str = FieldUnset,
         json_schema: dict[str, Any] = FieldUnset,
         default_inference_settings: InferenceSettings = FieldUnset,
@@ -52,7 +52,7 @@ class ProjectsMixin:
 
         data = PatchProjectRequest(**update_dict).model_dump(exclude_unset=True, mode="json")
 
-        return PreparedRequest(method="PATCH", url=f"/v1/projects/{evaluation_id}", data=data)
+        return PreparedRequest(method="PATCH", url=f"/v1/projects/{project_id}", data=data)
 
     def prepare_list(self) -> PreparedRequest:
         """
@@ -105,25 +105,25 @@ class Projects(SyncAPIResource, ProjectsMixin):
         response = self._client._prepared_request(request)
         return Project(**response)
 
-    def get(self, evaluation_id: str) -> Project:
+    def get(self, project_id: str) -> Project:
         """
         Get an evaluation by ID.
 
         Args:
-            evaluation_id: The ID of the evaluation to retrieve
+            project_id: The ID of the evaluation to retrieve
 
         Returns:
             Project: The evaluation
         Raises:
             HTTPException if the request fails
         """
-        request = self.prepare_get(evaluation_id)
+        request = self.prepare_get(project_id)
         response = self._client._prepared_request(request)
         return Project(**response)
 
     def update(
         self,
-        evaluation_id: str,
+        project_id: str,
         name: str = FieldUnset,
         json_schema: dict[str, Any] = FieldUnset,
         default_inference_settings: InferenceSettings = FieldUnset,
@@ -132,7 +132,7 @@ class Projects(SyncAPIResource, ProjectsMixin):
         Update an evaluation with partial updates.
 
         Args:
-            evaluation_id: The ID of the evaluation to update
+            project_id: The ID of the evaluation to update
             name: Optional new name for the evaluation
             json_schema: Optional new JSON schema
             documents: Optional list of documents to update
@@ -145,7 +145,7 @@ class Projects(SyncAPIResource, ProjectsMixin):
             HTTPException if the request fails
         """
         request = self.prepare_update(
-            evaluation_id=evaluation_id,
+            project_id=project_id,
             name=name,
             json_schema=json_schema,
             default_inference_settings=default_inference_settings,
@@ -167,19 +167,19 @@ class Projects(SyncAPIResource, ProjectsMixin):
         response = self._client._prepared_request(request)
         return [Project(**item) for item in response.get("data", [])]
 
-    def delete(self, evaluation_id: str) -> DeleteResponse:
+    def delete(self, project_id: str) -> DeleteResponse:
         """
         Delete an evaluation.
 
         Args:
-            evaluation_id: The ID of the evaluation to delete
+            project_id: The ID of the evaluation to delete
 
         Returns:
             DeleteResponse: The response containing success status and ID
         Raises:
             HTTPException if the request fails
         """
-        request = self.prepare_delete(evaluation_id)
+        request = self.prepare_delete(project_id)
         return self._client._prepared_request(request)
 
 
@@ -208,25 +208,25 @@ class AsyncProjects(AsyncAPIResource, ProjectsMixin):
         response = await self._client._prepared_request(request)
         return Project(**response)
 
-    async def get(self, evaluation_id: str) -> Project:
+    async def get(self, project_id: str) -> Project:
         """
         Get an evaluation by ID.
 
         Args:
-            evaluation_id: The ID of the evaluation to retrieve
+            project_id: The ID of the evaluation to retrieve
 
         Returns:
             Project: The evaluation
         Raises:
             HTTPException if the request fails
         """
-        request = self.prepare_get(evaluation_id)
+        request = self.prepare_get(project_id)
         response = await self._client._prepared_request(request)
         return Project(**response)
 
     async def update(
         self,
-        evaluation_id: str,
+        project_id: str,
         name: str = FieldUnset,
         json_schema: dict[str, Any] = FieldUnset,
         default_inference_settings: InferenceSettings = FieldUnset,
@@ -248,7 +248,7 @@ class AsyncProjects(AsyncAPIResource, ProjectsMixin):
             HTTPException if the request fails
         """
         request = self.prepare_update(
-            evaluation_id=evaluation_id,
+            project_id=project_id,
             name=name,
             json_schema=json_schema,
             default_inference_settings=default_inference_settings,
@@ -269,17 +269,17 @@ class AsyncProjects(AsyncAPIResource, ProjectsMixin):
         response = await self._client._prepared_request(request)
         return [Project(**item) for item in response.get("data", [])]
 
-    async def delete(self, evaluation_id: str) -> DeleteResponse:
+    async def delete(self, project_id: str) -> DeleteResponse:
         """
         Delete an evaluation.
 
         Args:
-            evaluation_id: The ID of the evaluation to delete
+            project_id: The ID of the evaluation to delete
 
         Returns:
             DeleteResponse: The response containing success status and ID
         Raises:
             HTTPException if the request fails
         """
-        request = self.prepare_delete(evaluation_id)
+        request = self.prepare_delete(project_id)
         return await self._client._prepared_request(request)

{retab-0.0.44 → retab-0.0.46}/retab/resources/projects/documents.py

@@ -15,26 +15,26 @@ from ...types.documents.extractions import RetabParsedChatCompletion
 
 
 class DocumentsMixin:
-    def prepare_get(self, evaluation_id: str, document_id: str) -> PreparedRequest:
-        return PreparedRequest(method="GET", url=f"/v1/projects/{evaluation_id}/documents/{document_id}")
+    def prepare_get(self, project_id: str, document_id: str) -> PreparedRequest:
+        return PreparedRequest(method="GET", url=f"/v1/projects/{project_id}/documents/{document_id}")
 
-    def prepare_create(self, evaluation_id: str, document: MIMEData, annotation: dict[str, Any], annotation_metadata: dict[str, Any] | None = None) -> PreparedRequest:
+    def prepare_create(self, project_id: str, document: MIMEData, annotation: dict[str, Any], annotation_metadata: dict[str, Any] | None = None) -> PreparedRequest:
         # Serialize the MIMEData
         document_item = DocumentItem(mime_data=document, annotation=annotation, annotation_metadata=PredictionMetadata(**annotation_metadata) if annotation_metadata else None)
-        return PreparedRequest(method="POST", url=f"/v1/projects/{evaluation_id}/documents", data=document_item.model_dump(mode="json"))
+        return PreparedRequest(method="POST", url=f"/v1/projects/{project_id}/documents", data=document_item.model_dump(mode="json"))
 
-    def prepare_list(self, evaluation_id: str) -> PreparedRequest:
-        return PreparedRequest(method="GET", url=f"/v1/projects/{evaluation_id}/documents")
+    def prepare_list(self, project_id: str) -> PreparedRequest:
+        return PreparedRequest(method="GET", url=f"/v1/projects/{project_id}/documents")
 
-    def prepare_update(self, evaluation_id: str, document_id: str, annotation: dict[str, Any]) -> PreparedRequest:
+    def prepare_update(self, project_id: str, document_id: str, annotation: dict[str, Any]) -> PreparedRequest:
         update_request = PatchProjectDocumentRequest(annotation=annotation)
-        return PreparedRequest(method="PATCH", url=f"/v1/projects/{evaluation_id}/documents/{document_id}", data=update_request.model_dump(mode="json", exclude_unset=True))
+        return PreparedRequest(method="PATCH", url=f"/v1/projects/{project_id}/documents/{document_id}", data=update_request.model_dump(mode="json", exclude_unset=True))
 
-    def prepare_delete(self, evaluation_id: str, document_id: str) -> PreparedRequest:
-        return PreparedRequest(method="DELETE", url=f"/v1/projects/{evaluation_id}/documents/{document_id}")
+    def prepare_delete(self, project_id: str, document_id: str) -> PreparedRequest:
+        return PreparedRequest(method="DELETE", url=f"/v1/projects/{project_id}/documents/{document_id}")
 
-    def prepare_llm_annotate(self, evaluation_id: str, document_id: str) -> PreparedRequest:
-        return PreparedRequest(method="POST", url=f"/v1/projects/{evaluation_id}/documents/{document_id}/llm-annotate", data={"stream": False})
+    def prepare_llm_annotate(self, project_id: str, document_id: str) -> PreparedRequest:
+        return PreparedRequest(method="POST", url=f"/v1/projects/{project_id}/documents/{document_id}/llm-annotate", data={"stream": False})
 
 
 class Documents(SyncAPIResource, DocumentsMixin):
@@ -42,7 +42,7 @@ class Documents(SyncAPIResource, DocumentsMixin):
 
     def create(
         self,
-        evaluation_id: str,
+        project_id: str,
         document: Union[Path, str, IOBase, MIMEData, PIL.Image.Image, HttpUrl],
         annotation: Dict[str, Any],
         annotation_metadata: Dict[str, Any] | None = None,
@@ -51,7 +51,7 @@ class Documents(SyncAPIResource, DocumentsMixin):
         Create a document for an evaluation.
 
         Args:
-            evaluation_id: The ID of the evaluation
+            project_id: The ID of the evaluation
             document: The document to process. Can be:
                 - A file path (Path or str)
                 - A file-like object (IOBase)
@@ -69,32 +69,32 @@ class Documents(SyncAPIResource, DocumentsMixin):
         mime_document: MIMEData = prepare_mime_document(document)
 
         # Let prepare_create handle the serialization
-        request = self.prepare_create(evaluation_id, mime_document, annotation, annotation_metadata)
+        request = self.prepare_create(project_id, mime_document, annotation, annotation_metadata)
         response = self._client._prepared_request(request)
         return ProjectDocument(**response)
 
-    def list(self, evaluation_id: str) -> List[ProjectDocument]:
+    def list(self, project_id: str) -> List[ProjectDocument]:
         """
         List documents for an evaluation.
 
         Args:
-            evaluation_id: The ID of the evaluation
+            project_id: The ID of the evaluation
 
         Returns:
             List[ProjectDocument]: List of documents
         Raises:
             HTTPException if the request fails
         """
-        request = self.prepare_list(evaluation_id)
+        request = self.prepare_list(project_id)
         response = self._client._prepared_request(request)
         return [ProjectDocument(**item) for item in response.get("data", [])]
 
-    def get(self, evaluation_id: str, document_id: str) -> ProjectDocument:
+    def get(self, project_id: str, document_id: str) -> ProjectDocument:
         """
         Get a document by ID.
 
         Args:
-            evaluation_id: The ID of the evaluation
+            project_id: The ID of the evaluation
             document_id: The ID of the document
 
         Returns:
@@ -102,16 +102,16 @@ class Documents(SyncAPIResource, DocumentsMixin):
         Raises:
             HTTPException if the request fails
         """
-        request = self.prepare_get(evaluation_id, document_id)
+        request = self.prepare_get(project_id, document_id)
         response = self._client._prepared_request(request)
         return ProjectDocument(**response)
 
-    def update(self, evaluation_id: str, document_id: str, annotation: dict[str, Any]) -> ProjectDocument:
+    def update(self, project_id: str, document_id: str, annotation: dict[str, Any]) -> ProjectDocument:
         """
         Update a document.
 
         Args:
-            evaluation_id: The ID of the evaluation
+            project_id: The ID of the evaluation
             document_id: The ID of the document
             annotation: The ground truth for the document
         Returns:
@@ -119,16 +119,16 @@ class Documents(SyncAPIResource, DocumentsMixin):
         Raises:
             HTTPException if the request fails
         """
-        request = self.prepare_update(evaluation_id, document_id, annotation=annotation)
+        request = self.prepare_update(project_id, document_id, annotation=annotation)
         response = self._client._prepared_request(request)
         return ProjectDocument(**response)
 
-    def delete(self, evaluation_id: str, document_id: str) -> DeleteResponse:
+    def delete(self, project_id: str, document_id: str) -> DeleteResponse:
         """
         Delete a document.
 
         Args:
-            evaluation_id: The ID of the evaluation
+            project_id: The ID of the evaluation
             document_id: The ID of the document
 
         Returns:
@@ -136,14 +136,14 @@ class Documents(SyncAPIResource, DocumentsMixin):
         Raises:
             HTTPException if the request fails
         """
-        request = self.prepare_delete(evaluation_id, document_id)
+        request = self.prepare_delete(project_id, document_id)
         return self._client._prepared_request(request)
 
-    def llm_annotate(self, evaluation_id: str, document_id: str) -> RetabParsedChatCompletion:
+    def llm_annotate(self, project_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)
+        request = self.prepare_llm_annotate(project_id, document_id)
         response = self._client._prepared_request(request)
         return RetabParsedChatCompletion(**response)
 
@@ -153,7 +153,7 @@ class AsyncDocuments(AsyncAPIResource, DocumentsMixin):
 
     async def create(
         self,
-        evaluation_id: str,
+        project_id: str,
         document: Union[Path, str, IOBase, MIMEData, PIL.Image.Image, HttpUrl],
         annotation: Dict[str, Any],
         annotation_metadata: Dict[str, Any] | None = None,
@@ -162,7 +162,7 @@ class AsyncDocuments(AsyncAPIResource, DocumentsMixin):
         Create a document for an evaluation.
 
         Args:
-            evaluation_id: The ID of the evaluation
+            project_id: The ID of the evaluation
             document: The document to process. Can be:
                 - A file path (Path or str)
                 - A file-like object (IOBase)
@@ -180,32 +180,32 @@ class AsyncDocuments(AsyncAPIResource, DocumentsMixin):
         mime_document: MIMEData = prepare_mime_document(document)
 
         # Let prepare_create handle the serialization
-        request = self.prepare_create(evaluation_id, mime_document, annotation, annotation_metadata)
+        request = self.prepare_create(project_id, mime_document, annotation, annotation_metadata)
         response = await self._client._prepared_request(request)
         return ProjectDocument(**response)
 
-    async def list(self, evaluation_id: str) -> List[ProjectDocument]:
+    async def list(self, project_id: str) -> List[ProjectDocument]:
         """
         List documents for an evaluation.
 
         Args:
-            evaluation_id: The ID of the evaluation
+            project_id: The ID of the evaluation
 
         Returns:
             List[ProjectDocument]: List of documents
         Raises:
             HTTPException if the request fails
         """
-        request = self.prepare_list(evaluation_id)
+        request = self.prepare_list(project_id)
         response = await self._client._prepared_request(request)
         return [ProjectDocument(**item) for item in response.get("data", [])]
 
-    async def update(self, evaluation_id: str, document_id: str, annotation: dict[str, Any]) -> ProjectDocument:
+    async def update(self, project_id: str, document_id: str, annotation: dict[str, Any]) -> ProjectDocument:
         """
         Update a document.
 
         Args:
-            evaluation_id: The ID of the evaluation
+            project_id: The ID of the evaluation
             document_id: The ID of the document
             annotation: The ground truth for the document
 
@@ -214,16 +214,16 @@ class AsyncDocuments(AsyncAPIResource, DocumentsMixin):
         Raises:
             HTTPException if the request fails
         """
-        request = self.prepare_update(evaluation_id, document_id, annotation)
+        request = self.prepare_update(project_id, document_id, annotation)
         response = await self._client._prepared_request(request)
         return ProjectDocument(**response)
 
-    async def delete(self, evaluation_id: str, document_id: str) -> DeleteResponse:
+    async def delete(self, project_id: str, document_id: str) -> DeleteResponse:
         """
         Delete a document.
 
         Args:
-            evaluation_id: The ID of the evaluation
+            project_id: The ID of the evaluation
             document_id: The ID of the document
 
         Returns:
@@ -231,14 +231,14 @@ class AsyncDocuments(AsyncAPIResource, DocumentsMixin):
         Raises:
             HTTPException if the request fails
         """
-        request = self.prepare_delete(evaluation_id, document_id)
+        request = self.prepare_delete(project_id, document_id)
         return await self._client._prepared_request(request)
 
-    async def llm_annotate(self, evaluation_id: str, document_id: str) -> RetabParsedChatCompletion:
+    async def llm_annotate(self, project_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)
+        request = self.prepare_llm_annotate(project_id, document_id)
         response = await self._client._prepared_request(request)
         return RetabParsedChatCompletion(**response)