usecortex-ai 0.4.0__py3-none-any.whl → 0.5.1__py3-none-any.whl

usecortex_ai/tenant/raw_client.py

@@ -38,47 +38,6 @@ class RawTenantClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[TenantCreateResponse]:
         """
-        Create a tenant for your account.
-
-        Use this endpoint to initialize a tenant space you can use for ingestion, embeddings, and search.
-
-        **Tenant Metadata Schema**
-
-        You can optionally provide a `tenant_metadata_schema` to define custom fields that will be
-        indexed in the vector store. Each field can be configured with:
-
-        - `enable_match`: Enable text filtering on this field
-        - `enable_dense_embedding`: Create dense embeddings for semantic similarity search
-        - `enable_sparse_embedding`: Create sparse embeddings (BM25) for keyword search
-
-        **Example Request:**
-        ```json
-        {
-            "tenant_id": "my-tenant",
-            "tenant_metadata_schema": [
-                {
-                    "name": "category",
-                    "data_type": "VARCHAR",
-                    "max_length": 256,
-                    "enable_match": true
-                },
-                {
-                    "name": "product_description",
-                    "data_type": "VARCHAR",
-                    "max_length": 4096,
-                    "enable_dense_embedding": true,
-                    "enable_sparse_embedding": true
-                }
-            ]
-        }
-        ```
-
-        Expected outcome:
-        - A tenant is created and returned with its identifier.
-        - If tenant_metadata_schema is provided, the vector store collection will include
-          the specified custom fields with their configured search capabilities.
-        - If the tenant already exists, you receive a success message with the existing identifier.
-
         Parameters
         ----------
         tenant_id : str
@@ -216,17 +175,6 @@ class RawTenantClient:
         self, *, tenant_id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[TenantStatsResponse]:
         """
-        Retrieve usage stats for your tenant.
-
-        Use this endpoint to check whether a tenant exists and view core metrics like total
-        indexed objects and vector dimension. This helps you validate
-        setup and monitor ingestion.
-
-        Expected outcome
-
-        You receive the current object count and vector dimension for the tenant.
-        If the tenant does not exist, you get a not-found error.
-
         Parameters
         ----------
         tenant_id : str
@@ -241,7 +189,7 @@ class RawTenantClient:
             Successful Response
         """
         _response = self._client_wrapper.httpx_client.request(
-            "tenants/stats",
+            "tenants/monitor",
             method="GET",
             params={
                 "tenant_id": tenant_id,
@@ -355,47 +303,6 @@ class AsyncRawTenantClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[TenantCreateResponse]:
         """
-        Create a tenant for your account.
-
-        Use this endpoint to initialize a tenant space you can use for ingestion, embeddings, and search.
-
-        **Tenant Metadata Schema**
-
-        You can optionally provide a `tenant_metadata_schema` to define custom fields that will be
-        indexed in the vector store. Each field can be configured with:
-
-        - `enable_match`: Enable text filtering on this field
-        - `enable_dense_embedding`: Create dense embeddings for semantic similarity search
-        - `enable_sparse_embedding`: Create sparse embeddings (BM25) for keyword search
-
-        **Example Request:**
-        ```json
-        {
-            "tenant_id": "my-tenant",
-            "tenant_metadata_schema": [
-                {
-                    "name": "category",
-                    "data_type": "VARCHAR",
-                    "max_length": 256,
-                    "enable_match": true
-                },
-                {
-                    "name": "product_description",
-                    "data_type": "VARCHAR",
-                    "max_length": 4096,
-                    "enable_dense_embedding": true,
-                    "enable_sparse_embedding": true
-                }
-            ]
-        }
-        ```
-
-        Expected outcome:
-        - A tenant is created and returned with its identifier.
-        - If tenant_metadata_schema is provided, the vector store collection will include
-          the specified custom fields with their configured search capabilities.
-        - If the tenant already exists, you receive a success message with the existing identifier.
-
         Parameters
         ----------
         tenant_id : str
@@ -533,17 +440,6 @@ class AsyncRawTenantClient:
         self, *, tenant_id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[TenantStatsResponse]:
         """
-        Retrieve usage stats for your tenant.
-
-        Use this endpoint to check whether a tenant exists and view core metrics like total
-        indexed objects and vector dimension. This helps you validate
-        setup and monitor ingestion.
-
-        Expected outcome
-
-        You receive the current object count and vector dimension for the tenant.
-        If the tenant does not exist, you get a not-found error.
-
         Parameters
         ----------
         tenant_id : str
@@ -558,7 +454,7 @@ class AsyncRawTenantClient:
             Successful Response
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "tenants/stats",
+            "tenants/monitor",
             method="GET",
             params={
                 "tenant_id": tenant_id,

usecortex_ai/types/__init__.py

@@ -5,7 +5,6 @@
 from .actual_error_response import ActualErrorResponse
 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 .bm_25_operator_type import Bm25OperatorType
 from .collection_stats import CollectionStats
@@ -19,10 +18,13 @@ from .delete_user_memory_response import DeleteUserMemoryResponse
 from .entity import Entity
 from .error_response import ErrorResponse
 from .fetch_mode import FetchMode
+from .forceful_relations_payload import ForcefulRelationsPayload
 from .graph_context import GraphContext
 from .http_validation_error import HttpValidationError
 from .infra import Infra
 from .insert_result import InsertResult
+from .list_content_kind import ListContentKind
+from .list_user_memories_response import ListUserMemoriesResponse
 from .memory_item import MemoryItem
 from .memory_result_item import MemoryResultItem
 from .milvus_data_type import MilvusDataType
@@ -54,6 +56,7 @@ 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 .vector_store_chunk import VectorStoreChunk
@@ -62,7 +65,6 @@ __all__ = [
     "ActualErrorResponse",
     "AddMemoryResponse",
     "ApiKeyInfo",
-    "AppSourcesUploadData",
     "AttachmentModel",
     "Bm25OperatorType",
     "CollectionStats",
@@ -76,10 +78,13 @@ __all__ = [
     "Entity",
     "ErrorResponse",
     "FetchMode",
+    "ForcefulRelationsPayload",
     "GraphContext",
     "HttpValidationError",
     "Infra",
     "InsertResult",
+    "ListContentKind",
+    "ListUserMemoriesResponse",
     "MemoryItem",
     "MemoryResultItem",
     "MilvusDataType",
@@ -111,6 +116,7 @@ __all__ = [
     "TenantStatsResponse",
     "TripletWithEvidence",
     "UserAssistantPair",
+    "UserMemory",
     "ValidationError",
     "ValidationErrorLocItem",
     "VectorStoreChunk",

usecortex_ai/types/forceful_relations_payload.py

@@ -0,0 +1,27 @@
+# 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 ForcefulRelationsPayload(UniversalBaseModel):
+    cortex_source_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Cortex source IDs to forcefully relate to the uploaded source.
+    """
+
+    properties: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    Optional properties to attach to the forceful relation.
+    """
+
+    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_content_kind.py

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

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: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    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/memory_item.py

@@ -4,6 +4,7 @@ import typing
 
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .forceful_relations_payload import ForcefulRelationsPayload
 from .user_assistant_pair import UserAssistantPair
 
 
@@ -40,7 +41,7 @@ class MemoryItem(UniversalBaseModel):
 
     infer: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    If true, process and extract additional insights/inferences from the content before indexing. Useful for extracting implicit information from conversations.
+    If true, process and extract additional insights/inferences from the contentbefore indexingUseful for extracting implicit information from conversations
     """
 
     custom_instructions: typing.Optional[str] = pydantic.Field(default=None)
@@ -72,6 +73,11 @@ class MemoryItem(UniversalBaseModel):
     Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
     """
 
+    relations: typing.Optional[ForcefulRelationsPayload] = pydantic.Field(default=None)
+    """
+    Forcefully connect 2 sources based on cortex source ids or common properties.
+    """
+
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
     else:

usecortex_ai/types/retrieval_result.py

@@ -15,6 +15,10 @@ class RetrievalResult(UniversalBaseModel):
 
     chunks: typing.Optional[typing.List[VectorStoreChunk]] = None
     graph_context: typing.Optional[GraphContext] = None
+    additional_context: typing.Optional[typing.Dict[str, VectorStoreChunk]] = pydantic.Field(default=None)
+    """
+    Map of chunk_uuid to VectorStoreChunk for extra context from forcefully related sources. Use chunk.extra_context_ids to look up chunks: extra_context[id] for id in chunk.extra_context_ids.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

usecortex_ai/types/retrieve_mode.py

@@ -2,4 +2,4 @@
 
 import typing
 
-RetrieveMode = typing.Union[typing.Literal["fast", "accurate"], typing.Any]
+RetrieveMode = typing.Union[typing.Literal["fast", "thinking"], typing.Any]

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

usecortex_ai/types/vector_store_chunk.py

@@ -62,6 +62,11 @@ class VectorStoreChunk(UniversalBaseModel):
     Custom metadata associated with your tenant
     """
 
+    extra_context_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    IDs of related chunks providing extra context (from forceful relations). Only present in accurate mode when sources have forceful relations.
+    """
+
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
     else:

usecortex_ai/upload/__init__.py

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