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

usecortex_ai/types/search_chunk.py

@@ -4,26 +4,63 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .extended_context import ExtendedContext
 
 
 class SearchChunk(UniversalBaseModel):
-    chunk_uuid: str
-    source_id: str
-    chunk_content: str
-    source_type: typing.Optional[str] = None
-    source_upload_time: typing.Optional[str] = None
-    source_title: typing.Optional[str] = None
-    source_last_updated_time: typing.Optional[str] = None
-    source_collection: typing.Optional[typing.List[str]] = None
-    layout: typing.Optional[str] = None
-    source_url: typing.Optional[str] = None
-    version: typing.Optional[str] = None
-    relevancy_score: typing.Optional[float] = None
-    cortex_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
-    document_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
-    tenant_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
-    extra_context: typing.Optional[ExtendedContext] = None
+    chunk_uuid: str = pydantic.Field()
+    """
+    Unique identifier for this content chunk
+    """
+
+    source_id: str = pydantic.Field()
+    """
+    Unique identifier for the source document
+    """
+
+    chunk_content: str = pydantic.Field()
+    """
+    The actual text content of this chunk
+    """
+
+    source_type: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Type of the source document (file, webpage, etc.)
+    """
+
+    source_upload_time: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    When the source document was originally uploaded
+    """
+
+    source_title: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Title or name of the source document
+    """
+
+    source_last_updated_time: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    When the source document was last modified
+    """
+
+    layout: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Layout of the chunk in original document. You will generally receive a stringified dict with 2 keys, `offsets` and `page`(optional). Offsets will have `document_level_start_index` and `page_level_start_index`(optional)
+    """
+
+    relevancy_score: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Score indicating how relevant this chunk is to your search query, with higher values indicating better matches
+    """
+
+    document_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    Metadata extracted from the source document
+    """
+
+    tenant_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    Custom metadata associated with your tenant
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/single_upload_data.py

@@ -7,9 +7,17 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class SingleUploadData(UniversalBaseModel):
-    file_id: str
+    file_id: str = pydantic.Field()
+    """
+    Unique identifier for the file being processed
+    """
+
+    message: str = pydantic.Field()
+    """
+    Status message indicating document parsing scheduled or update completed
+    """
+
     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/source.py

@@ -4,24 +4,43 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .source_content import SourceContent
 
 
 class Source(UniversalBaseModel):
-    id: str
-    title: str
-    type: str
-    timestamp: str
-    content: SourceContent
-    collections: typing.Optional[typing.List[str]] = None
-    description: typing.Optional[str] = None
-    note: typing.Optional[str] = None
-    url: typing.Optional[str] = None
-    cortex_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
-    document_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
-    tenant_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
-    meta: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
-    attachments: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None
+    id: str = pydantic.Field()
+    """
+    Unique identifier for the source document
+    """
+
+    title: str = pydantic.Field()
+    """
+    Display title of the source document
+    """
+
+    type: str = pydantic.Field()
+    """
+    Type of content (document, file, text, etc.)
+    """
+
+    timestamp: str = pydantic.Field()
+    """
+    When the source was originally created or uploaded
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Brief summary or description of the source content
+    """
+
+    document_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    Additional metadata specific to the document
+    """
+
+    tenant_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    Metadata related to the tenant and organizational context
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/source_model.py

@@ -9,20 +9,69 @@ from .content_model import ContentModel
 
 
 class SourceModel(UniversalBaseModel):
-    collections: typing.Optional[typing.List[str]] = None
-    id: typing.Optional[str] = None
-    title: typing.Optional[str] = None
-    type: typing.Optional[str] = None
-    description: typing.Optional[str] = None
-    note: typing.Optional[str] = None
-    url: typing.Optional[str] = None
-    timestamp: typing.Optional[str] = None
-    content: typing.Optional[ContentModel] = None
-    cortex_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
-    tenant_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
-    document_metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
-    meta: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
-    attachments: typing.Optional[typing.List[AttachmentModel]] = None
+    id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Stable, unique identifier for the source. If omitted, one may be generated upstream.
+    """
+
+    title: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Short human-readable title for the source.
+    """
+
+    type: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    High-level category of the source (e.g., document, email, ticket).
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Optional long-form description providing additional context.
+    """
+
+    note: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Free-form notes for internal use or ingestion hints.
+    """
+
+    url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Canonical URL or reference link associated with the source.
+    """
+
+    timestamp: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Creation or last-updated timestamp of the source in ISO-8601 format.
+    """
+
+    content: typing.Optional[ContentModel] = pydantic.Field(default=None)
+    """
+    Primary content payload used for indexing and retrieval.
+    """
+
+    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"}"
+    """
+
+    meta: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    System-provided attributes (e.g., app_name, local file size) not intended for search filtering.
+    """
+
+    attachments: typing.Optional[typing.List[AttachmentModel]] = pydantic.Field(default=None)
+    """
+    Attachments related to the source such as images, PDFs, or supplemental files.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/sub_tenant_ids_data.py

@@ -7,11 +7,35 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class SubTenantIdsData(UniversalBaseModel):
-    collection_name: str
-    sub_tenant_ids: typing.List[str]
-    count: int
-    success: typing.Optional[bool] = None
-    message: typing.Optional[str] = None
+    tenant_id: str = pydantic.Field()
+    """
+    The tenant ID that was queried
+    """
+
+    sub_tenant_ids: typing.List[str] = pydantic.Field()
+    """
+    Array of all sub-tenant IDs within the tenant
+    """
+
+    count: int = pydantic.Field()
+    """
+    Total number of sub-tenants found
+    """
+
+    tenant_schema: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    Schema configuration for the tenant collection
+    """
+
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the sub-tenant retrieval 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/tenant_create_data.py

@@ -7,10 +7,25 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class TenantCreateData(UniversalBaseModel):
-    status: str
-    tenant_id: str
-    success: typing.Optional[bool] = None
-    message: typing.Optional[str] = None
+    status: str = pydantic.Field()
+    """
+    Current status of the tenant creation process
+    """
+
+    tenant_id: str = pydantic.Field()
+    """
+    Unique identifier assigned to the new tenant
+    """
+
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the tenant creation was successful
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Response message describing the creation result
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/tenant_stats.py

@@ -7,11 +7,30 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class TenantStats(UniversalBaseModel):
-    object_count: int
-    tenant_name: str
-    vector_dimension: typing.Optional[int] = None
-    success: typing.Optional[bool] = None
-    message: typing.Optional[str] = None
+    object_count: int = pydantic.Field()
+    """
+    Total number of objects stored for this tenant
+    """
+
+    tenant_id: str = pydantic.Field()
+    """
+    identifier for the tenant
+    """
+
+    vector_dimension: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Dimensions of the vector embeddings used for this tenant. Null when the tenant is empty.
+    """
+
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the stats retrieval 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/user_memory.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 UserMemory(UniversalBaseModel):
+    """
+    Represents a user memory stored in the system.
+    """
+
+    memory_id: str = pydantic.Field()
+    """
+    Unique identifier for the user memory
+    """
+
+    memory_content: str = pydantic.Field()
+    """
+    The actual memory content text that was stored
+    """
+
+    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