ksapi 3.18.2__tar.gz → 3.19.0__tar.gz

{ksapi-3.18.2 → ksapi-3.19.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ksapi
-Version: 3.18.2
+Version: 3.19.0
 Summary: Knowledge Stack API
 Home-page: 
 Author: OpenAPI Generator community

{ksapi-3.18.2 → ksapi-3.19.0}/ksapi/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "3.18.2"
+__version__ = "3.19.0"
 
 # Define package exports
 __all__ = [

{ksapi-3.18.2 → ksapi-3.19.0}/ksapi/api/system_jobs_api.py

@@ -347,7 +347,7 @@ class SystemJobsApi:
     ) -> WorkflowCancelResponse:
         """Cancel Temporal Workflow Handler
 
-        Cancel any Temporal workflow owned by the caller's tenant.  No status guard — this is a thin Temporal wrapper. Cancelling an already-terminal workflow is a no-op on the Temporal side. A run no worker ever picked up is terminated instead, since a cancel request is itself a workflow task nobody would process. When Temporal no longer has the run, or it was terminated here, a document version still showing it running is settled as cancelled (needs ``can_write``) so it can be re-run.
+        Cancel a tenant workflow; tracked ingestion also requires document write access.  Tracked attempts are settled before cancelling their matching Temporal run, including attempts not yet dispatched. Unstarted executions are terminated because cancellation needs a worker. Temporal operations pin the described run so a concurrent rerun is left alone.
 
         :param workflow_id: (required)
         :type workflow_id: str
@@ -415,7 +415,7 @@ class SystemJobsApi:
     ) -> ApiResponse[WorkflowCancelResponse]:
         """Cancel Temporal Workflow Handler
 
-        Cancel any Temporal workflow owned by the caller's tenant.  No status guard — this is a thin Temporal wrapper. Cancelling an already-terminal workflow is a no-op on the Temporal side. A run no worker ever picked up is terminated instead, since a cancel request is itself a workflow task nobody would process. When Temporal no longer has the run, or it was terminated here, a document version still showing it running is settled as cancelled (needs ``can_write``) so it can be re-run.
+        Cancel a tenant workflow; tracked ingestion also requires document write access.  Tracked attempts are settled before cancelling their matching Temporal run, including attempts not yet dispatched. Unstarted executions are terminated because cancellation needs a worker. Temporal operations pin the described run so a concurrent rerun is left alone.
 
         :param workflow_id: (required)
         :type workflow_id: str
@@ -483,7 +483,7 @@ class SystemJobsApi:
     ) -> RESTResponseType:
         """Cancel Temporal Workflow Handler
 
-        Cancel any Temporal workflow owned by the caller's tenant.  No status guard — this is a thin Temporal wrapper. Cancelling an already-terminal workflow is a no-op on the Temporal side. A run no worker ever picked up is terminated instead, since a cancel request is itself a workflow task nobody would process. When Temporal no longer has the run, or it was terminated here, a document version still showing it running is settled as cancelled (needs ``can_write``) so it can be re-run.
+        Cancel a tenant workflow; tracked ingestion also requires document write access.  Tracked attempts are settled before cancelling their matching Temporal run, including attempts not yet dispatched. Unstarted executions are terminated because cancellation needs a worker. Temporal operations pin the described run so a concurrent rerun is left alone.
 
         :param workflow_id: (required)
         :type workflow_id: str

{ksapi-3.18.2 → ksapi-3.19.0}/ksapi/api_client.py

@@ -91,7 +91,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/3.18.2/python'
+        self.user_agent = 'OpenAPI-Generator/3.19.0/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

{ksapi-3.18.2 → ksapi-3.19.0}/ksapi/configuration.py

@@ -562,7 +562,7 @@ conf = ksapi.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 0.1.0\n"\
-               "SDK Package Version: 3.18.2".\
+               "SDK Package Version: 3.19.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

{ksapi-3.18.2 → ksapi-3.19.0}/ksapi/models/pipeline_state.py

@@ -20,6 +20,7 @@ import json
 from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
 from ksapi.models.chunk_type import ChunkType
 from ksapi.models.image_taxonomy import ImageTaxonomy
 from ksapi.models.ingestion_mode import IngestionMode
@@ -32,11 +33,12 @@ class PipelineState(BaseModel):
     """
     Pipeline execution state tracking.
     """ # noqa: E501
+    last_stage_retry_attempt: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=0, description="Zero-based retry count for the current stage; maximum across fan-out activities. Managed by ingestion.")
     status: PipelineStatus
     last_run_timestamp: Optional[datetime] = Field(default=None, description="Timestamp of the last pipeline execution attempt (set once when a run starts)")
     last_state_update_timestamp: Optional[datetime] = Field(default=None, description="Timestamp of the last pipeline state change (set by activities)")
-    last_activity: Optional[StrictStr] = Field(default=None, description="Name of the last activity that executed (e.g., 'pdf_preparation_activity')")
-    error: Optional[StrictStr] = Field(default=None, description="Error message if pipeline failed")
+    last_activity: Optional[StrictStr] = Field(default=None, description="Current ingestion stage, recorded before its activity starts")
+    error: Optional[StrictStr] = Field(default=None, description="Latest stage failure; retained during retries and cleared on the next stage or success")
     temporal_workflow_id: Optional[StrictStr] = Field(default=None, description="Temporal workflow ID for tracking the ingestion run")
     chunks_processed: Optional[StrictInt] = Field(default=None, description="Number of chunks processed (for progress tracking)")
     page_dpi: Optional[StrictInt] = Field(default=None, description="DPI used for PDF page screenshots during ingestion")
@@ -44,7 +46,7 @@ class PipelineState(BaseModel):
     chunk_type: Optional[ChunkType] = None
     secondary_taxonomy: Optional[ImageTaxonomy] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["status", "last_run_timestamp", "last_state_update_timestamp", "last_activity", "error", "temporal_workflow_id", "chunks_processed", "page_dpi", "ingestion_mode", "chunk_type", "secondary_taxonomy"]
+    __properties: ClassVar[List[str]] = ["last_stage_retry_attempt", "status", "last_run_timestamp", "last_state_update_timestamp", "last_activity", "error", "temporal_workflow_id", "chunks_processed", "page_dpi", "ingestion_mode", "chunk_type", "secondary_taxonomy"]
 
     model_config = ConfigDict(
         validate_by_name=True,
@@ -76,9 +78,11 @@ class PipelineState(BaseModel):
         * `None` is only added to the output dict for nullable fields that
           were set at model initialization. Other fields with value `None`
           are ignored.
+        * OpenAPI `readOnly` fields are excluded.
         * Fields in `self.additional_properties` are added to the output dict.
         """
         excluded_fields: Set[str] = set([
+            "last_stage_retry_attempt",
             "additional_properties",
         ])
 
@@ -139,6 +143,7 @@ class PipelineState(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
+            "last_stage_retry_attempt": obj.get("last_stage_retry_attempt") if obj.get("last_stage_retry_attempt") is not None else 0,
             "status": obj.get("status"),
             "last_run_timestamp": obj.get("last_run_timestamp"),
             "last_state_update_timestamp": obj.get("last_state_update_timestamp"),

{ksapi-3.18.2 → ksapi-3.19.0}/ksapi/models/workflow_detail_response.py

@@ -20,6 +20,7 @@ import json
 from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, Optional
+from typing_extensions import Annotated
 from uuid import UUID
 from ksapi.models.pipeline_status import PipelineStatus
 from ksapi.models.user_info import UserInfo
@@ -40,6 +41,7 @@ class WorkflowDetailResponse(BaseModel):
     uploader: UserInfo
     status: PipelineStatus
     last_activity: Optional[StrictStr] = None
+    last_stage_retry_attempt: Optional[Annotated[int, Field(strict=True, ge=0)]] = 0
     error: Optional[StrictStr] = None
     last_run_timestamp: datetime = Field(description="When the last run started; the upload time until a run has started")
     last_state_update_timestamp: Optional[datetime] = None
@@ -51,7 +53,7 @@ class WorkflowDetailResponse(BaseModel):
     task_queue: StrictStr
     run_id: StrictStr
     chunks_processed: Optional[StrictInt] = None
-    __properties: ClassVar[List[str]] = ["workflow_id", "document_id", "document_name", "materialized_path", "document_version_id", "is_active_version", "uploader", "status", "last_activity", "error", "last_run_timestamp", "last_state_update_timestamp", "created_at", "temporal_status", "start_time", "close_time", "workflow_type", "task_queue", "run_id", "chunks_processed"]
+    __properties: ClassVar[List[str]] = ["workflow_id", "document_id", "document_name", "materialized_path", "document_version_id", "is_active_version", "uploader", "status", "last_activity", "last_stage_retry_attempt", "error", "last_run_timestamp", "last_state_update_timestamp", "created_at", "temporal_status", "start_time", "close_time", "workflow_type", "task_queue", "run_id", "chunks_processed"]
 
     model_config = ConfigDict(
         validate_by_name=True,
@@ -141,6 +143,7 @@ class WorkflowDetailResponse(BaseModel):
             "uploader": UserInfo.from_dict(obj["uploader"]) if obj.get("uploader") is not None else None,
             "status": obj.get("status"),
             "last_activity": obj.get("last_activity"),
+            "last_stage_retry_attempt": obj.get("last_stage_retry_attempt") if obj.get("last_stage_retry_attempt") is not None else 0,
             "error": obj.get("error"),
             "last_run_timestamp": obj.get("last_run_timestamp"),
             "last_state_update_timestamp": obj.get("last_state_update_timestamp"),

{ksapi-3.18.2 → ksapi-3.19.0}/ksapi/models/workflow_summary_response.py

@@ -20,6 +20,7 @@ import json
 from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
 from typing import Any, ClassVar, Dict, Optional
+from typing_extensions import Annotated
 from uuid import UUID
 from ksapi.models.pipeline_status import PipelineStatus
 from ksapi.models.user_info import UserInfo
@@ -40,11 +41,12 @@ class WorkflowSummaryResponse(BaseModel):
     uploader: UserInfo
     status: PipelineStatus
     last_activity: Optional[StrictStr] = None
+    last_stage_retry_attempt: Optional[Annotated[int, Field(strict=True, ge=0)]] = 0
     error: Optional[StrictStr] = None
     last_run_timestamp: datetime = Field(description="When the last run started; the upload time until a run has started")
     last_state_update_timestamp: Optional[datetime] = None
     created_at: datetime
-    __properties: ClassVar[List[str]] = ["workflow_id", "document_id", "document_name", "materialized_path", "document_version_id", "is_active_version", "uploader", "status", "last_activity", "error", "last_run_timestamp", "last_state_update_timestamp", "created_at"]
+    __properties: ClassVar[List[str]] = ["workflow_id", "document_id", "document_name", "materialized_path", "document_version_id", "is_active_version", "uploader", "status", "last_activity", "last_stage_retry_attempt", "error", "last_run_timestamp", "last_state_update_timestamp", "created_at"]
 
     model_config = ConfigDict(
         validate_by_name=True,
@@ -124,6 +126,7 @@ class WorkflowSummaryResponse(BaseModel):
             "uploader": UserInfo.from_dict(obj["uploader"]) if obj.get("uploader") is not None else None,
             "status": obj.get("status"),
             "last_activity": obj.get("last_activity"),
+            "last_stage_retry_attempt": obj.get("last_stage_retry_attempt") if obj.get("last_stage_retry_attempt") is not None else 0,
             "error": obj.get("error"),
             "last_run_timestamp": obj.get("last_run_timestamp"),
             "last_state_update_timestamp": obj.get("last_state_update_timestamp"),

{ksapi-3.18.2 → ksapi-3.19.0}/ksapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ksapi
-Version: 3.18.2
+Version: 3.19.0
 Summary: Knowledge Stack API
 Home-page: 
 Author: OpenAPI Generator community

{ksapi-3.18.2 → ksapi-3.19.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ksapi"
-version = "3.18.2"
+version = "3.19.0"
 description = "Knowledge Stack API"
 authors = [
   {name = "OpenAPI Generator Community",email = "team@openapitools.org"},

{ksapi-3.18.2 → ksapi-3.19.0}/setup.py

@@ -19,7 +19,7 @@ from setuptools import setup, find_packages  # noqa: H301
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "ksapi"
-VERSION = "3.18.2"
+VERSION = "3.19.0"
 PYTHON_REQUIRES = ">= 3.9"
 REQUIRES = [
     "urllib3 >= 2.1.0, < 3.0.0",

{ksapi-3.18.2 → ksapi-3.19.0}/test/test_document_version_metadata.py

@@ -43,6 +43,7 @@ class TestDocumentVersionMetadata(unittest.TestCase):
                 transcript_s3 = '',
                 hash = '',
                 pipeline_state = ksapi.models.pipeline_state.PipelineState(
+                    last_stage_retry_attempt = 0.0, 
                     status = 'pending', 
                     last_run_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                     last_state_update_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 

{ksapi-3.18.2 → ksapi-3.19.0}/test/test_document_version_metadata_update.py

@@ -46,6 +46,7 @@ class TestDocumentVersionMetadataUpdate(unittest.TestCase):
                 high_accuracy_middle_s3 = '',
                 hash = '',
                 pipeline_state = ksapi.models.pipeline_state.PipelineState(
+                    last_stage_retry_attempt = 0.0, 
                     status = 'pending', 
                     last_run_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                     last_state_update_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 

{ksapi-3.18.2 → ksapi-3.19.0}/test/test_paginated_response_workflow_summary_response.py

@@ -49,6 +49,7 @@ class TestPaginatedResponseWorkflowSummaryResponse(unittest.TestCase):
                             last_name = '', ), 
                         status = 'pending', 
                         last_activity = '', 
+                        last_stage_retry_attempt = 0.0, 
                         error = '', 
                         last_run_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                         last_state_update_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
@@ -74,6 +75,7 @@ class TestPaginatedResponseWorkflowSummaryResponse(unittest.TestCase):
                             last_name = '', ), 
                         status = 'pending', 
                         last_activity = '', 
+                        last_stage_retry_attempt = 0.0, 
                         error = '', 
                         last_run_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                         last_state_update_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 

{ksapi-3.18.2 → ksapi-3.19.0}/test/test_pipeline_state.py

@@ -35,6 +35,7 @@ class TestPipelineState(unittest.TestCase):
         model = PipelineState()
         if include_optional:
             return PipelineState(
+                last_stage_retry_attempt = 0.0,
                 status = 'pending',
                 last_run_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),
                 last_state_update_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),

{ksapi-3.18.2 → ksapi-3.19.0}/test/test_workflow_detail_response.py

@@ -47,6 +47,7 @@ class TestWorkflowDetailResponse(unittest.TestCase):
                     last_name = '', ),
                 status = 'pending',
                 last_activity = '',
+                last_stage_retry_attempt = 0.0,
                 error = '',
                 last_run_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),
                 last_state_update_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),

{ksapi-3.18.2 → ksapi-3.19.0}/test/test_workflow_summary_response.py

@@ -47,6 +47,7 @@ class TestWorkflowSummaryResponse(unittest.TestCase):
                     last_name = '', ),
                 status = 'pending',
                 last_activity = '',
+                last_stage_retry_attempt = 0.0,
                 error = '',
                 last_run_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),
                 last_state_update_timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),