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

usecortex_ai/__init__.py

@@ -6,7 +6,6 @@ from .types import (
     ActualErrorResponse,
     AddMemoryResponse,
     ApiKeyInfo,
-    AppSourcesUploadData,
     AttachmentModel,
     Bm25OperatorType,
     CollectionStats,
@@ -25,6 +24,8 @@ from .types import (
     HttpValidationError,
     Infra,
     InsertResult,
+    ListContentKind,
+    ListUserMemoriesResponse,
     MemoryItem,
     MemoryResultItem,
     MilvusDataType,
@@ -56,6 +57,7 @@ from .types import (
     TenantStatsResponse,
     TripletWithEvidence,
     UserAssistantPair,
+    UserMemory,
     ValidationError,
     ValidationErrorLocItem,
     VectorStoreChunk,
@@ -73,20 +75,18 @@ from .errors import (
 from . import dashboard, embeddings, fetch, search, sources, tenant, upload
 from .client import AsyncCortexAI, CortexAI
 from .environment import CortexAIEnvironment
+from .fetch import FetchListKnowledgeResponse
 from .search import Alpha
-from .upload import BodyUploadAppIngestionUploadAppPostAppSources
 
 __all__ = [
     "ActualErrorResponse",
     "AddMemoryResponse",
     "Alpha",
     "ApiKeyInfo",
-    "AppSourcesUploadData",
     "AsyncCortexAI",
     "AttachmentModel",
     "BadRequestError",
     "Bm25OperatorType",
-    "BodyUploadAppIngestionUploadAppPostAppSources",
     "CollectionStats",
     "ContentModel",
     "CortexAI",
@@ -99,6 +99,7 @@ __all__ = [
     "DeleteUserMemoryResponse",
     "Entity",
     "ErrorResponse",
+    "FetchListKnowledgeResponse",
     "FetchMode",
     "ForbiddenError",
     "ForcefulRelationsPayload",
@@ -107,6 +108,8 @@ __all__ = [
     "Infra",
     "InsertResult",
     "InternalServerError",
+    "ListContentKind",
+    "ListUserMemoriesResponse",
     "MemoryItem",
     "MemoryResultItem",
     "MilvusDataType",
@@ -143,6 +146,7 @@ __all__ = [
     "UnauthorizedError",
     "UnprocessableEntityError",
     "UserAssistantPair",
+    "UserMemory",
     "ValidationError",
     "ValidationErrorLocItem",
     "VectorStoreChunk",

usecortex_ai/client.py

@@ -103,8 +103,6 @@ class CortexAI:
         self, *, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.Optional[typing.Any]:
         """
-        Endpoint that serves Prometheus metrics.
-
         Parameters
         ----------
         request_options : typing.Optional[RequestOptions]
@@ -213,8 +211,6 @@ class AsyncCortexAI:
         self, *, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.Optional[typing.Any]:
         """
-        Endpoint that serves Prometheus metrics.
-
         Parameters
         ----------
         request_options : typing.Optional[RequestOptions]

usecortex_ai/dashboard/client.py

@@ -27,11 +27,6 @@ class DashboardClient:
 
     def list_apis(self, *, request_options: typing.Optional[RequestOptions] = None) -> DashboardApisResponse:
         """
-        List all API keys for dashboard view.
-
-        Uses Firebase authentication to identify the user and returns API keys
-        associated with that user.
-
         Parameters
         ----------
         request_options : typing.Optional[RequestOptions]
@@ -56,10 +51,6 @@ class DashboardClient:
         self, *, tenant_id: str, sub_tenant_id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> DashboardSourcesResponse:
         """
-        List all sources for a tenant/sub-tenant combination.
-
-        Uses the same logic as the existing get_sources function.
-
         Parameters
         ----------
         tenant_id : str
@@ -81,7 +72,7 @@ class DashboardClient:
         from usecortex-ai import CortexAI
 
         client = CortexAI(token="YOUR_TOKEN", )
-        client.dashboard.list_sources(tenant_id='tenant_id', sub_tenant_id='sub_tenant_id', )
+        client.dashboard.list_sources(tenant_id='tenant_1234', sub_tenant_id='sub_tenant_4567', )
         """
         _response = self._raw_client.list_sources(
             tenant_id=tenant_id, sub_tenant_id=sub_tenant_id, request_options=request_options
@@ -90,11 +81,6 @@ class DashboardClient:
 
     def list_tenants(self, *, request_options: typing.Optional[RequestOptions] = None) -> DashboardTenantsResponse:
         """
-        List all tenants for dashboard view.
-
-        Uses Firebase authentication to identify the user and returns tenant
-        mappings associated with that user's organization.
-
         Parameters
         ----------
         request_options : typing.Optional[RequestOptions]
@@ -231,11 +217,6 @@ class AsyncDashboardClient:
 
     async def list_apis(self, *, request_options: typing.Optional[RequestOptions] = None) -> DashboardApisResponse:
         """
-        List all API keys for dashboard view.
-
-        Uses Firebase authentication to identify the user and returns API keys
-        associated with that user.
-
         Parameters
         ----------
         request_options : typing.Optional[RequestOptions]
@@ -264,10 +245,6 @@ class AsyncDashboardClient:
         self, *, tenant_id: str, sub_tenant_id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> DashboardSourcesResponse:
         """
-        List all sources for a tenant/sub-tenant combination.
-
-        Uses the same logic as the existing get_sources function.
-
         Parameters
         ----------
         tenant_id : str
@@ -292,7 +269,7 @@ class AsyncDashboardClient:
 
         client = AsyncCortexAI(token="YOUR_TOKEN", )
         async def main() -> None:
-            await client.dashboard.list_sources(tenant_id='tenant_id', sub_tenant_id='sub_tenant_id', )
+            await client.dashboard.list_sources(tenant_id='tenant_1234', sub_tenant_id='sub_tenant_4567', )
         asyncio.run(main())
         """
         _response = await self._raw_client.list_sources(
@@ -304,11 +281,6 @@ class AsyncDashboardClient:
         self, *, request_options: typing.Optional[RequestOptions] = None
     ) -> DashboardTenantsResponse:
         """
-        List all tenants for dashboard view.
-
-        Uses Firebase authentication to identify the user and returns tenant
-        mappings associated with that user's organization.
-
         Parameters
         ----------
         request_options : typing.Optional[RequestOptions]

usecortex_ai/dashboard/raw_client.py

@@ -28,11 +28,6 @@ class RawDashboardClient:
         self, *, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[DashboardApisResponse]:
         """
-        List all API keys for dashboard view.
-
-        Uses Firebase authentication to identify the user and returns API keys
-        associated with that user.
-
         Parameters
         ----------
         request_options : typing.Optional[RequestOptions]
@@ -144,10 +139,6 @@ class RawDashboardClient:
         self, *, tenant_id: str, sub_tenant_id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[DashboardSourcesResponse]:
         """
-        List all sources for a tenant/sub-tenant combination.
-
-        Uses the same logic as the existing get_sources function.
-
         Parameters
         ----------
         tenant_id : str
@@ -269,11 +260,6 @@ class RawDashboardClient:
         self, *, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[DashboardTenantsResponse]:
         """
-        List all tenants for dashboard view.
-
-        Uses Firebase authentication to identify the user and returns tenant
-        mappings associated with that user's organization.
-
         Parameters
         ----------
         request_options : typing.Optional[RequestOptions]
@@ -550,11 +536,6 @@ class AsyncRawDashboardClient:
         self, *, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[DashboardApisResponse]:
         """
-        List all API keys for dashboard view.
-
-        Uses Firebase authentication to identify the user and returns API keys
-        associated with that user.
-
         Parameters
         ----------
         request_options : typing.Optional[RequestOptions]
@@ -666,10 +647,6 @@ class AsyncRawDashboardClient:
         self, *, tenant_id: str, sub_tenant_id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[DashboardSourcesResponse]:
         """
-        List all sources for a tenant/sub-tenant combination.
-
-        Uses the same logic as the existing get_sources function.
-
         Parameters
         ----------
         tenant_id : str
@@ -791,11 +768,6 @@ class AsyncRawDashboardClient:
         self, *, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[DashboardTenantsResponse]:
         """
-        List all tenants for dashboard view.
-
-        Uses Firebase authentication to identify the user and returns tenant
-        mappings associated with that user's organization.
-
         Parameters
         ----------
         request_options : typing.Optional[RequestOptions]

usecortex_ai/embeddings/client.py

@@ -39,16 +39,6 @@ class EmbeddingsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> InsertResult:
         """
-        Upload pre-computed embeddings for advanced similarity search.
-
-        This endpoint accepts vector embeddings that you’ve generated externally,
-         allowing you to integrate with custom embedding models or existing vector databases.
-          The embeddings represent chunks of your content as numerical vectors.
-
-        The system stores these embeddings and makes them available for semantic search and similarity matching.
-         Use this when you want to leverage specialized embedding models or have existing vector representations.
-        When upsert=True, existing embeddings with the same chunk_id will be updated.
-
         Parameters
         ----------
         tenant_id : str
@@ -76,7 +66,7 @@ class EmbeddingsClient:
         from usecortex-ai import CortexAI, RawEmbeddingDocument, RawEmbeddingVector
 
         client = CortexAI(token="YOUR_TOKEN", )
-        client.embeddings.insert(tenant_id='tenant_id', embeddings=[RawEmbeddingDocument(source_id='source_id', embeddings=[RawEmbeddingVector(chunk_id='chunk_id', embedding=[1.1], )], )], )
+        client.embeddings.insert(tenant_id='tenant_1234', embeddings=[RawEmbeddingDocument(source_id='<source_id>', embeddings=[RawEmbeddingVector(chunk_id='<chunk_id>', embedding=[1.1], ), RawEmbeddingVector(chunk_id='<chunk_id>', embedding=[1.1], )], ), RawEmbeddingDocument(source_id='<source_id>', embeddings=[RawEmbeddingVector(chunk_id='<chunk_id>', embedding=[1.1], ), RawEmbeddingVector(chunk_id='<chunk_id>', embedding=[1.1], )], )], )
         """
         _response = self._raw_client.insert(
             tenant_id=tenant_id,
@@ -99,13 +89,6 @@ class EmbeddingsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[RawEmbeddingSearchResult]:
         """
-        Find similar chunks using an embedding vector.
-
-        Use this to retrieve the most similar chunk IDs to a single query embedding.
-
-        Expected outcome:
-        - You receive the closest chunk IDs with optional similarity scores.
-
         Parameters
         ----------
         tenant_id : str
@@ -139,7 +122,7 @@ class EmbeddingsClient:
         from usecortex-ai import CortexAI
 
         client = CortexAI(token="YOUR_TOKEN", )
-        client.embeddings.search(tenant_id='tenant_id', sub_tenant_id='sub_tenant_id', query_embedding=[1.1], )
+        client.embeddings.search(tenant_id='tenant_1234', sub_tenant_id='sub_tenant_4567', query_embedding=[1.1], )
         """
         _response = self._raw_client.search(
             tenant_id=tenant_id,
@@ -164,9 +147,6 @@ class EmbeddingsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[RawEmbeddingSearchResult]:
         """
-        Retrieve embeddings for specific chunk IDs.
-        Use this when you already know the chunk IDs and need their corresponding embeddings.
-
         Parameters
         ----------
         tenant_id : str
@@ -200,7 +180,7 @@ class EmbeddingsClient:
         from usecortex-ai import CortexAI
 
         client = CortexAI(token="YOUR_TOKEN", )
-        client.embeddings.filter(tenant_id='tenant_id', sub_tenant_id='sub_tenant_id', )
+        client.embeddings.filter(tenant_id='tenant_1234', sub_tenant_id='sub_tenant_4567', )
         """
         _response = self._raw_client.filter(
             tenant_id=tenant_id,
@@ -223,11 +203,6 @@ class EmbeddingsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> DeleteResult:
         """
-        Delete embedding chunks by chunk ID.
-
-        Use this to remove specific chunks from your embeddings index when they are no longer
-        valid or should not appear in results.
-
         Parameters
         ----------
         tenant_id : str
@@ -255,7 +230,7 @@ class EmbeddingsClient:
         from usecortex-ai import CortexAI
 
         client = CortexAI(token="YOUR_TOKEN", )
-        client.embeddings.delete(tenant_id='tenant_id', )
+        client.embeddings.delete(tenant_id='tenant_1234', )
         """
         _response = self._raw_client.delete(
             tenant_id=tenant_id,
@@ -292,16 +267,6 @@ class AsyncEmbeddingsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> InsertResult:
         """
-        Upload pre-computed embeddings for advanced similarity search.
-
-        This endpoint accepts vector embeddings that you’ve generated externally,
-         allowing you to integrate with custom embedding models or existing vector databases.
-          The embeddings represent chunks of your content as numerical vectors.
-
-        The system stores these embeddings and makes them available for semantic search and similarity matching.
-         Use this when you want to leverage specialized embedding models or have existing vector representations.
-        When upsert=True, existing embeddings with the same chunk_id will be updated.
-
         Parameters
         ----------
         tenant_id : str
@@ -333,7 +298,7 @@ class AsyncEmbeddingsClient:
 
         client = AsyncCortexAI(token="YOUR_TOKEN", )
         async def main() -> None:
-            await client.embeddings.insert(tenant_id='tenant_id', embeddings=[RawEmbeddingDocument(source_id='source_id', embeddings=[RawEmbeddingVector(chunk_id='chunk_id', embedding=[1.1], )], )], )
+            await client.embeddings.insert(tenant_id='tenant_1234', embeddings=[RawEmbeddingDocument(source_id='<source_id>', embeddings=[RawEmbeddingVector(chunk_id='<chunk_id>', embedding=[1.1], ), RawEmbeddingVector(chunk_id='<chunk_id>', embedding=[1.1], )], ), RawEmbeddingDocument(source_id='<source_id>', embeddings=[RawEmbeddingVector(chunk_id='<chunk_id>', embedding=[1.1], ), RawEmbeddingVector(chunk_id='<chunk_id>', embedding=[1.1], )], )], )
         asyncio.run(main())
         """
         _response = await self._raw_client.insert(
@@ -357,13 +322,6 @@ class AsyncEmbeddingsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[RawEmbeddingSearchResult]:
         """
-        Find similar chunks using an embedding vector.
-
-        Use this to retrieve the most similar chunk IDs to a single query embedding.
-
-        Expected outcome:
-        - You receive the closest chunk IDs with optional similarity scores.
-
         Parameters
         ----------
         tenant_id : str
@@ -400,7 +358,7 @@ class AsyncEmbeddingsClient:
 
         client = AsyncCortexAI(token="YOUR_TOKEN", )
         async def main() -> None:
-            await client.embeddings.search(tenant_id='tenant_id', sub_tenant_id='sub_tenant_id', query_embedding=[1.1], )
+            await client.embeddings.search(tenant_id='tenant_1234', sub_tenant_id='sub_tenant_4567', query_embedding=[1.1], )
         asyncio.run(main())
         """
         _response = await self._raw_client.search(
@@ -426,9 +384,6 @@ class AsyncEmbeddingsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[RawEmbeddingSearchResult]:
         """
-        Retrieve embeddings for specific chunk IDs.
-        Use this when you already know the chunk IDs and need their corresponding embeddings.
-
         Parameters
         ----------
         tenant_id : str
@@ -465,7 +420,7 @@ class AsyncEmbeddingsClient:
 
         client = AsyncCortexAI(token="YOUR_TOKEN", )
         async def main() -> None:
-            await client.embeddings.filter(tenant_id='tenant_id', sub_tenant_id='sub_tenant_id', )
+            await client.embeddings.filter(tenant_id='tenant_1234', sub_tenant_id='sub_tenant_4567', )
         asyncio.run(main())
         """
         _response = await self._raw_client.filter(
@@ -489,11 +444,6 @@ class AsyncEmbeddingsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> DeleteResult:
         """
-        Delete embedding chunks by chunk ID.
-
-        Use this to remove specific chunks from your embeddings index when they are no longer
-        valid or should not appear in results.
-
         Parameters
         ----------
         tenant_id : str
@@ -524,7 +474,7 @@ class AsyncEmbeddingsClient:
 
         client = AsyncCortexAI(token="YOUR_TOKEN", )
         async def main() -> None:
-            await client.embeddings.delete(tenant_id='tenant_id', )
+            await client.embeddings.delete(tenant_id='tenant_1234', )
         asyncio.run(main())
         """
         _response = await self._raw_client.delete(

usecortex_ai/embeddings/raw_client.py

@@ -39,16 +39,6 @@ class RawEmbeddingsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[InsertResult]:
         """
-        Upload pre-computed embeddings for advanced similarity search.
-
-        This endpoint accepts vector embeddings that you’ve generated externally,
-         allowing you to integrate with custom embedding models or existing vector databases.
-          The embeddings represent chunks of your content as numerical vectors.
-
-        The system stores these embeddings and makes them available for semantic search and similarity matching.
-         Use this when you want to leverage specialized embedding models or have existing vector representations.
-        When upsert=True, existing embeddings with the same chunk_id will be updated.
-
         Parameters
         ----------
         tenant_id : str
@@ -72,7 +62,7 @@ class RawEmbeddingsClient:
             Successful Response
         """
         _response = self._client_wrapper.httpx_client.request(
-            "embeddings/insert-raw-embeddings",
+            "embeddings/insert_raw_embeddings",
             method="POST",
             json={
                 "tenant_id": tenant_id,
@@ -192,13 +182,6 @@ class RawEmbeddingsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[typing.List[RawEmbeddingSearchResult]]:
         """
-        Find similar chunks using an embedding vector.
-
-        Use this to retrieve the most similar chunk IDs to a single query embedding.
-
-        Expected outcome:
-        - You receive the closest chunk IDs with optional similarity scores.
-
         Parameters
         ----------
         tenant_id : str
@@ -228,7 +211,7 @@ class RawEmbeddingsClient:
             Successful Response
         """
         _response = self._client_wrapper.httpx_client.request(
-            "embeddings/search-raw-embeddings",
+            "embeddings/search_raw_embeddings",
             method="POST",
             json={
                 "tenant_id": tenant_id,
@@ -348,9 +331,6 @@ class RawEmbeddingsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[typing.List[RawEmbeddingSearchResult]]:
         """
-        Retrieve embeddings for specific chunk IDs.
-        Use this when you already know the chunk IDs and need their corresponding embeddings.
-
         Parameters
         ----------
         tenant_id : str
@@ -380,7 +360,7 @@ class RawEmbeddingsClient:
             Successful Response
         """
         _response = self._client_wrapper.httpx_client.request(
-            "embeddings/filter-raw-embeddings",
+            "embeddings/filter_raw_embeddings",
             method="POST",
             json={
                 "tenant_id": tenant_id,
@@ -498,11 +478,6 @@ class RawEmbeddingsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[DeleteResult]:
         """
-        Delete embedding chunks by chunk ID.
-
-        Use this to remove specific chunks from your embeddings index when they are no longer
-        valid or should not appear in results.
-
         Parameters
         ----------
         tenant_id : str
@@ -526,7 +501,7 @@ class RawEmbeddingsClient:
             Successful Response
         """
         _response = self._client_wrapper.httpx_client.request(
-            "embeddings/delete-raw-embeddings",
+            "embeddings/delete_raw_embeddings",
             method="DELETE",
             params={
                 "tenant_id": tenant_id,
@@ -643,16 +618,6 @@ class AsyncRawEmbeddingsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[InsertResult]:
         """
-        Upload pre-computed embeddings for advanced similarity search.
-
-        This endpoint accepts vector embeddings that you’ve generated externally,
-         allowing you to integrate with custom embedding models or existing vector databases.
-          The embeddings represent chunks of your content as numerical vectors.
-
-        The system stores these embeddings and makes them available for semantic search and similarity matching.
-         Use this when you want to leverage specialized embedding models or have existing vector representations.
-        When upsert=True, existing embeddings with the same chunk_id will be updated.
-
         Parameters
         ----------
         tenant_id : str
@@ -676,7 +641,7 @@ class AsyncRawEmbeddingsClient:
             Successful Response
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "embeddings/insert-raw-embeddings",
+            "embeddings/insert_raw_embeddings",
             method="POST",
             json={
                 "tenant_id": tenant_id,
@@ -796,13 +761,6 @@ class AsyncRawEmbeddingsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[typing.List[RawEmbeddingSearchResult]]:
         """
-        Find similar chunks using an embedding vector.
-
-        Use this to retrieve the most similar chunk IDs to a single query embedding.
-
-        Expected outcome:
-        - You receive the closest chunk IDs with optional similarity scores.
-
         Parameters
         ----------
         tenant_id : str
@@ -832,7 +790,7 @@ class AsyncRawEmbeddingsClient:
             Successful Response
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "embeddings/search-raw-embeddings",
+            "embeddings/search_raw_embeddings",
             method="POST",
             json={
                 "tenant_id": tenant_id,
@@ -952,9 +910,6 @@ class AsyncRawEmbeddingsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[typing.List[RawEmbeddingSearchResult]]:
         """
-        Retrieve embeddings for specific chunk IDs.
-        Use this when you already know the chunk IDs and need their corresponding embeddings.
-
         Parameters
         ----------
         tenant_id : str
@@ -984,7 +939,7 @@ class AsyncRawEmbeddingsClient:
             Successful Response
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "embeddings/filter-raw-embeddings",
+            "embeddings/filter_raw_embeddings",
             method="POST",
             json={
                 "tenant_id": tenant_id,
@@ -1102,11 +1057,6 @@ class AsyncRawEmbeddingsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[DeleteResult]:
         """
-        Delete embedding chunks by chunk ID.
-
-        Use this to remove specific chunks from your embeddings index when they are no longer
-        valid or should not appear in results.
-
         Parameters
         ----------
         tenant_id : str
@@ -1130,7 +1080,7 @@ class AsyncRawEmbeddingsClient:
             Successful Response
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "embeddings/delete-raw-embeddings",
+            "embeddings/delete_raw_embeddings",
             method="DELETE",
             params={
                 "tenant_id": tenant_id,

usecortex_ai/fetch/__init__.py

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