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

usecortex_ai/types/__init__.py

@@ -3,107 +3,117 @@
 # isort: skip_file
 
 from .actual_error_response import ActualErrorResponse
-from .add_user_memory_response import AddUserMemoryResponse
+from .add_memory_response import AddMemoryResponse
+from .api_key_info import ApiKeyInfo
 from .app_sources_upload_data import AppSourcesUploadData
 from .attachment_model import AttachmentModel
-from .batch_upload_data import BatchUploadData
 from .bm_25_operator_type import Bm25OperatorType
-from .body_scrape_webpage_upload_scrape_webpage_post import BodyScrapeWebpageUploadScrapeWebpagePost
-from .body_update_scrape_job_upload_update_webpage_patch import BodyUpdateScrapeJobUploadUpdateWebpagePatch
-from .chunk_graph_relations_response import ChunkGraphRelationsResponse
+from .collection_stats import CollectionStats
 from .content_model import ContentModel
-from .delete_memory_request import DeleteMemoryRequest
-from .delete_sources import DeleteSources
-from .delete_sub_tenant_data import DeleteSubTenantData
+from .custom_property_definition import CustomPropertyDefinition
+from .dashboard_apis_response import DashboardApisResponse
+from .dashboard_sources_response import DashboardSourcesResponse
+from .dashboard_tenants_response import DashboardTenantsResponse
+from .delete_result import DeleteResult
 from .delete_user_memory_response import DeleteUserMemoryResponse
-from .embeddings_create_collection_data import EmbeddingsCreateCollectionData
-from .embeddings_delete_data import EmbeddingsDeleteData
-from .embeddings_get_data import EmbeddingsGetData
-from .embeddings_search_data import EmbeddingsSearchData
 from .entity import Entity
 from .error_response import ErrorResponse
-from .extended_context import ExtendedContext
-from .fetch_content_data import FetchContentData
-from .file_upload_result import FileUploadResult
-from .graph_relations_response import GraphRelationsResponse
+from .fetch_mode import FetchMode
+from .forceful_relations_payload import ForcefulRelationsPayload
+from .graph_context import GraphContext
 from .http_validation_error import HttpValidationError
-from .list_sources_response import ListSourcesResponse
-from .list_user_memories_response import ListUserMemoriesResponse
-from .markdown_upload_request import MarkdownUploadRequest
+from .infra import Infra
+from .insert_result import InsertResult
+from .memory_item import MemoryItem
+from .memory_result_item import MemoryResultItem
+from .milvus_data_type import MilvusDataType
 from .path_triplet import PathTriplet
 from .processing_status import ProcessingStatus
-from .related_chunk import RelatedChunk
+from .processing_status_indexing_status import ProcessingStatusIndexingStatus
+from .qn_a_search_response import QnASearchResponse
+from .raw_embedding_document import RawEmbeddingDocument
+from .raw_embedding_search_result import RawEmbeddingSearchResult
+from .raw_embedding_vector import RawEmbeddingVector
 from .relation_evidence import RelationEvidence
-from .relations import Relations
+from .retrieval_result import RetrievalResult
 from .retrieve_mode import RetrieveMode
-from .retrieve_response import RetrieveResponse
-from .retrieve_user_memory_response import RetrieveUserMemoryResponse
 from .scored_path_response import ScoredPathResponse
-from .scored_triplet_response import ScoredTripletResponse
-from .search_chunk import SearchChunk
-from .single_upload_data import SingleUploadData
-from .source import Source
+from .search_mode import SearchMode
+from .source_delete_response import SourceDeleteResponse
+from .source_delete_result_item import SourceDeleteResultItem
+from .source_fetch_response import SourceFetchResponse
+from .source_graph_relations_response import SourceGraphRelationsResponse
+from .source_list_response import SourceListResponse
 from .source_model import SourceModel
-from .sub_tenant_ids_data import SubTenantIdsData
-from .tenant_create_data import TenantCreateData
-from .tenant_stats import TenantStats
-from .triple_with_evidence import TripleWithEvidence
+from .source_status import SourceStatus
+from .source_upload_response import SourceUploadResponse
+from .source_upload_result_item import SourceUploadResultItem
+from .supported_llm_providers import SupportedLlmProviders
+from .tenant_create_response import TenantCreateResponse
+from .tenant_info import TenantInfo
+from .tenant_metadata_schema_info import TenantMetadataSchemaInfo
+from .tenant_stats_response import TenantStatsResponse
+from .triplet_with_evidence import TripletWithEvidence
 from .user_assistant_pair import UserAssistantPair
-from .user_memory import UserMemory
 from .validation_error import ValidationError
 from .validation_error_loc_item import ValidationErrorLocItem
-from .webpage_scrape_request import WebpageScrapeRequest
+from .vector_store_chunk import VectorStoreChunk
 
 __all__ = [
     "ActualErrorResponse",
-    "AddUserMemoryResponse",
+    "AddMemoryResponse",
+    "ApiKeyInfo",
     "AppSourcesUploadData",
     "AttachmentModel",
-    "BatchUploadData",
     "Bm25OperatorType",
-    "BodyScrapeWebpageUploadScrapeWebpagePost",
-    "BodyUpdateScrapeJobUploadUpdateWebpagePatch",
-    "ChunkGraphRelationsResponse",
+    "CollectionStats",
     "ContentModel",
-    "DeleteMemoryRequest",
-    "DeleteSources",
-    "DeleteSubTenantData",
+    "CustomPropertyDefinition",
+    "DashboardApisResponse",
+    "DashboardSourcesResponse",
+    "DashboardTenantsResponse",
+    "DeleteResult",
     "DeleteUserMemoryResponse",
-    "EmbeddingsCreateCollectionData",
-    "EmbeddingsDeleteData",
-    "EmbeddingsGetData",
-    "EmbeddingsSearchData",
     "Entity",
     "ErrorResponse",
-    "ExtendedContext",
-    "FetchContentData",
-    "FileUploadResult",
-    "GraphRelationsResponse",
+    "FetchMode",
+    "ForcefulRelationsPayload",
+    "GraphContext",
     "HttpValidationError",
-    "ListSourcesResponse",
-    "ListUserMemoriesResponse",
-    "MarkdownUploadRequest",
+    "Infra",
+    "InsertResult",
+    "MemoryItem",
+    "MemoryResultItem",
+    "MilvusDataType",
     "PathTriplet",
     "ProcessingStatus",
-    "RelatedChunk",
+    "ProcessingStatusIndexingStatus",
+    "QnASearchResponse",
+    "RawEmbeddingDocument",
+    "RawEmbeddingSearchResult",
+    "RawEmbeddingVector",
     "RelationEvidence",
-    "Relations",
+    "RetrievalResult",
     "RetrieveMode",
-    "RetrieveResponse",
-    "RetrieveUserMemoryResponse",
     "ScoredPathResponse",
-    "ScoredTripletResponse",
-    "SearchChunk",
-    "SingleUploadData",
-    "Source",
+    "SearchMode",
+    "SourceDeleteResponse",
+    "SourceDeleteResultItem",
+    "SourceFetchResponse",
+    "SourceGraphRelationsResponse",
+    "SourceListResponse",
     "SourceModel",
-    "SubTenantIdsData",
-    "TenantCreateData",
-    "TenantStats",
-    "TripleWithEvidence",
+    "SourceStatus",
+    "SourceUploadResponse",
+    "SourceUploadResultItem",
+    "SupportedLlmProviders",
+    "TenantCreateResponse",
+    "TenantInfo",
+    "TenantMetadataSchemaInfo",
+    "TenantStatsResponse",
+    "TripletWithEvidence",
     "UserAssistantPair",
-    "UserMemory",
     "ValidationError",
     "ValidationErrorLocItem",
-    "WebpageScrapeRequest",
+    "VectorStoreChunk",
 ]

usecortex_ai/types/add_memory_response.py

@@ -0,0 +1,39 @@
+# 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 .memory_result_item import MemoryResultItem
+
+
+class AddMemoryResponse(UniversalBaseModel):
+    """
+    Response model for add_memory endpoint.
+    """
+
+    success: typing.Optional[bool] = None
+    message: typing.Optional[str] = None
+    results: typing.Optional[typing.List[MemoryResultItem]] = pydantic.Field(default=None)
+    """
+    List of results for each ingested memory item.
+    """
+
+    success_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of items successfully queued for ingestion.
+    """
+
+    failed_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of items that failed to queue.
+    """
+
+    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/{scored_triplet_response.py → api_key_info.py}

@@ -4,33 +4,37 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .entity import Entity
-from .relation_evidence import RelationEvidence
 
 
-class ScoredTripletResponse(UniversalBaseModel):
+class ApiKeyInfo(UniversalBaseModel):
+    api_key_id: str = pydantic.Field()
     """
-    Individual scored triplet for entity-based search results
+    API key identifier
     """
 
-    source: Entity = pydantic.Field()
+    user_email: str = pydantic.Field()
     """
-    Source entity
+    Owner email
     """
 
-    target: Entity = pydantic.Field()
+    user_id: str = pydantic.Field()
     """
-    Target entity
+    User ID
     """
 
-    relation: RelationEvidence = pydantic.Field()
+    scopes: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
     """
-    Relation between entities
+    API key scopes
     """
 
-    relevancy_score: typing.Optional[float] = pydantic.Field(default=None)
+    is_valid: bool = pydantic.Field()
     """
-    Relevancy score from reranking
+    Whether the API key is valid
+    """
+
+    created_at: str = pydantic.Field()
+    """
+    Creation timestamp
     """
 
     if IS_PYDANTIC_V2:

usecortex_ai/types/app_sources_upload_data.py

@@ -4,21 +4,30 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .file_upload_result import FileUploadResult
+from .source_upload_result_item import SourceUploadResultItem
 
 
 class AppSourcesUploadData(UniversalBaseModel):
-    uploaded: typing.List[FileUploadResult] = pydantic.Field()
     """
-    List of successfully uploaded app source for indexing
+    Response model for uploads of app-generated sources.
     """
 
-    message: str = pydantic.Field()
+    success: typing.Optional[bool] = None
+    message: typing.Optional[str] = None
+    results: typing.Optional[typing.List[SourceUploadResultItem]] = pydantic.Field(default=None)
     """
-    Status message indicating app sources upload scheduled
+    List of upload results for each source.
     """
 
-    success: typing.Optional[bool] = None
+    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

usecortex_ai/types/{file_upload_result.py → collection_stats.py}

@@ -6,15 +6,15 @@ import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
-class FileUploadResult(UniversalBaseModel):
-    file_id: str = pydantic.Field()
+class CollectionStats(UniversalBaseModel):
+    row_count: int = pydantic.Field()
     """
-    Unique identifier for the file being processed
+    Number of rows in the collection
     """
 
-    filename: typing.Optional[str] = pydantic.Field(default=None)
+    dimensions: int = pydantic.Field()
     """
-    Name of the uploaded file, if provided
+    Number of dimensions in the collection
     """
 
     if IS_PYDANTIC_V2:

usecortex_ai/types/custom_property_definition.py

@@ -0,0 +1,75 @@
+# 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 .milvus_data_type import MilvusDataType
+
+
+class CustomPropertyDefinition(UniversalBaseModel):
+    """
+    Definition for custom/dynamic properties on a collection.
+
+    Use this to define tenant metadata fields that can enhance search capabilities:
+    - enable_dense_embedding: Creates a dense vector field for semantic similarity search
+    - enable_sparse_embedding: Creates a sparse vector field for BM25 keyword search
+
+    Example:
+        CustomPropertyDefinition(
+            name="product_description",
+            data_type=MilvusDataType.VARCHAR,
+            max_length=4096,
+            enable_dense_embedding=True,  # Enables semantic search on this field
+            enable_sparse_embedding=True,  # Enables keyword search on this field
+        )
+    """
+
+    name: str = pydantic.Field()
+    """
+    Property name (used as field name in Milvus)
+    """
+
+    data_type: typing.Optional[MilvusDataType] = pydantic.Field(default=None)
+    """
+    Milvus data type. Use VARCHAR for text fields that need embeddings.
+    """
+
+    max_length: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Max length for VARCHAR fields. Increase for longer text content.
+    """
+
+    enable_analyzer: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Enable text analyzer for full-text search capabilities
+    """
+
+    enable_match: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Enable TEXT_MATCH filtering on this field
+    """
+
+    enable_dense_embedding: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Create a dense embedding field (FLOAT_VECTOR) for semantic similarity search. Only applicable to VARCHAR fields. A corresponding '{name}_embedding' field will be created.
+    """
+
+    enable_sparse_embedding: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Create a sparse embedding field (BM25) for keyword search. Only applicable to VARCHAR fields. A corresponding '{name}_sparse' field and BM25 function will be created.
+    """
+
+    nullable: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether field can be null
+    """
+
+    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/dashboard_apis_response.py

@@ -0,0 +1,33 @@
+# 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 .api_key_info import ApiKeyInfo
+
+
+class DashboardApisResponse(UniversalBaseModel):
+    api_keys: typing.Optional[typing.List[ApiKeyInfo]] = pydantic.Field(default=None)
+    """
+    List of API keys
+    """
+
+    count: int = pydantic.Field()
+    """
+    Total number of API keys
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Response message
+    """
+
+    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/dashboard_sources_response.py

@@ -0,0 +1,33 @@
+# 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_model import SourceModel
+
+
+class DashboardSourcesResponse(UniversalBaseModel):
+    sources: typing.Optional[typing.List[SourceModel]] = pydantic.Field(default=None)
+    """
+    List of sources
+    """
+
+    count: int = pydantic.Field()
+    """
+    Total number of sources
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Response message
+    """
+
+    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/dashboard_tenants_response.py

@@ -0,0 +1,33 @@
+# 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 .tenant_info import TenantInfo
+
+
+class DashboardTenantsResponse(UniversalBaseModel):
+    tenants: typing.Optional[typing.List[TenantInfo]] = pydantic.Field(default=None)
+    """
+    List of tenants
+    """
+
+    count: int = pydantic.Field()
+    """
+    Total number of tenants
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Response message
+    """
+
+    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 → delete_result.py}

@@ -4,23 +4,26 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from .source import Source
 
 
-class ListSourcesResponse(UniversalBaseModel):
-    sources: typing.List[typing.Optional[Source]] = pydantic.Field()
+class DeleteResult(UniversalBaseModel):
     """
-    List of source documents retrieved
+    Result of a delete operation.
+    """
+
+    delete_count: int = pydantic.Field()
+    """
+    Number of entities deleted
     """
 
     success: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Indicates whether the request was successful
+    Whether delete succeeded
     """
 
-    message: typing.Optional[str] = pydantic.Field(default=None)
+    error: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Response message describing the operation result
+    Error message if failed
     """
 
     if IS_PYDANTIC_V2:

usecortex_ai/types/delete_user_memory_response.py

@@ -11,7 +11,7 @@ class DeleteUserMemoryResponse(UniversalBaseModel):
     Response model for deleting a user memory.
     """
 
-    success: bool = pydantic.Field()
+    success: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Indicates whether the memory deletion operation was successful
     """

usecortex_ai/types/entity.py

@@ -22,14 +22,14 @@ class Entity(UniversalBaseModel):
     Context category like 'employees', 'projects'
     """
 
-    identifier: typing.Optional[str] = pydantic.Field(default=None)
+    entity_id: str = pydantic.Field()
     """
-    Unique ID like email, employee_id, URL
+    Internal unique entity ID from graph database
     """
 
-    entity_id: typing.Optional[str] = pydantic.Field(default=None)
+    identifier: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Internal unique entity ID from graph database
+    Unique ID like email, employee_id, URL
     """
 
     if IS_PYDANTIC_V2:

usecortex_ai/types/fetch_mode.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+FetchMode = typing.Union[typing.Literal["content", "url", "both"], typing.Any]

usecortex_ai/types/{relations.py → forceful_relations_payload.py}

@@ -6,15 +6,15 @@ import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
-class Relations(UniversalBaseModel):
+class ForcefulRelationsPayload(UniversalBaseModel):
     cortex_source_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
     """
-    List of cortex source IDs to directly relate with
+    Cortex source IDs to forcefully relate to the uploaded source.
     """
 
-    auto_discovery: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    properties: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
     """
-    Key value pairs to allow cortex to automatically discover relations
+    Optional properties to attach to the forceful relation.
     """
 
     if IS_PYDANTIC_V2:

usecortex_ai/types/graph_context.py

@@ -0,0 +1,26 @@
+# 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 .scored_path_response import ScoredPathResponse
+
+
+class GraphContext(UniversalBaseModel):
+    """
+    Graph context containing query-based paths and chunk-based relation paths.
+    """
+
+    query_paths: typing.Optional[typing.List[ScoredPathResponse]] = None
+    chunk_relations: typing.Optional[typing.List[ScoredPathResponse]] = None
+    chunk_id_to_group_ids: typing.Optional[typing.Dict[str, typing.List[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_sources.py → infra.py}

@@ -6,9 +6,10 @@ import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
-class DeleteSources(UniversalBaseModel):
-    success: typing.Optional[bool] = None
-    message: typing.Optional[str] = None
+class Infra(UniversalBaseModel):
+    scheduler_status: bool
+    graph_status: bool
+    vectorstore_status: typing.List[typing.Optional[typing.Any]]
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2