ksapi 2.9.2__tar.gz → 2.9.4__tar.gz

{ksapi-2.9.2 → ksapi-2.9.4}/PKG-INFO

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

{ksapi-2.9.2 → ksapi-2.9.4}/ksapi/__init__.py

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

{ksapi-2.9.2 → ksapi-2.9.4}/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/2.9.2/python'
+        self.user_agent = 'OpenAPI-Generator/2.9.4/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

{ksapi-2.9.2 → ksapi-2.9.4}/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: 2.9.2".\
+               "SDK Package Version: 2.9.4".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

{ksapi-2.9.2 → ksapi-2.9.4}/ksapi/models/chunk_metadata.py

@@ -35,6 +35,7 @@ class ChunkMetadata(BaseModel):
     summary: Optional[StrictStr] = Field(default=None, description="LLM-generated summary of the chunk content. Used for TABLE and HTML chunks to enrich embedding text, and for JSON/YAML chunks (with summarize_for_embedding) as the sole dense embedding text.")
     summarize_for_embedding: Optional[StrictBool] = Field(default=False, description="When True, this chunk's dense embedding is built from its LLM-generated summary (see summary) instead of its raw content. Set for parsed JSON/YAML single chunks so noisy structured text does not dominate the vector; the raw content is still kept for display and sparse (keyword) retrieval. Enrichment generates the summary when this is set and summary is empty.")
     extracted_text_s3_uri: Optional[StrictStr] = Field(default=None, description="S3 URI to extracted PDF text used for LLM grounding during enrichment")
+    caption: Optional[StrictStr] = Field(default=None, description="Caption and footnote lines MinerU extracted next to a visual, joined by newlines. IMAGE chunks only: their content is a generated description that enrichment overwrites, so the caption cannot live there — enrichment appends it to the description it writes. TABLE captions are appended to table_body directly, because a table's content is extracted text rather than generated.")
     secondary_taxonomy: Optional[ImageTaxonomy] = None
     start_ms: Optional[StrictInt] = Field(default=None, description="Start time of this chunk in the source media (ms from start).")
     end_ms: Optional[StrictInt] = Field(default=None, description="End time of this chunk in the source media (ms from start).")
@@ -51,7 +52,7 @@ class ChunkMetadata(BaseModel):
     key_cells: Optional[List[StrictStr]] = Field(default=None, description="Notable output/header cells as A1 refs, e.g. 'Sheet1!A1' (XLSX only)")
     named_ranges: Optional[List[StrictStr]] = Field(default=None, description="Names of named ranges overlapping this chunk (XLSX only)")
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["polygons", "s3_urls", "summary", "summarize_for_embedding", "extracted_text_s3_uri", "secondary_taxonomy", "start_ms", "end_ms", "speakers", "languages", "segments", "sheet_name", "block_type", "source_uri", "enriched_html", "cell_range", "dependency_summary", "formulas", "key_cells", "named_ranges"]
+    __properties: ClassVar[List[str]] = ["polygons", "s3_urls", "summary", "summarize_for_embedding", "extracted_text_s3_uri", "caption", "secondary_taxonomy", "start_ms", "end_ms", "speakers", "languages", "segments", "sheet_name", "block_type", "source_uri", "enriched_html", "cell_range", "dependency_summary", "formulas", "key_cells", "named_ranges"]
 
     model_config = ConfigDict(
         validate_by_name=True,
@@ -123,6 +124,11 @@ class ChunkMetadata(BaseModel):
         if self.extracted_text_s3_uri is None and "extracted_text_s3_uri" in self.model_fields_set:
             _dict['extracted_text_s3_uri'] = None
 
+        # set to None if caption (nullable) is None
+        # and model_fields_set contains the field
+        if self.caption is None and "caption" in self.model_fields_set:
+            _dict['caption'] = None
+
         # set to None if start_ms (nullable) is None
         # and model_fields_set contains the field
         if self.start_ms is None and "start_ms" in self.model_fields_set:
@@ -210,6 +216,7 @@ class ChunkMetadata(BaseModel):
             "summary": obj.get("summary"),
             "summarize_for_embedding": obj.get("summarize_for_embedding") if obj.get("summarize_for_embedding") is not None else False,
             "extracted_text_s3_uri": obj.get("extracted_text_s3_uri"),
+            "caption": obj.get("caption"),
             "secondary_taxonomy": obj.get("secondary_taxonomy"),
             "start_ms": obj.get("start_ms"),
             "end_ms": obj.get("end_ms"),

{ksapi-2.9.2 → ksapi-2.9.4}/ksapi.egg-info/PKG-INFO

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

{ksapi-2.9.2 → ksapi-2.9.4}/pyproject.toml

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

{ksapi-2.9.2 → ksapi-2.9.4}/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 = "2.9.2"
+VERSION = "2.9.4"
 PYTHON_REQUIRES = ">= 3.9"
 REQUIRES = [
     "urllib3 >= 2.1.0, < 3.0.0",

{ksapi-2.9.2 → ksapi-2.9.4}/test/test_chunk_bulk_response.py

@@ -56,6 +56,7 @@ class TestChunkBulkResponse(unittest.TestCase):
                     summary = '', 
                     summarize_for_embedding = True, 
                     extracted_text_s3_uri = '', 
+                    caption = '', 
                     secondary_taxonomy = 'picture', 
                     start_ms = 56, 
                     end_ms = 56, 
@@ -137,6 +138,7 @@ class TestChunkBulkResponse(unittest.TestCase):
                     summary = '', 
                     summarize_for_embedding = True, 
                     extracted_text_s3_uri = '', 
+                    caption = '', 
                     secondary_taxonomy = 'picture', 
                     start_ms = 56, 
                     end_ms = 56, 

{ksapi-2.9.2 → ksapi-2.9.4}/test/test_chunk_content_item.py

@@ -60,6 +60,7 @@ class TestChunkContentItem(unittest.TestCase):
                     summary = '', 
                     summarize_for_embedding = True, 
                     extracted_text_s3_uri = '', 
+                    caption = '', 
                     secondary_taxonomy = 'picture', 
                     start_ms = 56, 
                     end_ms = 56, 

{ksapi-2.9.2 → ksapi-2.9.4}/test/test_chunk_metadata.py

@@ -50,6 +50,7 @@ class TestChunkMetadata(unittest.TestCase):
                 summary = '',
                 summarize_for_embedding = True,
                 extracted_text_s3_uri = '',
+                caption = '',
                 secondary_taxonomy = 'picture',
                 start_ms = 56,
                 end_ms = 56,

{ksapi-2.9.2 → ksapi-2.9.4}/test/test_chunk_response.py

@@ -56,6 +56,7 @@ class TestChunkResponse(unittest.TestCase):
                     summary = '', 
                     summarize_for_embedding = True, 
                     extracted_text_s3_uri = '', 
+                    caption = '', 
                     secondary_taxonomy = 'picture', 
                     start_ms = 56, 
                     end_ms = 56, 
@@ -134,6 +135,7 @@ class TestChunkResponse(unittest.TestCase):
                     summary = '', 
                     summarize_for_embedding = True, 
                     extracted_text_s3_uri = '', 
+                    caption = '', 
                     secondary_taxonomy = 'picture', 
                     start_ms = 56, 
                     end_ms = 56, 

{ksapi-2.9.2 → ksapi-2.9.4}/test/test_create_chunk_request.py

@@ -54,6 +54,7 @@ class TestCreateChunkRequest(unittest.TestCase):
                     summary = '', 
                     summarize_for_embedding = True, 
                     extracted_text_s3_uri = '', 
+                    caption = '', 
                     secondary_taxonomy = 'picture', 
                     start_ms = 56, 
                     end_ms = 56, 
@@ -110,6 +111,7 @@ class TestCreateChunkRequest(unittest.TestCase):
                     summary = '', 
                     summarize_for_embedding = True, 
                     extracted_text_s3_uri = '', 
+                    caption = '', 
                     secondary_taxonomy = 'picture', 
                     start_ms = 56, 
                     end_ms = 56, 

{ksapi-2.9.2 → ksapi-2.9.4}/test/test_lineage_graph_response.py

@@ -56,6 +56,7 @@ class TestLineageGraphResponse(unittest.TestCase):
                             summary = '', 
                             summarize_for_embedding = True, 
                             extracted_text_s3_uri = '', 
+                            caption = '', 
                             secondary_taxonomy = 'picture', 
                             start_ms = 56, 
                             end_ms = 56, 
@@ -122,6 +123,7 @@ class TestLineageGraphResponse(unittest.TestCase):
                             summary = '', 
                             summarize_for_embedding = True, 
                             extracted_text_s3_uri = '', 
+                            caption = '', 
                             secondary_taxonomy = 'picture', 
                             start_ms = 56, 
                             end_ms = 56, 

{ksapi-2.9.2 → ksapi-2.9.4}/test/test_lineage_node_response.py

@@ -54,6 +54,7 @@ class TestLineageNodeResponse(unittest.TestCase):
                     summary = '', 
                     summarize_for_embedding = True, 
                     extracted_text_s3_uri = '', 
+                    caption = '', 
                     secondary_taxonomy = 'picture', 
                     start_ms = 56, 
                     end_ms = 56, 
@@ -112,6 +113,7 @@ class TestLineageNodeResponse(unittest.TestCase):
                     summary = '', 
                     summarize_for_embedding = True, 
                     extracted_text_s3_uri = '', 
+                    caption = '', 
                     secondary_taxonomy = 'picture', 
                     start_ms = 56, 
                     end_ms = 56, 

{ksapi-2.9.2 → ksapi-2.9.4}/test/test_scored_chunk_response.py

@@ -56,6 +56,7 @@ class TestScoredChunkResponse(unittest.TestCase):
                     summary = '', 
                     summarize_for_embedding = True, 
                     extracted_text_s3_uri = '', 
+                    caption = '', 
                     secondary_taxonomy = 'picture', 
                     start_ms = 56, 
                     end_ms = 56, 
@@ -135,6 +136,7 @@ class TestScoredChunkResponse(unittest.TestCase):
                     summary = '', 
                     summarize_for_embedding = True, 
                     extracted_text_s3_uri = '', 
+                    caption = '', 
                     secondary_taxonomy = 'picture', 
                     start_ms = 56, 
                     end_ms = 56, 

{ksapi-2.9.2 → ksapi-2.9.4}/test/test_section_content_item_or_chunk_content_item.py

@@ -67,6 +67,7 @@ class TestSectionContentItemOrChunkContentItem(unittest.TestCase):
                     summary = '', 
                     summarize_for_embedding = True, 
                     extracted_text_s3_uri = '', 
+                    caption = '', 
                     secondary_taxonomy = 'picture', 
                     start_ms = 56, 
                     end_ms = 56, 

{ksapi-2.9.2 → ksapi-2.9.4}/test/test_update_chunk_metadata_request.py

@@ -51,6 +51,7 @@ class TestUpdateChunkMetadataRequest(unittest.TestCase):
                     summary = '', 
                     summarize_for_embedding = True, 
                     extracted_text_s3_uri = '', 
+                    caption = '', 
                     secondary_taxonomy = 'picture', 
                     start_ms = 56, 
                     end_ms = 56,