usecortex-ai 0.4.0__py3-none-any.whl → 0.5.1__py3-none-any.whl

usecortex_ai/upload/client.py

@@ -6,13 +6,11 @@ from .. import core
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
 from ..types.add_memory_response import AddMemoryResponse
-from ..types.app_sources_upload_data import AppSourcesUploadData
 from ..types.delete_user_memory_response import DeleteUserMemoryResponse
 from ..types.memory_item import MemoryItem
 from ..types.processing_status import ProcessingStatus
 from ..types.source_upload_response import SourceUploadResponse
 from .raw_client import AsyncRawUploadClient, RawUploadClient
-from .types.body_upload_app_ingestion_upload_app_post_app_sources import BodyUploadAppIngestionUploadAppPostAppSources
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -33,27 +31,20 @@ class UploadClient:
         """
         return self._raw_client
 
-    def upload_document(
+    def upload_knowledge(
         self,
         *,
-        files: typing.List[core.File],
         tenant_id: str,
         sub_tenant_id: typing.Optional[str] = OMIT,
         upsert: typing.Optional[bool] = OMIT,
+        files: typing.Optional[typing.List[core.File]] = OMIT,
         file_metadata: typing.Optional[str] = OMIT,
+        app_sources: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SourceUploadResponse:
         """
-        Upload one or more documents for ingestion.
-        Supports both single and batch uploads.
-        For single file: send one file with the 'files' field.
-        For batch: send multiple files with the 'files' field (FastAPI will parse as list).
-
         Parameters
         ----------
-        files : typing.List[core.File]
-            See core.File for more documentation
-
         tenant_id : str
             Unique identifier for the tenant/organization
 
@@ -61,9 +52,16 @@ class UploadClient:
             Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
 
         upsert : typing.Optional[bool]
+            If true, update existing sources with the same id.
+
+        files : typing.Optional[typing.List[core.File]]
+            See core.File for more documentation
 
         file_metadata : typing.Optional[str]
-            JSON Array of file metadata objects
+            JSON array of file metadata objects; length must match files when provided.
+
+        app_sources : typing.Optional[str]
+            JSON: single source object or array of app-generated sources to index. Omit when only uploading files.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -78,65 +76,15 @@ class UploadClient:
         from usecortex-ai import CortexAI
 
         client = CortexAI(token="YOUR_TOKEN", )
-        client.upload.upload_document(tenant_id='tenant_id', )
+        client.upload.upload_knowledge(tenant_id='tenant_id', )
         """
-        _response = self._raw_client.upload_document(
-            files=files,
+        _response = self._raw_client.upload_knowledge(
             tenant_id=tenant_id,
             sub_tenant_id=sub_tenant_id,
             upsert=upsert,
+            files=files,
             file_metadata=file_metadata,
-            request_options=request_options,
-        )
-        return _response.data
-
-    def upload_app_sources(
-        self,
-        *,
-        app_sources: BodyUploadAppIngestionUploadAppPostAppSources,
-        tenant_id: str,
-        sub_tenant_id: typing.Optional[str] = OMIT,
-        upsert: typing.Optional[bool] = OMIT,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> AppSourcesUploadData:
-        """
-        Upload structured sources generated by first-party or third-party apps.
-        Supports both single and batch uploads.
-
-        Parameters
-        ----------
-        app_sources : BodyUploadAppIngestionUploadAppPostAppSources
-            Single source object or list of structured source objects containing app-generated data to be indexed
-
-        tenant_id : str
-            Unique identifier for the tenant/organization
-
-        sub_tenant_id : typing.Optional[str]
-            Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
-
-        upsert : typing.Optional[bool]
-            If true, update existing sources with the same source_id. Defaults to True.
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        AppSourcesUploadData
-            Successful Response
-
-        Examples
-        --------
-        from usecortex-ai import CortexAI, SourceModel
-
-        client = CortexAI(token="YOUR_TOKEN", )
-        client.upload.upload_app_sources(app_sources=SourceModel(id='id', tenant_id='tenant_id', sub_tenant_id='sub_tenant_id', ), tenant_id='tenant_id', )
-        """
-        _response = self._raw_client.upload_app_sources(
             app_sources=app_sources,
-            tenant_id=tenant_id,
-            sub_tenant_id=sub_tenant_id,
-            upsert=upsert,
             request_options=request_options,
         )
         return _response.data
@@ -150,12 +98,6 @@ class UploadClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ProcessingStatus:
         """
-        Check the current processing status of your uploaded content.
-
-        This endpoint allows you to monitor the progress of documents, text, or other content you've uploaded. Simply provide the file ID to see whether processing is complete, still in progress, or if any errors occurred.
-
-        Use this to determine when your content is ready for search and retrieval, or to troubleshoot any processing issues.
-
         Parameters
         ----------
         file_id : str
@@ -180,7 +122,7 @@ class UploadClient:
         from usecortex-ai import CortexAI
 
         client = CortexAI(token="YOUR_TOKEN", )
-        client.upload.verify_processing(file_id='file_id', )
+        client.upload.verify_processing(file_id='<str>', tenant_id='tenant_1234', )
         """
         _response = self._raw_client.verify_processing(
             file_id=file_id, tenant_id=tenant_id, sub_tenant_id=sub_tenant_id, request_options=request_options
@@ -197,24 +139,6 @@ class UploadClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AddMemoryResponse:
         """
-        Add memories for indexing and retrieval.
-
-            This API provides a unified entry point for ingesting various types of content:
-
-            **Content Types Supported:**
-            - Raw text content (`text` field)
-            - Markdown formatted content (`text` + `is_markdown=true`)
-            - User/assistant conversation pairs (`user_assistant_pairs` field)
-
-            **Key Features:**
-            - **Inference Mode (`infer=true`)**: When enabled, the system extracts additional
-              insights and implicit information from your content. Useful for conversation
-              analysis and knowledge extraction.
-            - **Direct Mode (`infer=false`)**: Content is chunked and indexed as-is without
-              additional processing.
-
-            Use `/ingestion/verify-processing` endpoint to check the processing status.
-
         Parameters
         ----------
         memories : typing.Sequence[MemoryItem]
@@ -242,7 +166,7 @@ class UploadClient:
         from usecortex-ai import CortexAI, MemoryItem
 
         client = CortexAI(token="YOUR_TOKEN", )
-        client.upload.add_memory(memories=[MemoryItem()], tenant_id='tenant_id', )
+        client.upload.add_memory(memories=[MemoryItem()], tenant_id='tenant_1234', )
         """
         _response = self._raw_client.add_memory(
             memories=memories,
@@ -262,14 +186,6 @@ class UploadClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> DeleteUserMemoryResponse:
         """
-        Permanently remove a specific memory from storage.
-
-            This API allows you to delete a memory by its unique identifier.
-            Once deleted, the memory cannot be recovered, so use this operation carefully.
-
-            The memory will be removed from your tenant's storage and will no longer
-            appear in search results or memory listings.
-
         Parameters
         ----------
         tenant_id : str
@@ -294,7 +210,7 @@ class UploadClient:
         from usecortex-ai import CortexAI
 
         client = CortexAI(token="YOUR_TOKEN", )
-        client.upload.delete_memory(tenant_id='tenant_id', memory_id='memory_id', )
+        client.upload.delete_memory(tenant_id='tenant_1234', memory_id='memory_1234', )
         """
         _response = self._raw_client.delete_memory(
             tenant_id=tenant_id, memory_id=memory_id, sub_tenant_id=sub_tenant_id, request_options=request_options
@@ -317,27 +233,20 @@ class AsyncUploadClient:
         """
         return self._raw_client
 
-    async def upload_document(
+    async def upload_knowledge(
         self,
         *,
-        files: typing.List[core.File],
         tenant_id: str,
         sub_tenant_id: typing.Optional[str] = OMIT,
         upsert: typing.Optional[bool] = OMIT,
+        files: typing.Optional[typing.List[core.File]] = OMIT,
         file_metadata: typing.Optional[str] = OMIT,
+        app_sources: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SourceUploadResponse:
         """
-        Upload one or more documents for ingestion.
-        Supports both single and batch uploads.
-        For single file: send one file with the 'files' field.
-        For batch: send multiple files with the 'files' field (FastAPI will parse as list).
-
         Parameters
         ----------
-        files : typing.List[core.File]
-            See core.File for more documentation
-
         tenant_id : str
             Unique identifier for the tenant/organization
 
@@ -345,9 +254,16 @@ class AsyncUploadClient:
             Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
 
         upsert : typing.Optional[bool]
+            If true, update existing sources with the same id.
+
+        files : typing.Optional[typing.List[core.File]]
+            See core.File for more documentation
 
         file_metadata : typing.Optional[str]
-            JSON Array of file metadata objects
+            JSON array of file metadata objects; length must match files when provided.
+
+        app_sources : typing.Optional[str]
+            JSON: single source object or array of app-generated sources to index. Omit when only uploading files.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -365,70 +281,16 @@ class AsyncUploadClient:
 
         client = AsyncCortexAI(token="YOUR_TOKEN", )
         async def main() -> None:
-            await client.upload.upload_document(tenant_id='tenant_id', )
+            await client.upload.upload_knowledge(tenant_id='tenant_id', )
         asyncio.run(main())
         """
-        _response = await self._raw_client.upload_document(
-            files=files,
+        _response = await self._raw_client.upload_knowledge(
             tenant_id=tenant_id,
             sub_tenant_id=sub_tenant_id,
             upsert=upsert,
+            files=files,
             file_metadata=file_metadata,
-            request_options=request_options,
-        )
-        return _response.data
-
-    async def upload_app_sources(
-        self,
-        *,
-        app_sources: BodyUploadAppIngestionUploadAppPostAppSources,
-        tenant_id: str,
-        sub_tenant_id: typing.Optional[str] = OMIT,
-        upsert: typing.Optional[bool] = OMIT,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> AppSourcesUploadData:
-        """
-        Upload structured sources generated by first-party or third-party apps.
-        Supports both single and batch uploads.
-
-        Parameters
-        ----------
-        app_sources : BodyUploadAppIngestionUploadAppPostAppSources
-            Single source object or list of structured source objects containing app-generated data to be indexed
-
-        tenant_id : str
-            Unique identifier for the tenant/organization
-
-        sub_tenant_id : typing.Optional[str]
-            Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
-
-        upsert : typing.Optional[bool]
-            If true, update existing sources with the same source_id. Defaults to True.
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        AppSourcesUploadData
-            Successful Response
-
-        Examples
-        --------
-        import asyncio
-
-        from usecortex-ai import AsyncCortexAI, SourceModel
-
-        client = AsyncCortexAI(token="YOUR_TOKEN", )
-        async def main() -> None:
-            await client.upload.upload_app_sources(app_sources=SourceModel(id='id', tenant_id='tenant_id', sub_tenant_id='sub_tenant_id', ), tenant_id='tenant_id', )
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.upload_app_sources(
             app_sources=app_sources,
-            tenant_id=tenant_id,
-            sub_tenant_id=sub_tenant_id,
-            upsert=upsert,
             request_options=request_options,
         )
         return _response.data
@@ -442,12 +304,6 @@ class AsyncUploadClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ProcessingStatus:
         """
-        Check the current processing status of your uploaded content.
-
-        This endpoint allows you to monitor the progress of documents, text, or other content you've uploaded. Simply provide the file ID to see whether processing is complete, still in progress, or if any errors occurred.
-
-        Use this to determine when your content is ready for search and retrieval, or to troubleshoot any processing issues.
-
         Parameters
         ----------
         file_id : str
@@ -475,7 +331,7 @@ class AsyncUploadClient:
 
         client = AsyncCortexAI(token="YOUR_TOKEN", )
         async def main() -> None:
-            await client.upload.verify_processing(file_id='file_id', )
+            await client.upload.verify_processing(file_id='<str>', tenant_id='tenant_1234', )
         asyncio.run(main())
         """
         _response = await self._raw_client.verify_processing(
@@ -493,24 +349,6 @@ class AsyncUploadClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AddMemoryResponse:
         """
-        Add memories for indexing and retrieval.
-
-            This API provides a unified entry point for ingesting various types of content:
-
-            **Content Types Supported:**
-            - Raw text content (`text` field)
-            - Markdown formatted content (`text` + `is_markdown=true`)
-            - User/assistant conversation pairs (`user_assistant_pairs` field)
-
-            **Key Features:**
-            - **Inference Mode (`infer=true`)**: When enabled, the system extracts additional
-              insights and implicit information from your content. Useful for conversation
-              analysis and knowledge extraction.
-            - **Direct Mode (`infer=false`)**: Content is chunked and indexed as-is without
-              additional processing.
-
-            Use `/ingestion/verify-processing` endpoint to check the processing status.
-
         Parameters
         ----------
         memories : typing.Sequence[MemoryItem]
@@ -541,7 +379,7 @@ class AsyncUploadClient:
 
         client = AsyncCortexAI(token="YOUR_TOKEN", )
         async def main() -> None:
-            await client.upload.add_memory(memories=[MemoryItem()], tenant_id='tenant_id', )
+            await client.upload.add_memory(memories=[MemoryItem()], tenant_id='tenant_1234', )
         asyncio.run(main())
         """
         _response = await self._raw_client.add_memory(
@@ -562,14 +400,6 @@ class AsyncUploadClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> DeleteUserMemoryResponse:
         """
-        Permanently remove a specific memory from storage.
-
-            This API allows you to delete a memory by its unique identifier.
-            Once deleted, the memory cannot be recovered, so use this operation carefully.
-
-            The memory will be removed from your tenant's storage and will no longer
-            appear in search results or memory listings.
-
         Parameters
         ----------
         tenant_id : str
@@ -597,7 +427,7 @@ class AsyncUploadClient:
 
         client = AsyncCortexAI(token="YOUR_TOKEN", )
         async def main() -> None:
-            await client.upload.delete_memory(tenant_id='tenant_id', memory_id='memory_id', )
+            await client.upload.delete_memory(tenant_id='tenant_1234', memory_id='memory_1234', )
         asyncio.run(main())
         """
         _response = await self._raw_client.delete_memory(