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

usecortex_ai/types/attachment_model.py

@@ -8,13 +8,40 @@ from .content_model import ContentModel
 
 
 class AttachmentModel(UniversalBaseModel):
-    id: typing.Optional[str] = None
-    url: typing.Optional[str] = None
-    title: typing.Optional[str] = None
-    content_type: typing.Optional[str] = None
-    content_url: typing.Optional[str] = None
-    misc: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
-    content: typing.Optional[ContentModel] = None
+    id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier for the attachment.
+    """
+
+    url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Public or internal URL referencing the attachment resource.
+    """
+
+    title: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Human-readable title or filename of the attachment.
+    """
+
+    content_type: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    MIME type of the attachment (e.g., application/pdf).
+    """
+
+    content_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Direct URL for content retrieval when different from the reference URL.
+    """
+
+    misc: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    Additional attachment attributes defined by the tenant (free-form).
+    """
+
+    content: typing.Optional[ContentModel] = pydantic.Field(default=None)
+    """
+    Structured content payload for the attachment when available.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/batch_upload_data.py

@@ -8,9 +8,17 @@ from .file_upload_result import FileUploadResult
 
 
 class BatchUploadData(UniversalBaseModel):
-    uploaded: typing.List[FileUploadResult]
+    uploaded: typing.List[FileUploadResult] = pydantic.Field()
+    """
+    List of successfully uploaded files for processing
+    """
+
+    message: str = pydantic.Field()
+    """
+    Status message indicating batch document parsing scheduled
+    """
+
     success: typing.Optional[bool] = None
-    message: typing.Optional[str] = None
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/body_scrape_webpage_upload_scrape_webpage_post.py

@@ -7,8 +7,6 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class BodyScrapeWebpageUploadScrapeWebpagePost(UniversalBaseModel):
-    relations: typing.Optional[str] = None
-
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
     else:

usecortex_ai/types/body_update_scrape_job_upload_update_webpage_patch.py

@@ -7,8 +7,6 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class BodyUpdateScrapeJobUploadUpdateWebpagePatch(UniversalBaseModel):
-    relations: typing.Optional[str] = None
-
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
     else:

usecortex_ai/types/content_model.py

@@ -9,12 +9,39 @@ from ..core.serialization import FieldMetadata
 
 
 class ContentModel(UniversalBaseModel):
-    text: typing.Optional[str] = None
-    html_base_64: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="html_base64")] = None
-    csv_base_64: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="csv_base64")] = None
-    markdown: typing.Optional[str] = None
-    files: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = None
-    layout: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = None
+    text: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Plain text content extracted or provided for indexing.
+    """
+
+    html_base_64: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="html_base64")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Base64-encoded HTML content preserving structure and formatting.
+    """
+
+    csv_base_64: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="csv_base64")] = pydantic.Field(
+        default=None
+    )
+    """
+    Base64-encoded CSV data for tabular content ingestion.
+    """
+
+    markdown: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Raw Markdown content to be indexed as rich text.
+    """
+
+    files: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = pydantic.Field(default=None)
+    """
+    List of file descriptors associated with the source (e.g., filenames, sizes).
+    """
+
+    layout: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = pydantic.Field(default=None)
+    """
+    Optional layout metadata such as sections or blocks to guide chunking.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/delete_memory_request.py

@@ -7,9 +7,20 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class DeleteMemoryRequest(UniversalBaseModel):
-    tenant_id: str
-    source_ids: typing.List[str]
-    sub_tenant_id: typing.Optional[str] = None
+    tenant_id: str = pydantic.Field()
+    """
+    Unique identifier for the tenant/organization
+    """
+
+    source_ids: typing.List[str] = pydantic.Field()
+    """
+    List of source IDs to delete
+    """
+
+    sub_tenant_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/delete_sources.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class DeleteSources(UniversalBaseModel):
+    success: typing.Optional[bool] = None
+    message: typing.Optional[str] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

usecortex_ai/types/delete_sub_tenant_data.py

@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class DeleteSubTenantData(UniversalBaseModel):
+    status: str = pydantic.Field()
+    """
+    The status of the deletion operation.
+    """
+
+    tenant_id: str = pydantic.Field()
+    """
+    The tenant ID from which the sub-tenant was deleted.
+    """
+
+    sub_tenant_id: str = pydantic.Field()
+    """
+    The ID of the sub-tenant that was deleted.
+    """
+
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the sub-tenant deletion was successful.
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Response message describing the operation result.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

usecortex_ai/types/delete_user_memory_response.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class DeleteUserMemoryResponse(UniversalBaseModel):
+    """
+    Response model for deleting a user memory.
+    """
+
+    success: bool = pydantic.Field()
+    """
+    Indicates whether the memory deletion operation was successful
+    """
+
+    user_memory_deleted: bool = pydantic.Field()
+    """
+    Confirms whether the specific memory was successfully deleted
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

usecortex_ai/types/embeddings_create_collection_data.py

@@ -7,10 +7,25 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class EmbeddingsCreateCollectionData(UniversalBaseModel):
-    tenant_id: str
-    sub_tenant_id: str
-    success: typing.Optional[bool] = None
-    message: typing.Optional[str] = None
+    tenant_id: str = pydantic.Field()
+    """
+    Identifier for the tenant/organization
+    """
+
+    sub_tenant_id: str = pydantic.Field()
+    """
+    Identifier for the sub-tenant within the tenant
+    """
+
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the embeddings tenant creation completed successfully
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Status message about the tenant creation operation
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/embeddings_delete_data.py

@@ -7,10 +7,25 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class EmbeddingsDeleteData(UniversalBaseModel):
-    total_deleted: int
-    status: typing.Dict[str, bool]
-    success: typing.Optional[bool] = None
-    message: typing.Optional[str] = None
+    total_deleted: int = pydantic.Field()
+    """
+    Total number of embeddings that were successfully deleted
+    """
+
+    status: typing.Dict[str, bool] = pydantic.Field()
+    """
+    Dictionary mapping chunk IDs to their deletion status (true if deleted successfully). Example: {'chunk_1234': true}
+    """
+
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the embeddings deletion operation completed successfully
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Status message about the deletion operation
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/embeddings_get_data.py

@@ -7,10 +7,25 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class EmbeddingsGetData(UniversalBaseModel):
-    embeddings: typing.Dict[str, typing.List[float]]
-    not_found_chunk_ids: typing.List[str]
-    success: typing.Optional[bool] = None
-    message: typing.Optional[str] = None
+    embeddings: typing.Dict[str, typing.List[float]] = pydantic.Field()
+    """
+    Dictionary mapping chunk IDs to their embedding vectors (lists of float values)
+    """
+
+    not_found_chunk_ids: typing.List[str] = pydantic.Field()
+    """
+    List of chunk IDs that were not found in the embeddings collection
+    """
+
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the embeddings retrieval operation completed successfully
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Status message about the retrieval operation
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/embeddings_search_data.py

@@ -7,10 +7,25 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class EmbeddingsSearchData(UniversalBaseModel):
-    chunk_ids: typing.List[str]
-    scores: typing.List[float]
-    success: typing.Optional[bool] = None
-    message: typing.Optional[str] = None
+    chunk_ids: typing.List[str] = pydantic.Field()
+    """
+    List of chunk IDs that match the search query
+    """
+
+    scores: typing.List[float] = pydantic.Field()
+    """
+    Similarity scores for each matching chunk (higher is more similar)
+    """
+
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the embeddings search operation completed successfully
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Status message about the search operation
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/error_response.py

@@ -10,7 +10,6 @@ class ErrorResponse(UniversalBaseModel):
     success: typing.Optional[bool] = None
     message: typing.Optional[str] = None
     error_code: typing.Optional[str] = None
-    data: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/fetch_content_data.py

@@ -7,11 +7,25 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class FetchContentData(UniversalBaseModel):
-    file_id: str
-    url: str
-    file_content: typing.Optional[str] = None
-    success: typing.Optional[bool] = None
-    message: typing.Optional[str] = None
+    file_id: str = pydantic.Field()
+    """
+    Unique identifier for the file being fetched
+    """
+
+    file_content: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Content of the fetched file
+    """
+
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the fetch operation completed successfully
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Status message about the fetch operation
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/file_upload_result.py

@@ -7,8 +7,15 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class FileUploadResult(UniversalBaseModel):
-    file_id: str
-    filename: typing.Optional[str] = None
+    file_id: str = pydantic.Field()
+    """
+    Unique identifier for the file being processed
+    """
+
+    filename: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Name of the uploaded file, if provided
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/generate_user_memory_response.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .user_memory import UserMemory
+
+
+class GenerateUserMemoryResponse(UniversalBaseModel):
+    """
+    Response model for AI-generated user memories.
+    """
+
+    success: bool = pydantic.Field()
+    """
+    Indicates whether the memory generation operation was successful
+    """
+
+    generated_user_memories: typing.Optional[typing.List[UserMemory]] = pydantic.Field(default=None)
+    """
+    Array of AI-generated memories based on your query and user context
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

usecortex_ai/types/list_sources_response.py

@@ -8,9 +8,20 @@ from .source import Source
 
 
 class ListSourcesResponse(UniversalBaseModel):
-    sources: typing.List[typing.Optional[Source]]
-    success: typing.Optional[bool] = None
-    message: typing.Optional[str] = None
+    sources: typing.List[typing.Optional[Source]] = pydantic.Field()
+    """
+    List of source documents retrieved
+    """
+
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the request was successful
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Response message describing the operation result
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/list_user_memories_response.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .user_memory import UserMemory
+
+
+class ListUserMemoriesResponse(UniversalBaseModel):
+    """
+    Response model for listing all user memories.
+    """
+
+    success: bool = pydantic.Field()
+    """
+    Indicates whether the memory listing operation was successful
+    """
+
+    user_memories: typing.Optional[typing.List[UserMemory]] = pydantic.Field(default=None)
+    """
+    Array of all user memories associated with your tenant
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

usecortex_ai/types/markdown_upload_request.py

@@ -4,14 +4,32 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .relations import Relations
 
 
 class MarkdownUploadRequest(UniversalBaseModel):
-    content: str
-    tenant_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
-    document_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
-    relations: typing.Optional[Relations] = None
+    content: str = pydantic.Field()
+    """
+    The text or markdown content to upload
+    """
+
+    file_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Optional file ID for the uploaded content. If not provided, will be generated automatically.
+    """
+
+    tenant_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    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]]] = pydantic.Field(default=None)
+    """
+    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"}"
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/processing_status.py

@@ -7,10 +7,21 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class ProcessingStatus(UniversalBaseModel):
-    file_id: str
-    indexing_status: str
+    file_id: str = pydantic.Field()
+    """
+    Identifier for the file whose status is being retrieved
+    """
+
+    indexing_status: str = pydantic.Field()
+    """
+    Current status of the file. Possible values are 'queued', 'processing', 'completed', 'failed'
+    """
+
     success: typing.Optional[bool] = None
-    message: typing.Optional[str] = None
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Detailed status message about the processing operation
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/relations.py

@@ -7,8 +7,15 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class Relations(UniversalBaseModel):
-    cortex_source_ids: typing.Optional[typing.List[str]] = None
-    auto_discovery: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+    cortex_source_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    List of cortex source IDs to directly relate with
+    """
+
+    auto_discovery: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    Key value pairs to allow cortex to automatically discover relations
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/retrieve_user_memory_response.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .user_memory import UserMemory
+
+
+class RetrieveUserMemoryResponse(UniversalBaseModel):
+    """
+    Response model for retrieving user memories through semantic search.
+    """
+
+    success: bool = pydantic.Field()
+    """
+    Indicates whether the memory retrieval operation was successful
+    """
+
+    retrieved_user_memories: typing.Optional[typing.List[UserMemory]] = pydantic.Field(default=None)
+    """
+    Array of user memories ranked by relevance to your search query
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow