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

usecortex_ai/tenant/raw_client.py

@@ -16,6 +16,8 @@ from ..errors.service_unavailable_error import ServiceUnavailableError
 from ..errors.unauthorized_error import UnauthorizedError
 from ..errors.unprocessable_entity_error import UnprocessableEntityError
 from ..types.actual_error_response import ActualErrorResponse
+from ..types.delete_sub_tenant_data import DeleteSubTenantData
+from ..types.sub_tenant_ids_data import SubTenantIdsData
 from ..types.tenant_stats import TenantStats
 
 
@@ -31,15 +33,21 @@ class RawTenantClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[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 used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -150,6 +158,248 @@ class RawTenantClient:
             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]:
+        """
+        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
+        -------
+        HttpResponse[SubTenantIdsData]
+            Successful Response
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "tenant/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)
+
+    def delete_sub_tenant(
+        self, *, tenant_id: str, sub_tenant_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[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
+        -------
+        HttpResponse[DeleteSubTenantData]
+            Successful Response
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "tenant/delete_sub_tenant",
+            method="DELETE",
+            params={
+                "tenant_id": tenant_id,
+                "sub_tenant_id": sub_tenant_id,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    DeleteSubTenantData,
+                    parse_obj_as(
+                        type_=DeleteSubTenantData,  # 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 AsyncRawTenantClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -163,15 +413,21 @@ class AsyncRawTenantClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[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 used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -281,3 +537,245 @@ class AsyncRawTenantClient:
         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]:
+        """
+        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
+        -------
+        AsyncHttpResponse[SubTenantIdsData]
+            Successful Response
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "tenant/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)
+
+    async def delete_sub_tenant(
+        self, *, tenant_id: str, sub_tenant_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[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
+        -------
+        AsyncHttpResponse[DeleteSubTenantData]
+            Successful Response
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "tenant/delete_sub_tenant",
+            method="DELETE",
+            params={
+                "tenant_id": tenant_id,
+                "sub_tenant_id": sub_tenant_id,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    DeleteSubTenantData,
+                    parse_obj_as(
+                        type_=DeleteSubTenantData,  # 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/types/__init__.py

@@ -3,6 +3,7 @@
 # isort: skip_file
 
 from .actual_error_response import ActualErrorResponse
+from .add_user_memory_response import AddUserMemoryResponse
 from .app_sources_upload_data import AppSourcesUploadData
 from .attachment_model import AttachmentModel
 from .batch_upload_data import BatchUploadData
@@ -11,6 +12,9 @@ from .body_scrape_webpage_upload_scrape_webpage_post import BodyScrapeWebpageUpl
 from .body_update_scrape_job_upload_update_webpage_patch import BodyUpdateScrapeJobUploadUpdateWebpagePatch
 from .content_model import ContentModel
 from .delete_memory_request import DeleteMemoryRequest
+from .delete_sources import DeleteSources
+from .delete_sub_tenant_data import DeleteSubTenantData
+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
@@ -19,25 +23,29 @@ from .error_response import ErrorResponse
 from .extended_context import ExtendedContext
 from .fetch_content_data import FetchContentData
 from .file_upload_result import FileUploadResult
+from .generate_user_memory_response import GenerateUserMemoryResponse
 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 .processing_status import ProcessingStatus
 from .related_chunk import RelatedChunk
 from .relations import Relations
+from .retrieve_user_memory_response import RetrieveUserMemoryResponse
 from .search_chunk import SearchChunk
 from .single_upload_data import SingleUploadData
 from .source import Source
-from .source_content import SourceContent
 from .source_model import SourceModel
 from .sub_tenant_ids_data import SubTenantIdsData
 from .tenant_create_data import TenantCreateData
 from .tenant_stats import TenantStats
+from .user_memory import UserMemory
 from .validation_error import ValidationError
 from .validation_error_loc_item import ValidationErrorLocItem
 
 __all__ = [
     "ActualErrorResponse",
+    "AddUserMemoryResponse",
     "AppSourcesUploadData",
     "AttachmentModel",
     "BatchUploadData",
@@ -46,6 +54,9 @@ __all__ = [
     "BodyUpdateScrapeJobUploadUpdateWebpagePatch",
     "ContentModel",
     "DeleteMemoryRequest",
+    "DeleteSources",
+    "DeleteSubTenantData",
+    "DeleteUserMemoryResponse",
     "EmbeddingsCreateCollectionData",
     "EmbeddingsDeleteData",
     "EmbeddingsGetData",
@@ -54,20 +65,23 @@ __all__ = [
     "ExtendedContext",
     "FetchContentData",
     "FileUploadResult",
+    "GenerateUserMemoryResponse",
     "HttpValidationError",
     "ListSourcesResponse",
+    "ListUserMemoriesResponse",
     "MarkdownUploadRequest",
     "ProcessingStatus",
     "RelatedChunk",
     "Relations",
+    "RetrieveUserMemoryResponse",
     "SearchChunk",
     "SingleUploadData",
     "Source",
-    "SourceContent",
     "SourceModel",
     "SubTenantIdsData",
     "TenantCreateData",
     "TenantStats",
+    "UserMemory",
     "ValidationError",
     "ValidationErrorLocItem",
 ]

usecortex_ai/types/add_user_memory_response.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 AddUserMemoryResponse(UniversalBaseModel):
+    """
+    Response model for adding a new user memory.
+    """
+
+    success: bool = pydantic.Field()
+    """
+    Indicates whether the memory addition operation was successful
+    """
+
+    user_memory_added: bool = pydantic.Field()
+    """
+    Confirms whether the memory was successfully stored in the system
+    """
+
+    memory_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier assigned to the newly created memory
+    """
+
+    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/app_sources_upload_data.py

@@ -8,9 +8,17 @@ from .file_upload_result import FileUploadResult
 
 
 class AppSourcesUploadData(UniversalBaseModel):
-    uploaded: typing.List[FileUploadResult]
+    uploaded: typing.List[FileUploadResult] = pydantic.Field()
+    """
+    List of successfully uploaded app source for indexing
+    """
+
+    message: str = pydantic.Field()
+    """
+    Status message indicating app sources upload scheduled
+    """
+
     success: typing.Optional[bool] = None
-    message: typing.Optional[str] = None
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2