usecortex-ai 0.2.1__py3-none-any.whl → 0.2.2__py3-none-any.whl

usecortex_ai/upload/client.py

@@ -8,7 +8,6 @@ from ..core.request_options import RequestOptions
 from ..types.app_sources_upload_data import AppSourcesUploadData
 from ..types.batch_upload_data import BatchUploadData
 from ..types.processing_status import ProcessingStatus
-from ..types.relations import Relations
 from ..types.single_upload_data import SingleUploadData
 from ..types.source_model import SourceModel
 from .raw_client import AsyncRawUploadClient, RawUploadClient
@@ -40,24 +39,38 @@ class UploadClient:
         sub_tenant_id: typing.Optional[str] = None,
         tenant_metadata: typing.Optional[str] = OMIT,
         document_metadata: typing.Optional[str] = OMIT,
-        relations: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> BatchUploadData:
         """
+        Upload multiple documents simultaneously for efficient bulk processing.
+
+        This endpoint allows you to upload several files at once, which is ideal for large document collections or periodic data imports. Each file gets processed asynchronously, and you can track the progress of individual files using their returned file IDs.
+
+        The system automatically handles file parsing, content extraction, and indexing across all uploaded documents. You'll receive confirmation once all files are queued for processing.
+
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         files : typing.List[core.File]
             See core.File for more documentation
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         tenant_metadata : typing.Optional[str]
+            JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+
+            Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
+
 
         document_metadata : typing.Optional[str]
+            JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
+
+            Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
+
 
-        relations : typing.Optional[str]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -80,7 +93,6 @@ class UploadClient:
             sub_tenant_id=sub_tenant_id,
             tenant_metadata=tenant_metadata,
             document_metadata=document_metadata,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -94,26 +106,41 @@ class UploadClient:
         source_ids: typing.Optional[typing.List[str]] = OMIT,
         tenant_metadata: typing.Optional[str] = OMIT,
         document_metadata: typing.Optional[str] = OMIT,
-        relations: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> BatchUploadData:
         """
+        Update multiple existing documents with new content and metadata.
+
+        Use this endpoint when you need to replace or modify several documents that are already in your knowledge base. Each file must correspond to an existing source ID, ensuring that updates are applied to the correct documents.
+
+        The system processes updates asynchronously, allowing you to continue working while your documents are re-indexed. Track the progress using the returned file IDs to know when updates are complete.
+
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         files : typing.List[core.File]
             See core.File for more documentation
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         source_ids : typing.Optional[typing.List[str]]
+            List of source IDs corresponding to the files being updated
 
         tenant_metadata : typing.Optional[str]
+            JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+
+            Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
+
 
         document_metadata : typing.Optional[str]
+            JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
+
+            Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
+
 
-        relations : typing.Optional[str]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -137,7 +164,6 @@ class UploadClient:
             source_ids=source_ids,
             tenant_metadata=tenant_metadata,
             document_metadata=document_metadata,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -150,24 +176,38 @@ class UploadClient:
         sub_tenant_id: typing.Optional[str] = None,
         tenant_metadata: typing.Optional[str] = OMIT,
         document_metadata: typing.Optional[str] = OMIT,
-        relations: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
+        Upload a single document for processing and indexing into your knowledge base.
+
+        This endpoint accepts documents in various formats and processes them for search and retrieval. You can include custom metadata to help organize and categorize your content.
+
+        The system extracts text content, processes it asynchronously, and makes it available for search queries. You can track the processing status using the returned file ID.
+
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         file : core.File
             See core.File for more documentation
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         tenant_metadata : typing.Optional[str]
+            JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+
+            Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
+
 
         document_metadata : typing.Optional[str]
+            JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
+
+            Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
+
 
-        relations : typing.Optional[str]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -190,7 +230,6 @@ class UploadClient:
             sub_tenant_id=sub_tenant_id,
             tenant_metadata=tenant_metadata,
             document_metadata=document_metadata,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -204,26 +243,41 @@ class UploadClient:
         sub_tenant_id: typing.Optional[str] = None,
         tenant_metadata: typing.Optional[str] = OMIT,
         document_metadata: typing.Optional[str] = OMIT,
-        relations: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
+        Replace an existing document with updated content.
+
+        This endpoint allows you to update a specific document that's already in your knowledge base. Provide the source ID of the document you want to modify, along with the new file content.
+
+        The system will process your update asynchronously and re-index the document with the new content. You can monitor the progress using the returned file ID.
+
         Parameters
         ----------
         source_id : str
+            The source ID of the document to update
 
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         file : core.File
             See core.File for more documentation
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         tenant_metadata : typing.Optional[str]
+            JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+
+            Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
+
 
         document_metadata : typing.Optional[str]
+            JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
+
+            Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
+
 
-        relations : typing.Optional[str]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -247,7 +301,6 @@ class UploadClient:
             sub_tenant_id=sub_tenant_id,
             tenant_metadata=tenant_metadata,
             document_metadata=document_metadata,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -261,13 +314,21 @@ class UploadClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AppSourcesUploadData:
         """
+        Upload structured data from applications or APIs for indexing.
+
+        This endpoint is designed for importing data from applications. If you are specifically using Cortex to provide search to an application, you should prefer this endpoint. It accepts structured source objects and allows you to clearly define contents of attachments
+
+        The system processes each source asynchronously and makes the content available for search and retrieval. Use this when you need to integrate search and indexing from data in your applications into your knowledge base.
+
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         request : typing.Sequence[SourceModel]
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -297,26 +358,36 @@ class UploadClient:
         sub_tenant_id: typing.Optional[str] = None,
         tenant_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         document_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
-        relations: typing.Optional[Relations] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
-        Upload markdown content. If request.document_metadata contains a 'file_id' key (non-empty), it will be used as the file ID;
-        otherwise, a new file_id will be generated for that file. This allows file-specific IDs to be set directly in the metadata.
+        Upload text or markdown content directly for processing.
+
+        This endpoint accepts plain text or markdown-formatted content that you want to add to your knowledge base. It's perfect for notes, documentation, articles, or any text-based content you want to make searchable.
+
+        You can include custom metadata to help organize and categorize your content. You can track the processing status using the returned file ID.
 
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         content : str
+            The text or markdown content to upload
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         tenant_metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+
+            Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
 
         document_metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
+
+            Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
 
-        relations : typing.Optional[Relations]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -339,7 +410,6 @@ class UploadClient:
             sub_tenant_id=sub_tenant_id,
             tenant_metadata=tenant_metadata,
             document_metadata=document_metadata,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -352,26 +422,36 @@ class UploadClient:
         sub_tenant_id: typing.Optional[str] = None,
         tenant_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         document_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
-        relations: typing.Optional[Relations] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
-        Upload markdown content. If request.document_metadata contains a 'file_id' key (non-empty), it will be used as the file ID;
-        otherwise, a new file_id will be generated for that file. This allows file-specific IDs to be set directly in the metadata.
+        Upload text or markdown content directly for processing.
+
+        This endpoint accepts plain text or markdown-formatted content that you want to add to your knowledge base. It's perfect for notes, documentation, articles, or any text-based content you want to make searchable.
+
+        You can include custom metadata to help organize and categorize your content. You can track the processing status using the returned file ID.
 
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         content : str
+            The text or markdown content to upload
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         tenant_metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+
+            Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
 
         document_metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
+
+            Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
 
-        relations : typing.Optional[Relations]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -394,7 +474,6 @@ class UploadClient:
             sub_tenant_id=sub_tenant_id,
             tenant_metadata=tenant_metadata,
             document_metadata=document_metadata,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -408,25 +487,39 @@ class UploadClient:
         sub_tenant_id: typing.Optional[str] = None,
         tenant_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         document_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
-        relations: typing.Optional[Relations] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
+        Update existing text or markdown content with new information.
+
+        This endpoint allows you to modify text or markdown content that's already in your knowledge base. Provide the source ID of the content you want to update, along with the new text.
+
+        The system will reprocess and re-index the updated content asynchronously. Use this when you need to correct information, add details, or refresh existing documentation.
+
         Parameters
         ----------
         source_id : str
+            The source ID of the document to update
 
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         content : str
+            The text or markdown content to upload
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         tenant_metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+
+            Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
 
         document_metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
+
+            Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
 
-        relations : typing.Optional[Relations]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -450,7 +543,6 @@ class UploadClient:
             sub_tenant_id=sub_tenant_id,
             tenant_metadata=tenant_metadata,
             document_metadata=document_metadata,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -464,25 +556,39 @@ class UploadClient:
         sub_tenant_id: typing.Optional[str] = None,
         tenant_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         document_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
-        relations: typing.Optional[Relations] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
+        Update existing text or markdown content with new information.
+
+        This endpoint allows you to modify text or markdown content that's already in your knowledge base. Provide the source ID of the content you want to update, along with the new text.
+
+        The system will reprocess and re-index the updated content asynchronously. Use this when you need to correct information, add details, or refresh existing documentation.
+
         Parameters
         ----------
         source_id : str
+            The source ID of the document to update
 
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         content : str
+            The text or markdown content to upload
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         tenant_metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+
+            Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
 
         document_metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
+
+            Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
 
-        relations : typing.Optional[Relations]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -506,7 +612,6 @@ class UploadClient:
             sub_tenant_id=sub_tenant_id,
             tenant_metadata=tenant_metadata,
             document_metadata=document_metadata,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -521,15 +626,25 @@ class UploadClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
+        Upload pre-computed embeddings for advanced similarity search.
+
+        This endpoint accepts vector embeddings that you've generated externally, allowing you to integrate with custom embedding models or existing vector databases. The embeddings represent chunks of your content as numerical vectors.
+
+        The system stores these embeddings and makes them available for semantic search and similarity matching. Use this when you want to leverage specialized embedding models or have existing vector representations.
+
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         embeddings : typing.Sequence[typing.Sequence[float]]
+            The embeddings of source you want to index
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         file_id : typing.Optional[str]
+            The Source ID of the target source you want to index
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -564,13 +679,22 @@ class UploadClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
+        Update existing embeddings with new vector representations.
+
+        This endpoint allows you to modify embeddings that are already stored in your knowledge base. Provide updated vector representations for specific chunks of content, identified by their chunk IDs.
+
+        The system will replace the existing embeddings with your new ones, ensuring that similarity searches reflect the most current vector representations. Use this when you need to update embeddings due to model improvements or content changes.
+
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         embeddings : typing.Optional[typing.Dict[str, typing.Sequence[float]]]
+            The embeddings of source you want to index
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -599,21 +723,28 @@ class UploadClient:
         tenant_id: str,
         sub_tenant_id: typing.Optional[str] = None,
         file_id: typing.Optional[str] = None,
-        relations: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
+        Extract and index content from web pages automatically.
+
+        This endpoint initiates web scraping for the specified URL, extracting the main content, text, and structure from the webpage. It's perfect for capturing articles, documentation, or any web content you want to include in your knowledge base.
+
+        The system processes the webpage content asynchronously, cleaning and structuring the information for optimal search and retrieval. Use this when you need to add web content without manual copying and pasting.
+
         Parameters
         ----------
         web_url : str
+            The URL of the webpage to scrape and index
 
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         file_id : typing.Optional[str]
-
-        relations : typing.Optional[str]
+            Optional custom file ID for the scraped content. If not provided, a unique ID will be generated
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -635,7 +766,6 @@ class UploadClient:
             tenant_id=tenant_id,
             sub_tenant_id=sub_tenant_id,
             file_id=file_id,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -647,21 +777,28 @@ class UploadClient:
         source_id: str,
         tenant_id: str,
         sub_tenant_id: typing.Optional[str] = None,
-        relations: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
+        Update web scraping content with fresh data from the source URL.
+
+        This endpoint refreshes the content for an existing web scraping job. Provide the source ID of the webpage content you want to update, and the system will re-scrape the URL to capture any changes.
+
+        The updated content gets processed asynchronously and re-indexed in your knowledge base. Use this to keep web content current when the source pages are frequently updated.
+
         Parameters
         ----------
         web_url : str
+            The URL of the webpage to re-scrape
 
         source_id : str
+            The file ID of the existing web scraping job to update
 
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         sub_tenant_id : typing.Optional[str]
-
-        relations : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -683,7 +820,6 @@ class UploadClient:
             source_id=source_id,
             tenant_id=tenant_id,
             sub_tenant_id=sub_tenant_id,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -697,13 +833,22 @@ class UploadClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Optional[typing.Any]:
         """
+        Remove documents and content from your knowledge base.
+
+        This endpoint permanently deletes the specified sources from your knowledge base. Once deleted, the content will no longer be available for search or retrieval.
+
+        Use this carefully as the action cannot be undone. The system will confirm successful deletion of each source ID you specify.
+
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         source_ids : typing.Sequence[str]
+            List of source IDs to delete
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -734,13 +879,22 @@ class UploadClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Optional[typing.Any]:
         """
+        Remove documents and content from your knowledge base.
+
+        This endpoint permanently deletes the specified sources from your knowledge base. Once deleted, the content will no longer be available for search or retrieval.
+
+        Use this carefully as the action cannot be undone. The system will confirm successful deletion of each source ID you specify.
+
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         source_ids : typing.Sequence[str]
+            List of source IDs to delete
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -770,16 +924,19 @@ class UploadClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ProcessingStatus:
         """
-        Verify the processing status of an uploaded file.
+        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.
 
-        Returns:
-            ProcessingStatusResponse: Processing status information
+        Use this to determine when your content is ready for search and retrieval, or to troubleshoot any processing issues.
 
         Parameters
         ----------
         file_id : str
+            The file ID to check processing status for
 
         tenant_id : typing.Optional[str]
+            Unique identifier for the tenant/organization
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -825,24 +982,38 @@ class AsyncUploadClient:
         sub_tenant_id: typing.Optional[str] = None,
         tenant_metadata: typing.Optional[str] = OMIT,
         document_metadata: typing.Optional[str] = OMIT,
-        relations: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> BatchUploadData:
         """
+        Upload multiple documents simultaneously for efficient bulk processing.
+
+        This endpoint allows you to upload several files at once, which is ideal for large document collections or periodic data imports. Each file gets processed asynchronously, and you can track the progress of individual files using their returned file IDs.
+
+        The system automatically handles file parsing, content extraction, and indexing across all uploaded documents. You'll receive confirmation once all files are queued for processing.
+
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         files : typing.List[core.File]
             See core.File for more documentation
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         tenant_metadata : typing.Optional[str]
+            JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+
+            Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
+
 
         document_metadata : typing.Optional[str]
+            JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
+
+            Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
+
 
-        relations : typing.Optional[str]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -869,7 +1040,6 @@ class AsyncUploadClient:
             sub_tenant_id=sub_tenant_id,
             tenant_metadata=tenant_metadata,
             document_metadata=document_metadata,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -883,26 +1053,41 @@ class AsyncUploadClient:
         source_ids: typing.Optional[typing.List[str]] = OMIT,
         tenant_metadata: typing.Optional[str] = OMIT,
         document_metadata: typing.Optional[str] = OMIT,
-        relations: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> BatchUploadData:
         """
+        Update multiple existing documents with new content and metadata.
+
+        Use this endpoint when you need to replace or modify several documents that are already in your knowledge base. Each file must correspond to an existing source ID, ensuring that updates are applied to the correct documents.
+
+        The system processes updates asynchronously, allowing you to continue working while your documents are re-indexed. Track the progress using the returned file IDs to know when updates are complete.
+
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         files : typing.List[core.File]
             See core.File for more documentation
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         source_ids : typing.Optional[typing.List[str]]
+            List of source IDs corresponding to the files being updated
 
         tenant_metadata : typing.Optional[str]
+            JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+
+            Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
+
 
         document_metadata : typing.Optional[str]
+            JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
+
+            Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
+
 
-        relations : typing.Optional[str]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -930,7 +1115,6 @@ class AsyncUploadClient:
             source_ids=source_ids,
             tenant_metadata=tenant_metadata,
             document_metadata=document_metadata,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -943,24 +1127,38 @@ class AsyncUploadClient:
         sub_tenant_id: typing.Optional[str] = None,
         tenant_metadata: typing.Optional[str] = OMIT,
         document_metadata: typing.Optional[str] = OMIT,
-        relations: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
+        Upload a single document for processing and indexing into your knowledge base.
+
+        This endpoint accepts documents in various formats and processes them for search and retrieval. You can include custom metadata to help organize and categorize your content.
+
+        The system extracts text content, processes it asynchronously, and makes it available for search queries. You can track the processing status using the returned file ID.
+
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         file : core.File
             See core.File for more documentation
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         tenant_metadata : typing.Optional[str]
+            JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+
+            Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
+
 
         document_metadata : typing.Optional[str]
+            JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
+
+            Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
+
 
-        relations : typing.Optional[str]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -987,7 +1185,6 @@ class AsyncUploadClient:
             sub_tenant_id=sub_tenant_id,
             tenant_metadata=tenant_metadata,
             document_metadata=document_metadata,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -1001,26 +1198,41 @@ class AsyncUploadClient:
         sub_tenant_id: typing.Optional[str] = None,
         tenant_metadata: typing.Optional[str] = OMIT,
         document_metadata: typing.Optional[str] = OMIT,
-        relations: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
+        Replace an existing document with updated content.
+
+        This endpoint allows you to update a specific document that's already in your knowledge base. Provide the source ID of the document you want to modify, along with the new file content.
+
+        The system will process your update asynchronously and re-index the document with the new content. You can monitor the progress using the returned file ID.
+
         Parameters
         ----------
         source_id : str
+            The source ID of the document to update
 
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         file : core.File
             See core.File for more documentation
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         tenant_metadata : typing.Optional[str]
+            JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+
+            Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
+
 
         document_metadata : typing.Optional[str]
+            JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
+
+            Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
+
 
-        relations : typing.Optional[str]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1048,7 +1260,6 @@ class AsyncUploadClient:
             sub_tenant_id=sub_tenant_id,
             tenant_metadata=tenant_metadata,
             document_metadata=document_metadata,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -1062,13 +1273,21 @@ class AsyncUploadClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AppSourcesUploadData:
         """
+        Upload structured data from applications or APIs for indexing.
+
+        This endpoint is designed for importing data from applications. If you are specifically using Cortex to provide search to an application, you should prefer this endpoint. It accepts structured source objects and allows you to clearly define contents of attachments
+
+        The system processes each source asynchronously and makes the content available for search and retrieval. Use this when you need to integrate search and indexing from data in your applications into your knowledge base.
+
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         request : typing.Sequence[SourceModel]
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1102,26 +1321,36 @@ class AsyncUploadClient:
         sub_tenant_id: typing.Optional[str] = None,
         tenant_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         document_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
-        relations: typing.Optional[Relations] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
-        Upload markdown content. If request.document_metadata contains a 'file_id' key (non-empty), it will be used as the file ID;
-        otherwise, a new file_id will be generated for that file. This allows file-specific IDs to be set directly in the metadata.
+        Upload text or markdown content directly for processing.
+
+        This endpoint accepts plain text or markdown-formatted content that you want to add to your knowledge base. It's perfect for notes, documentation, articles, or any text-based content you want to make searchable.
+
+        You can include custom metadata to help organize and categorize your content. You can track the processing status using the returned file ID.
 
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         content : str
+            The text or markdown content to upload
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         tenant_metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+
+            Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
 
         document_metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
+
+            Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
 
-        relations : typing.Optional[Relations]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1148,7 +1377,6 @@ class AsyncUploadClient:
             sub_tenant_id=sub_tenant_id,
             tenant_metadata=tenant_metadata,
             document_metadata=document_metadata,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -1161,26 +1389,36 @@ class AsyncUploadClient:
         sub_tenant_id: typing.Optional[str] = None,
         tenant_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         document_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
-        relations: typing.Optional[Relations] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
-        Upload markdown content. If request.document_metadata contains a 'file_id' key (non-empty), it will be used as the file ID;
-        otherwise, a new file_id will be generated for that file. This allows file-specific IDs to be set directly in the metadata.
+        Upload text or markdown content directly for processing.
+
+        This endpoint accepts plain text or markdown-formatted content that you want to add to your knowledge base. It's perfect for notes, documentation, articles, or any text-based content you want to make searchable.
+
+        You can include custom metadata to help organize and categorize your content. You can track the processing status using the returned file ID.
 
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         content : str
+            The text or markdown content to upload
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         tenant_metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+
+            Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
 
         document_metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
+
+            Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
 
-        relations : typing.Optional[Relations]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1207,7 +1445,6 @@ class AsyncUploadClient:
             sub_tenant_id=sub_tenant_id,
             tenant_metadata=tenant_metadata,
             document_metadata=document_metadata,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -1221,25 +1458,39 @@ class AsyncUploadClient:
         sub_tenant_id: typing.Optional[str] = None,
         tenant_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         document_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
-        relations: typing.Optional[Relations] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
+        Update existing text or markdown content with new information.
+
+        This endpoint allows you to modify text or markdown content that's already in your knowledge base. Provide the source ID of the content you want to update, along with the new text.
+
+        The system will reprocess and re-index the updated content asynchronously. Use this when you need to correct information, add details, or refresh existing documentation.
+
         Parameters
         ----------
         source_id : str
+            The source ID of the document to update
 
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         content : str
+            The text or markdown content to upload
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         tenant_metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+
+            Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
 
         document_metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
+
+            Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
 
-        relations : typing.Optional[Relations]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1267,7 +1518,6 @@ class AsyncUploadClient:
             sub_tenant_id=sub_tenant_id,
             tenant_metadata=tenant_metadata,
             document_metadata=document_metadata,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -1281,25 +1531,39 @@ class AsyncUploadClient:
         sub_tenant_id: typing.Optional[str] = None,
         tenant_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         document_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
-        relations: typing.Optional[Relations] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
+        Update existing text or markdown content with new information.
+
+        This endpoint allows you to modify text or markdown content that's already in your knowledge base. Provide the source ID of the content you want to update, along with the new text.
+
+        The system will reprocess and re-index the updated content asynchronously. Use this when you need to correct information, add details, or refresh existing documentation.
+
         Parameters
         ----------
         source_id : str
+            The source ID of the document to update
 
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         content : str
+            The text or markdown content to upload
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         tenant_metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
+
+            Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
 
         document_metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
+
+            Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
 
-        relations : typing.Optional[Relations]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1327,7 +1591,6 @@ class AsyncUploadClient:
             sub_tenant_id=sub_tenant_id,
             tenant_metadata=tenant_metadata,
             document_metadata=document_metadata,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -1342,15 +1605,25 @@ class AsyncUploadClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
+        Upload pre-computed embeddings for advanced similarity search.
+
+        This endpoint accepts vector embeddings that you've generated externally, allowing you to integrate with custom embedding models or existing vector databases. The embeddings represent chunks of your content as numerical vectors.
+
+        The system stores these embeddings and makes them available for semantic search and similarity matching. Use this when you want to leverage specialized embedding models or have existing vector representations.
+
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         embeddings : typing.Sequence[typing.Sequence[float]]
+            The embeddings of source you want to index
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         file_id : typing.Optional[str]
+            The Source ID of the target source you want to index
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1389,13 +1662,22 @@ class AsyncUploadClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
+        Update existing embeddings with new vector representations.
+
+        This endpoint allows you to modify embeddings that are already stored in your knowledge base. Provide updated vector representations for specific chunks of content, identified by their chunk IDs.
+
+        The system will replace the existing embeddings with your new ones, ensuring that similarity searches reflect the most current vector representations. Use this when you need to update embeddings due to model improvements or content changes.
+
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         embeddings : typing.Optional[typing.Dict[str, typing.Sequence[float]]]
+            The embeddings of source you want to index
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1428,21 +1710,28 @@ class AsyncUploadClient:
         tenant_id: str,
         sub_tenant_id: typing.Optional[str] = None,
         file_id: typing.Optional[str] = None,
-        relations: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
+        Extract and index content from web pages automatically.
+
+        This endpoint initiates web scraping for the specified URL, extracting the main content, text, and structure from the webpage. It's perfect for capturing articles, documentation, or any web content you want to include in your knowledge base.
+
+        The system processes the webpage content asynchronously, cleaning and structuring the information for optimal search and retrieval. Use this when you need to add web content without manual copying and pasting.
+
         Parameters
         ----------
         web_url : str
+            The URL of the webpage to scrape and index
 
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         file_id : typing.Optional[str]
-
-        relations : typing.Optional[str]
+            Optional custom file ID for the scraped content. If not provided, a unique ID will be generated
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1468,7 +1757,6 @@ class AsyncUploadClient:
             tenant_id=tenant_id,
             sub_tenant_id=sub_tenant_id,
             file_id=file_id,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -1480,21 +1768,28 @@ class AsyncUploadClient:
         source_id: str,
         tenant_id: str,
         sub_tenant_id: typing.Optional[str] = None,
-        relations: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SingleUploadData:
         """
+        Update web scraping content with fresh data from the source URL.
+
+        This endpoint refreshes the content for an existing web scraping job. Provide the source ID of the webpage content you want to update, and the system will re-scrape the URL to capture any changes.
+
+        The updated content gets processed asynchronously and re-indexed in your knowledge base. Use this to keep web content current when the source pages are frequently updated.
+
         Parameters
         ----------
         web_url : str
+            The URL of the webpage to re-scrape
 
         source_id : str
+            The file ID of the existing web scraping job to update
 
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         sub_tenant_id : typing.Optional[str]
-
-        relations : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1520,7 +1815,6 @@ class AsyncUploadClient:
             source_id=source_id,
             tenant_id=tenant_id,
             sub_tenant_id=sub_tenant_id,
-            relations=relations,
             request_options=request_options,
         )
         return _response.data
@@ -1534,13 +1828,22 @@ class AsyncUploadClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Optional[typing.Any]:
         """
+        Remove documents and content from your knowledge base.
+
+        This endpoint permanently deletes the specified sources from your knowledge base. Once deleted, the content will no longer be available for search or retrieval.
+
+        Use this carefully as the action cannot be undone. The system will confirm successful deletion of each source ID you specify.
+
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         source_ids : typing.Sequence[str]
+            List of source IDs to delete
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1575,13 +1878,22 @@ class AsyncUploadClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Optional[typing.Any]:
         """
+        Remove documents and content from your knowledge base.
+
+        This endpoint permanently deletes the specified sources from your knowledge base. Once deleted, the content will no longer be available for search or retrieval.
+
+        Use this carefully as the action cannot be undone. The system will confirm successful deletion of each source ID you specify.
+
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         source_ids : typing.Sequence[str]
+            List of source IDs to delete
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1615,16 +1927,19 @@ class AsyncUploadClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ProcessingStatus:
         """
-        Verify the processing status of an uploaded file.
+        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.
 
-        Returns:
-            ProcessingStatusResponse: Processing status information
+        Use this to determine when your content is ready for search and retrieval, or to troubleshoot any processing issues.
 
         Parameters
         ----------
         file_id : str
+            The file ID to check processing status for
 
         tenant_id : typing.Optional[str]
+            Unique identifier for the tenant/organization
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.