usecortex-ai 0.3.6__py3-none-any.whl → 0.5.0__py3-none-any.whl

usecortex_ai/types/source_fetch_response.py

@@ -0,0 +1,70 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+
+
+class SourceFetchResponse(UniversalBaseModel):
+    """
+    Response for file fetch request.
+    """
+
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether the fetch was successful
+    """
+
+    source_id: str = pydantic.Field()
+    """
+    Source ID of the fetched file
+    """
+
+    content: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    File content as string (if mode includes 'content')
+    """
+
+    content_base_64: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="content_base64")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    File content as base64 encoded string (for binary files, if mode includes 'content')
+    """
+
+    presigned_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Presigned URL to access the file (if mode includes 'url')
+    """
+
+    content_type: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Content type of the file
+    """
+
+    size_bytes: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Size of the file in bytes
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Response message
+    """
+
+    error: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Error message if fetch failed
+    """
+
+    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/{graph_relations_response.py → source_graph_relations_response.py}

@@ -4,11 +4,11 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .triple_with_evidence import TripleWithEvidence
+from .triplet_with_evidence import TripletWithEvidence
 
 
-class GraphRelationsResponse(UniversalBaseModel):
-    relations: typing.List[typing.Optional[TripleWithEvidence]] = pydantic.Field()
+class SourceGraphRelationsResponse(UniversalBaseModel):
+    relations: typing.List[typing.Optional[TripletWithEvidence]] = pydantic.Field()
     """
     List of relations retrieved
     """

usecortex_ai/types/{single_upload_data.py → source_list_response.py}

@@ -4,21 +4,18 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .source_model import SourceModel
 
 
-class SingleUploadData(UniversalBaseModel):
-    file_id: str = pydantic.Field()
-    """
-    Unique identifier for the file being processed
-    """
-
-    message: str = pydantic.Field()
+class SourceListResponse(UniversalBaseModel):
+    success: typing.Optional[bool] = None
+    message: typing.Optional[str] = None
+    sources: typing.Optional[typing.List[SourceModel]] = None
+    total: int = pydantic.Field()
     """
-    Status message indicating document parsing scheduled or update completed
+    Total number of sources matching the query.
     """
 
-    success: typing.Optional[bool] = 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/source_model.py

@@ -9,11 +9,21 @@ from .content_model import ContentModel
 
 
 class SourceModel(UniversalBaseModel):
-    id: typing.Optional[str] = pydantic.Field(default=None)
+    id: str = pydantic.Field()
     """
     Stable, unique identifier for the source. If omitted, one may be generated upstream.
     """
 
+    tenant_id: str = pydantic.Field()
+    """
+    Unique identifier for the tenant/organization
+    """
+
+    sub_tenant_id: str = pydantic.Field()
+    """
+    Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
+    """
+
     title: typing.Optional[str] = pydantic.Field(default=None)
     """
     Short human-readable title for the source.

usecortex_ai/types/source_status.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+SourceStatus = typing.Union[typing.Literal["queued", "processing", "completed", "failed"], typing.Any]

usecortex_ai/types/source_upload_response.py

@@ -0,0 +1,35 @@
+# 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 .source_upload_result_item import SourceUploadResultItem
+
+
+class SourceUploadResponse(UniversalBaseModel):
+    success: typing.Optional[bool] = None
+    message: typing.Optional[str] = None
+    results: typing.Optional[typing.List[SourceUploadResultItem]] = pydantic.Field(default=None)
+    """
+    List of upload results for each source.
+    """
+
+    success_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of sources successfully queued.
+    """
+
+    failed_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of sources that failed to upload.
+    """
+
+    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/source_upload_result_item.py

@@ -0,0 +1,38 @@
+# 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 .source_status import SourceStatus
+
+
+class SourceUploadResultItem(UniversalBaseModel):
+    source_id: str = pydantic.Field()
+    """
+    Unique identifier for the uploaded source.
+    """
+
+    filename: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Original filename if present.
+    """
+
+    status: typing.Optional[SourceStatus] = pydantic.Field(default=None)
+    """
+    Initial processing status.
+    """
+
+    error: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Error message if upload failed.
+    """
+
+    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/supported_llm_providers.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+SupportedLlmProviders = typing.Union[typing.Literal["groq", "cerebras", "openai", "anthropic", "gemini"], typing.Any]

usecortex_ai/types/{embeddings_create_collection_data.py → tenant_create_response.py}

@@ -4,27 +4,29 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .infra import Infra
+from .tenant_metadata_schema_info import TenantMetadataSchemaInfo
 
 
-class EmbeddingsCreateCollectionData(UniversalBaseModel):
+class TenantCreateResponse(UniversalBaseModel):
     tenant_id: str = pydantic.Field()
     """
-    Identifier for the tenant/organization
+    Identifier provided by user
     """
 
-    sub_tenant_id: str = pydantic.Field()
+    infra: Infra = pydantic.Field()
     """
-    Identifier for the sub-tenant within the tenant
+    Infra status
     """
 
-    success: typing.Optional[bool] = pydantic.Field(default=None)
+    metadata_schema: typing.Optional[TenantMetadataSchemaInfo] = pydantic.Field(default=None)
     """
-    Indicates whether the embeddings tenant creation completed successfully
+    Summary of configured tenant metadata schema (if provided)
     """
 
     message: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Status message about the tenant creation operation
+    Summary message
     """
 
     if IS_PYDANTIC_V2:

usecortex_ai/types/{webpage_scrape_request.py → tenant_info.py}

@@ -6,15 +6,20 @@ import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
-class WebpageScrapeRequest(UniversalBaseModel):
-    web_url: str = pydantic.Field()
+class TenantInfo(UniversalBaseModel):
+    tenant_id: str = pydantic.Field()
     """
-    The URL of the webpage to scrape and index
+    Organization tenant ID
     """
 
-    file_id: typing.Optional[str] = pydantic.Field(default=None)
+    organisation: str = pydantic.Field()
     """
-    Optional custom file ID for the scraped content. If not provided, a unique ID will be generated
+    Organization name
+    """
+
+    timestamp: str = pydantic.Field()
+    """
+    Creation timestamp
     """
 
     if IS_PYDANTIC_V2:

usecortex_ai/types/tenant_metadata_schema_info.py

@@ -0,0 +1,36 @@
+# 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 TenantMetadataSchemaInfo(UniversalBaseModel):
+    """
+    Summary of configured tenant metadata schema fields.
+    """
+
+    field_count: int = pydantic.Field()
+    """
+    Number of custom metadata fields configured
+    """
+
+    dense_embedding_fields: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Fields with dense embeddings enabled for semantic search
+    """
+
+    sparse_embedding_fields: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Fields with sparse embeddings enabled for keyword search
+    """
+
+    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/{tenant_create_data.py → tenant_stats_response.py}

@@ -4,27 +4,28 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .collection_stats import CollectionStats
 
 
-class TenantCreateData(UniversalBaseModel):
-    status: str = pydantic.Field()
+class TenantStatsResponse(UniversalBaseModel):
+    tenant_id: str = pydantic.Field()
     """
-    Current status of the tenant creation process
+    Tenant identifier
     """
 
-    tenant_id: str = pydantic.Field()
+    normal_collection: CollectionStats = pydantic.Field()
     """
-    Unique identifier assigned to the new tenant
+    Statistics for the normal (context) collection
     """
 
-    success: typing.Optional[bool] = pydantic.Field(default=None)
+    memory_collection: CollectionStats = pydantic.Field()
     """
-    Indicates whether the tenant creation was successful
+    Statistics for the memory collection
     """
 
     message: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Response message describing the creation result
+    Summary message
     """
 
     if IS_PYDANTIC_V2:

usecortex_ai/types/{triple_with_evidence.py → triplet_with_evidence.py}

@@ -8,7 +8,11 @@ from .entity import Entity
 from .relation_evidence import RelationEvidence
 
 
-class TripleWithEvidence(UniversalBaseModel):
+class TripletWithEvidence(UniversalBaseModel):
+    """
+    Triple with multiple evidence items from different chunks
+    """
+
     source: Entity
     target: Entity
     relations: typing.List[RelationEvidence] = pydantic.Field()

usecortex_ai/types/user_assistant_pair.py

@@ -7,6 +7,10 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class UserAssistantPair(UniversalBaseModel):
+    """
+    Represents a user-assistant conversation pair.
+    """
+
     user: str = pydantic.Field()
     """
     User's message in the conversation

usecortex_ai/types/{search_chunk.py → vector_store_chunk.py}

@@ -4,10 +4,9 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .extended_context import ExtendedContext
 
 
-class SearchChunk(UniversalBaseModel):
+class VectorStoreChunk(UniversalBaseModel):
     chunk_uuid: str = pydantic.Field()
     """
     Unique identifier for this content chunk
@@ -45,12 +44,12 @@ class SearchChunk(UniversalBaseModel):
 
     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)
+    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
+    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)
@@ -63,14 +62,9 @@ class SearchChunk(UniversalBaseModel):
     Custom metadata associated with your tenant
     """
 
-    extra_context: typing.Optional[ExtendedContext] = pydantic.Field(default=None)
+    extra_context_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
     """
-    Additional context for this chunk
-    """
-
-    graph_triplet_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
-    """
-    List of group IDs for triplets linked to this chunk. Lookup triplet data in graph_relations.chunk_relations[group_id]
+    IDs of related chunks providing extra context (from forceful relations). Only present in accurate mode when sources have forceful relations.
     """
 
     if IS_PYDANTIC_V2:

usecortex_ai/upload/__init__.py

@@ -2,3 +2,6 @@
 
 # isort: skip_file
 
+from .types import BodyUploadAppIngestionUploadAppPostAppSources
+
+__all__ = ["BodyUploadAppIngestionUploadAppPostAppSources"]