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

usecortex_ai/tenant/client.py

@@ -4,11 +4,14 @@ import typing
 
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
-from ..types.delete_sub_tenant_data import DeleteSubTenantData
-from ..types.sub_tenant_ids_data import SubTenantIdsData
-from ..types.tenant_stats import TenantStats
+from ..types.custom_property_definition import CustomPropertyDefinition
+from ..types.tenant_create_response import TenantCreateResponse
+from ..types.tenant_stats_response import TenantStatsResponse
 from .raw_client import AsyncRawTenantClient, RawTenantClient
 
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
 
 class TenantClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
@@ -25,36 +28,77 @@ class TenantClient:
         """
         return self._raw_client
 
-    def stats(
+    def create_tenant(
         self,
         *,
         tenant_id: str,
-        sub_tenant_id: typing.Optional[str] = None,
+        is_embeddings_tenant: typing.Optional[bool] = OMIT,
+        embeddings_dimension: typing.Optional[int] = OMIT,
+        tenant_metadata_schema: typing.Optional[typing.Sequence[CustomPropertyDefinition]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> TenantStats:
+    ) -> TenantCreateResponse:
         """
-        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.
+        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
-            Unique identifier for the tenant/organization
+            Unique tenant identifier
+
+        is_embeddings_tenant : typing.Optional[bool]
+            True to create embeddings tenant
 
-        sub_tenant_id : typing.Optional[str]
-            Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
+        embeddings_dimension : typing.Optional[int]
+            Embedding dimensions for embeddings tenant. Not required for non-embeddings (is_embeddings_tenant=False) tenants
+
+        tenant_metadata_schema : typing.Optional[typing.Sequence[CustomPropertyDefinition]]
+            Schema definition for tenant metadata fields. Each field can be configured for: filtering (enable_match), semantic search (enable_dense_embedding), and/or keyword search (enable_sparse_embedding). Fields with embeddings enabled must be VARCHAR type.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        TenantStats
+        TenantCreateResponse
             Successful Response
 
         Examples
@@ -62,62 +106,41 @@ class TenantClient:
         from usecortex-ai import CortexAI
 
         client = CortexAI(token="YOUR_TOKEN", )
-        client.tenant.stats(tenant_id='tenant_1234', sub_tenant_id='sub_tenant_4567', )
+        client.tenant.create_tenant(tenant_id='tenant_id', )
         """
-        _response = self._raw_client.stats(
-            tenant_id=tenant_id, sub_tenant_id=sub_tenant_id, request_options=request_options
+        _response = self._raw_client.create_tenant(
+            tenant_id=tenant_id,
+            is_embeddings_tenant=is_embeddings_tenant,
+            embeddings_dimension=embeddings_dimension,
+            tenant_metadata_schema=tenant_metadata_schema,
+            request_options=request_options,
         )
         return _response.data
 
-    def get_sub_tenant_ids(
-        self, *, tenant_id: str, request_options: typing.Optional[RequestOptions] = None
-    ) -> SubTenantIdsData:
+    def stats(self, *, tenant_id: str, request_options: typing.Optional[RequestOptions] = None) -> TenantStatsResponse:
         """
-        Retrieve all sub-tenant IDs contained within a specific tenant. Fetches the sub-tenant IDs directly from the underlying data store.
-
-        Parameters
-        ----------
-        tenant_id : str
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        SubTenantIdsData
-            Successful Response
+        Retrieve usage stats for your tenant.
 
-        Examples
-        --------
-        from usecortex-ai import CortexAI
+        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.
 
-        client = CortexAI(token="YOUR_TOKEN", )
-        client.tenant.get_sub_tenant_ids(tenant_id='tenant_1234', )
-        """
-        _response = self._raw_client.get_sub_tenant_ids(tenant_id=tenant_id, request_options=request_options)
-        return _response.data
-
-    def delete_sub_tenant(
-        self, *, tenant_id: str, sub_tenant_id: str, request_options: typing.Optional[RequestOptions] = None
-    ) -> DeleteSubTenantData:
-        """
-        Delete a sub-tenant from a given tenant.
+        Expected outcome
 
-        This endpoint deletes a specific sub-tenant from the specified tenant.
-        It validates that the sub-tenant is not the primary/default sub-tenant before deletion.
+        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
-
-        sub_tenant_id : str
+            Unique identifier for the tenant/organization
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        DeleteSubTenantData
+        TenantStatsResponse
             Successful Response
 
         Examples
@@ -125,11 +148,9 @@ class TenantClient:
         from usecortex-ai import CortexAI
 
         client = CortexAI(token="YOUR_TOKEN", )
-        client.tenant.delete_sub_tenant(tenant_id='tenant_1234', sub_tenant_id='sub_tenant_4567', )
+        client.tenant.stats(tenant_id='tenant_id', )
         """
-        _response = self._raw_client.delete_sub_tenant(
-            tenant_id=tenant_id, sub_tenant_id=sub_tenant_id, request_options=request_options
-        )
+        _response = self._raw_client.stats(tenant_id=tenant_id, request_options=request_options)
         return _response.data
 
 
@@ -148,36 +169,77 @@ class AsyncTenantClient:
         """
         return self._raw_client
 
-    async def stats(
+    async def create_tenant(
         self,
         *,
         tenant_id: str,
-        sub_tenant_id: typing.Optional[str] = None,
+        is_embeddings_tenant: typing.Optional[bool] = OMIT,
+        embeddings_dimension: typing.Optional[int] = OMIT,
+        tenant_metadata_schema: typing.Optional[typing.Sequence[CustomPropertyDefinition]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> TenantStats:
+    ) -> TenantCreateResponse:
         """
-        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.
+        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
-            Unique identifier for the tenant/organization
+            Unique tenant identifier
+
+        is_embeddings_tenant : typing.Optional[bool]
+            True to create embeddings tenant
 
-        sub_tenant_id : typing.Optional[str]
-            Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
+        embeddings_dimension : typing.Optional[int]
+            Embedding dimensions for embeddings tenant. Not required for non-embeddings (is_embeddings_tenant=False) tenants
+
+        tenant_metadata_schema : typing.Optional[typing.Sequence[CustomPropertyDefinition]]
+            Schema definition for tenant metadata fields. Each field can be configured for: filtering (enable_match), semantic search (enable_dense_embedding), and/or keyword search (enable_sparse_embedding). Fields with embeddings enabled must be VARCHAR type.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        TenantStats
+        TenantCreateResponse
             Successful Response
 
         Examples
@@ -188,67 +250,44 @@ class AsyncTenantClient:
 
         client = AsyncCortexAI(token="YOUR_TOKEN", )
         async def main() -> None:
-            await client.tenant.stats(tenant_id='tenant_1234', sub_tenant_id='sub_tenant_4567', )
+            await client.tenant.create_tenant(tenant_id='tenant_id', )
         asyncio.run(main())
         """
-        _response = await self._raw_client.stats(
-            tenant_id=tenant_id, sub_tenant_id=sub_tenant_id, request_options=request_options
+        _response = await self._raw_client.create_tenant(
+            tenant_id=tenant_id,
+            is_embeddings_tenant=is_embeddings_tenant,
+            embeddings_dimension=embeddings_dimension,
+            tenant_metadata_schema=tenant_metadata_schema,
+            request_options=request_options,
         )
         return _response.data
 
-    async def get_sub_tenant_ids(
+    async def stats(
         self, *, tenant_id: str, request_options: typing.Optional[RequestOptions] = None
-    ) -> SubTenantIdsData:
+    ) -> TenantStatsResponse:
         """
-        Retrieve all sub-tenant IDs contained within a specific tenant. Fetches the sub-tenant IDs directly from the underlying data store.
-
-        Parameters
-        ----------
-        tenant_id : str
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        SubTenantIdsData
-            Successful Response
+        Retrieve usage stats for your tenant.
 
-        Examples
-        --------
-        import asyncio
+        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.
 
-        from usecortex-ai import AsyncCortexAI
-
-        client = AsyncCortexAI(token="YOUR_TOKEN", )
-        async def main() -> None:
-            await client.tenant.get_sub_tenant_ids(tenant_id='tenant_1234', )
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.get_sub_tenant_ids(tenant_id=tenant_id, request_options=request_options)
-        return _response.data
-
-    async def delete_sub_tenant(
-        self, *, tenant_id: str, sub_tenant_id: str, request_options: typing.Optional[RequestOptions] = None
-    ) -> DeleteSubTenantData:
-        """
-        Delete a sub-tenant from a given tenant.
+        Expected outcome
 
-        This endpoint deletes a specific sub-tenant from the specified tenant.
-        It validates that the sub-tenant is not the primary/default sub-tenant before deletion.
+        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
-
-        sub_tenant_id : str
+            Unique identifier for the tenant/organization
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        DeleteSubTenantData
+        TenantStatsResponse
             Successful Response
 
         Examples
@@ -259,10 +298,8 @@ class AsyncTenantClient:
 
         client = AsyncCortexAI(token="YOUR_TOKEN", )
         async def main() -> None:
-            await client.tenant.delete_sub_tenant(tenant_id='tenant_1234', sub_tenant_id='sub_tenant_4567', )
+            await client.tenant.stats(tenant_id='tenant_id', )
         asyncio.run(main())
         """
-        _response = await self._raw_client.delete_sub_tenant(
-            tenant_id=tenant_id, sub_tenant_id=sub_tenant_id, request_options=request_options
-        )
+        _response = await self._raw_client.stats(tenant_id=tenant_id, request_options=request_options)
         return _response.data