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

usecortex_ai/sources/raw_client.py

@@ -17,7 +17,6 @@ from ..errors.unauthorized_error import UnauthorizedError
 from ..errors.unprocessable_entity_error import UnprocessableEntityError
 from ..types.actual_error_response import ActualErrorResponse
 from ..types.list_sources_response import ListSourcesResponse
-from ..types.sub_tenant_ids_data import SubTenantIdsData
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -35,11 +34,19 @@ class RawSourcesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[ListSourcesResponse]:
         """
+        Retrieve all sources for a specific tenant.
+
+        Use this endpoint to fetch a complete list of all sources associated with your tenant. This includes documents, files, and other content you've uploaded for processing.
+
+        You can optionally specify a sub-tenant to narrow down the results to sources within that specific sub-tenant scope.
+
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -158,6 +165,12 @@ class RawSourcesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[ListSourcesResponse]:
         """
+        Retrieve specific sources by their IDs.
+
+        Use this endpoint to fetch one or more sources by providing their unique identifiers. This is useful when you need detailed information about specific documents or content you've previously uploaded.
+
+        Provide the source IDs in the request body along with your tenant information to get the exact sources you need.
+
         Parameters
         ----------
         tenant_id : str
@@ -277,135 +290,6 @@ class RawSourcesClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
-    def get_sub_tenant_ids(
-        self, *, tenant_id: str, request_options: typing.Optional[RequestOptions] = None
-    ) -> HttpResponse[SubTenantIdsData]:
-        """
-        Get all sub-tenant IDs (tenant IDs) contained within a specific Weaviate collection.
-        Fetches the tenant IDs directly from Weaviate using default cluster credentials.
-
-        Args:
-            tenant_id: The tenant ID to fetch sub-tenant IDs for
-            api_details: Authentication dependency
-
-        Returns:
-            SubTenantIdsData: Contains collection_name, sub_tenant_ids list, count, and success message
-
-        Example:
-            GET /list/sub_tenant_ids?tenant_id=my_tenant_123
-
-        Parameters
-        ----------
-        tenant_id : str
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        HttpResponse[SubTenantIdsData]
-            Successful Response
-        """
-        _response = self._client_wrapper.httpx_client.request(
-            "list/sub_tenant_ids",
-            method="GET",
-            params={
-                "tenant_id": tenant_id,
-            },
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                _data = typing.cast(
-                    SubTenantIdsData,
-                    parse_obj_as(
-                        type_=SubTenantIdsData,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-                return HttpResponse(response=_response, data=_data)
-            if _response.status_code == 400:
-                raise BadRequestError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        ActualErrorResponse,
-                        parse_obj_as(
-                            type_=ActualErrorResponse,  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            if _response.status_code == 401:
-                raise UnauthorizedError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        ActualErrorResponse,
-                        parse_obj_as(
-                            type_=ActualErrorResponse,  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            if _response.status_code == 403:
-                raise ForbiddenError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        ActualErrorResponse,
-                        parse_obj_as(
-                            type_=ActualErrorResponse,  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            if _response.status_code == 404:
-                raise NotFoundError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        ActualErrorResponse,
-                        parse_obj_as(
-                            type_=ActualErrorResponse,  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            if _response.status_code == 422:
-                raise UnprocessableEntityError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            if _response.status_code == 500:
-                raise InternalServerError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        ActualErrorResponse,
-                        parse_obj_as(
-                            type_=ActualErrorResponse,  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            if _response.status_code == 503:
-                raise ServiceUnavailableError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        ActualErrorResponse,
-                        parse_obj_as(
-                            type_=ActualErrorResponse,  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            _response_json = _response.json()
-        except JSONDecodeError:
-            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
-        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
-
 
 class AsyncRawSourcesClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -419,11 +303,19 @@ class AsyncRawSourcesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[ListSourcesResponse]:
         """
+        Retrieve all sources for a specific tenant.
+
+        Use this endpoint to fetch a complete list of all sources associated with your tenant. This includes documents, files, and other content you've uploaded for processing.
+
+        You can optionally specify a sub-tenant to narrow down the results to sources within that specific sub-tenant scope.
+
         Parameters
         ----------
         tenant_id : str
+            Unique identifier for the tenant/organization
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -542,6 +434,12 @@ class AsyncRawSourcesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[ListSourcesResponse]:
         """
+        Retrieve specific sources by their IDs.
+
+        Use this endpoint to fetch one or more sources by providing their unique identifiers. This is useful when you need detailed information about specific documents or content you've previously uploaded.
+
+        Provide the source IDs in the request body along with your tenant information to get the exact sources you need.
+
         Parameters
         ----------
         tenant_id : str
@@ -660,132 +558,3 @@ class AsyncRawSourcesClient:
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
-
-    async def get_sub_tenant_ids(
-        self, *, tenant_id: str, request_options: typing.Optional[RequestOptions] = None
-    ) -> AsyncHttpResponse[SubTenantIdsData]:
-        """
-        Get all sub-tenant IDs (tenant IDs) contained within a specific Weaviate collection.
-        Fetches the tenant IDs directly from Weaviate using default cluster credentials.
-
-        Args:
-            tenant_id: The tenant ID to fetch sub-tenant IDs for
-            api_details: Authentication dependency
-
-        Returns:
-            SubTenantIdsData: Contains collection_name, sub_tenant_ids list, count, and success message
-
-        Example:
-            GET /list/sub_tenant_ids?tenant_id=my_tenant_123
-
-        Parameters
-        ----------
-        tenant_id : str
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        AsyncHttpResponse[SubTenantIdsData]
-            Successful Response
-        """
-        _response = await self._client_wrapper.httpx_client.request(
-            "list/sub_tenant_ids",
-            method="GET",
-            params={
-                "tenant_id": tenant_id,
-            },
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                _data = typing.cast(
-                    SubTenantIdsData,
-                    parse_obj_as(
-                        type_=SubTenantIdsData,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-                return AsyncHttpResponse(response=_response, data=_data)
-            if _response.status_code == 400:
-                raise BadRequestError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        ActualErrorResponse,
-                        parse_obj_as(
-                            type_=ActualErrorResponse,  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            if _response.status_code == 401:
-                raise UnauthorizedError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        ActualErrorResponse,
-                        parse_obj_as(
-                            type_=ActualErrorResponse,  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            if _response.status_code == 403:
-                raise ForbiddenError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        ActualErrorResponse,
-                        parse_obj_as(
-                            type_=ActualErrorResponse,  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            if _response.status_code == 404:
-                raise NotFoundError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        ActualErrorResponse,
-                        parse_obj_as(
-                            type_=ActualErrorResponse,  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            if _response.status_code == 422:
-                raise UnprocessableEntityError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            if _response.status_code == 500:
-                raise InternalServerError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        ActualErrorResponse,
-                        parse_obj_as(
-                            type_=ActualErrorResponse,  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            if _response.status_code == 503:
-                raise ServiceUnavailableError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        ActualErrorResponse,
-                        parse_obj_as(
-                            type_=ActualErrorResponse,  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            _response_json = _response.json()
-        except JSONDecodeError:
-            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
-        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

usecortex_ai/tenant/client.py

@@ -4,6 +4,8 @@ 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 .raw_client import AsyncRawTenantClient, RawTenantClient
 
@@ -31,15 +33,21 @@ class TenantClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> TenantStats:
         """
-        Get tenant stats.
+        Retrieve usage stats for your tenant.
 
-        This endpoint returns stats for 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
+            Unique identifier for the tenant/organization
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -61,6 +69,69 @@ class TenantClient:
         )
         return _response.data
 
+    def get_sub_tenant_ids(
+        self, *, tenant_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> SubTenantIdsData:
+        """
+        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
+
+        Examples
+        --------
+        from usecortex-ai import CortexAI
+
+        client = CortexAI(token="YOUR_TOKEN", )
+        client.tenant.get_sub_tenant_ids(tenant_id='tenant_id', )
+        """
+        _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.
+
+        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.
+
+        Parameters
+        ----------
+        tenant_id : str
+
+        sub_tenant_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DeleteSubTenantData
+            Successful Response
+
+        Examples
+        --------
+        from usecortex-ai import CortexAI
+
+        client = CortexAI(token="YOUR_TOKEN", )
+        client.tenant.delete_sub_tenant(tenant_id='tenant_id', sub_tenant_id='sub_tenant_id', )
+        """
+        _response = self._raw_client.delete_sub_tenant(
+            tenant_id=tenant_id, sub_tenant_id=sub_tenant_id, request_options=request_options
+        )
+        return _response.data
+
 
 class AsyncTenantClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -85,15 +156,21 @@ class AsyncTenantClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> TenantStats:
         """
-        Get tenant stats.
+        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.
 
-        This endpoint returns stats for tenant.
+        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
+            Unique identifier for the tenant/organization
 
         sub_tenant_id : typing.Optional[str]
+            Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -118,3 +195,74 @@ class AsyncTenantClient:
             tenant_id=tenant_id, sub_tenant_id=sub_tenant_id, request_options=request_options
         )
         return _response.data
+
+    async def get_sub_tenant_ids(
+        self, *, tenant_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> SubTenantIdsData:
+        """
+        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
+
+        Examples
+        --------
+        import asyncio
+
+        from usecortex-ai import AsyncCortexAI
+
+        client = AsyncCortexAI(token="YOUR_TOKEN", )
+        async def main() -> None:
+            await client.tenant.get_sub_tenant_ids(tenant_id='tenant_id', )
+        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.
+
+        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.
+
+        Parameters
+        ----------
+        tenant_id : str
+
+        sub_tenant_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DeleteSubTenantData
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from usecortex-ai import AsyncCortexAI
+
+        client = AsyncCortexAI(token="YOUR_TOKEN", )
+        async def main() -> None:
+            await client.tenant.delete_sub_tenant(tenant_id='tenant_id', sub_tenant_id='sub_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
+        )
+        return _response.data