usecortex-ai 0.3.3__py3-none-any.whl → 0.3.5__py3-none-any.whl

usecortex_ai/user_memory/client.py

@@ -6,9 +6,9 @@ from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
 from ..types.add_user_memory_response import AddUserMemoryResponse
 from ..types.delete_user_memory_response import DeleteUserMemoryResponse
-from ..types.generate_user_memory_response import GenerateUserMemoryResponse
 from ..types.list_user_memories_response import ListUserMemoriesResponse
 from ..types.retrieve_user_memory_response import RetrieveUserMemoryResponse
+from ..types.user_assistant_pair import UserAssistantPair
 from .raw_client import AsyncRawUserMemoryClient, RawUserMemoryClient
 
 # this is used as the default value for optional parameters
@@ -133,14 +133,14 @@ class UserMemoryClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RetrieveUserMemoryResponse:
         """
-        Find relevant user memories using semantic search.
+        Find relevant user memories using semantic search and knowledge graph.
 
-        This endpoint performs a semantic search across all your stored user memories
-        to find the most relevant ones based on your query. The results are ranked by
-        similarity score, with the most relevant memories returned first.
+        This endpoint performs parallel searches:
+        1. Semantic search in Weaviate across all stored user memories
+        2. Entity-based search in the knowledge graph for memory entities
 
-        Use this to recall past preferences, context, or information that might be
-        relevant to your current task or query.
+        Results from both sources are combined and ranked by relevance to provide
+        comprehensive memory retrieval.
 
         Parameters
         ----------
@@ -184,91 +184,50 @@ class UserMemoryClient:
         )
         return _response.data
 
-    def generate_user_memory(
+    def add_user_memory(
         self,
         *,
         tenant_id: str,
-        user_message: str,
-        user_name: str,
         sub_tenant_id: typing.Optional[str] = None,
+        raw_text: typing.Optional[str] = OMIT,
+        user_assistant_pairs: typing.Optional[typing.Sequence[UserAssistantPair]] = OMIT,
+        expiry_time: typing.Optional[int] = OMIT,
+        infer: typing.Optional[bool] = OMIT,
+        custom_instructions: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> GenerateUserMemoryResponse:
+    ) -> AddUserMemoryResponse:
         """
-        Generate AI-powered user memories from your query and context.
+        Store new user memories for future reference.
 
-        This endpoint uses artificial intelligence to create personalized memories
-        based on your query and user context. The AI analyzes your input and generates
-        relevant, contextual memories that can help improve future interactions.
+        This endpoint allows you to add memories in two formats:
+        1. Raw text string - A single text-based memory
+        2. User/Assistant pairs array - Conversation pairs that will be chunked as a single memory
 
-        Generated memories are automatically stored and can be retrieved through
-        the standard memory search endpoints.
+        The stored memories will be chunked, indexed in both Weaviate and the knowledge graph,
+        and made available for semantic search and graph-based retrieval.
 
         Parameters
         ----------
         tenant_id : str
             Unique identifier for the tenant/organization
 
-        user_message : str
-            Your query or context for AI memory generation
-
-        user_name : str
-            Your name to personalize the generated memories
-
         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.
-
-        Returns
-        -------
-        GenerateUserMemoryResponse
-            Successful Response
-
-        Examples
-        --------
-        from usecortex-ai import CortexAI
-
-        client = CortexAI(token="YOUR_TOKEN", )
-        client.user_memory.generate_user_memory(tenant_id='tenant_1234', sub_tenant_id='sub_tenant_4567', user_message='I prefer detailed technical explanations and works in the Pacific timezone', user_name='John Doe', )
-        """
-        _response = self._raw_client.generate_user_memory(
-            tenant_id=tenant_id,
-            user_message=user_message,
-            user_name=user_name,
-            sub_tenant_id=sub_tenant_id,
-            request_options=request_options,
-        )
-        return _response.data
-
-    def add_user_memory(
-        self,
-        *,
-        tenant_id: str,
-        user_memory: str,
-        sub_tenant_id: typing.Optional[str] = None,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> AddUserMemoryResponse:
-        """
-        Store a new user memory for future reference.
-
-        This endpoint allows you to manually add a memory that will be stored and
-        can be retrieved later through memory search. Use this to save important
-        preferences, context, or information that you want the system to remember.
+        raw_text : typing.Optional[str]
+            Single raw text memory to store
 
-        The stored memory will be indexed and available for semantic search, making
-        it accessible when relevant to future queries or interactions.
+        user_assistant_pairs : typing.Optional[typing.Sequence[UserAssistantPair]]
+            Array of user/assistant conversation pairs to store as a single memory
 
-        Parameters
-        ----------
-        tenant_id : str
-            Unique identifier for the tenant/organization
+        expiry_time : typing.Optional[int]
+            Expiry time in seconds for the memory (optional)
 
-        user_memory : str
-            The memory content to store for future reference
+        infer : typing.Optional[bool]
+            If true, process and compress chunks into inferred representations before indexing (default: False)
 
-        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.
+        custom_instructions : typing.Optional[str]
+            Custom instructions to guide cortex
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -283,10 +242,17 @@ class UserMemoryClient:
         from usecortex-ai import CortexAI
 
         client = CortexAI(token="YOUR_TOKEN", )
-        client.user_memory.add_user_memory(tenant_id='tenant_1234', sub_tenant_id='sub_tenant_4567', user_memory='I prefer detailed technical explanations and works in the Pacific timezone', )
+        client.user_memory.add_user_memory(tenant_id='tenant_1234', sub_tenant_id='sub_tenant_4567', )
         """
         _response = self._raw_client.add_user_memory(
-            tenant_id=tenant_id, user_memory=user_memory, sub_tenant_id=sub_tenant_id, request_options=request_options
+            tenant_id=tenant_id,
+            sub_tenant_id=sub_tenant_id,
+            raw_text=raw_text,
+            user_assistant_pairs=user_assistant_pairs,
+            expiry_time=expiry_time,
+            infer=infer,
+            custom_instructions=custom_instructions,
+            request_options=request_options,
         )
         return _response.data
 
@@ -417,14 +383,14 @@ class AsyncUserMemoryClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RetrieveUserMemoryResponse:
         """
-        Find relevant user memories using semantic search.
+        Find relevant user memories using semantic search and knowledge graph.
 
-        This endpoint performs a semantic search across all your stored user memories
-        to find the most relevant ones based on your query. The results are ranked by
-        similarity score, with the most relevant memories returned first.
+        This endpoint performs parallel searches:
+        1. Semantic search in Weaviate across all stored user memories
+        2. Entity-based search in the knowledge graph for memory entities
 
-        Use this to recall past preferences, context, or information that might be
-        relevant to your current task or query.
+        Results from both sources are combined and ranked by relevance to provide
+        comprehensive memory retrieval.
 
         Parameters
         ----------
@@ -472,95 +438,50 @@ class AsyncUserMemoryClient:
         )
         return _response.data
 
-    async def generate_user_memory(
+    async def add_user_memory(
         self,
         *,
         tenant_id: str,
-        user_message: str,
-        user_name: str,
         sub_tenant_id: typing.Optional[str] = None,
+        raw_text: typing.Optional[str] = OMIT,
+        user_assistant_pairs: typing.Optional[typing.Sequence[UserAssistantPair]] = OMIT,
+        expiry_time: typing.Optional[int] = OMIT,
+        infer: typing.Optional[bool] = OMIT,
+        custom_instructions: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> GenerateUserMemoryResponse:
+    ) -> AddUserMemoryResponse:
         """
-        Generate AI-powered user memories from your query and context.
+        Store new user memories for future reference.
 
-        This endpoint uses artificial intelligence to create personalized memories
-        based on your query and user context. The AI analyzes your input and generates
-        relevant, contextual memories that can help improve future interactions.
+        This endpoint allows you to add memories in two formats:
+        1. Raw text string - A single text-based memory
+        2. User/Assistant pairs array - Conversation pairs that will be chunked as a single memory
 
-        Generated memories are automatically stored and can be retrieved through
-        the standard memory search endpoints.
+        The stored memories will be chunked, indexed in both Weaviate and the knowledge graph,
+        and made available for semantic search and graph-based retrieval.
 
         Parameters
         ----------
         tenant_id : str
             Unique identifier for the tenant/organization
 
-        user_message : str
-            Your query or context for AI memory generation
-
-        user_name : str
-            Your name to personalize the generated memories
-
         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.
-
-        Returns
-        -------
-        GenerateUserMemoryResponse
-            Successful Response
-
-        Examples
-        --------
-        import asyncio
-
-        from usecortex-ai import AsyncCortexAI
-
-        client = AsyncCortexAI(token="YOUR_TOKEN", )
-        async def main() -> None:
-            await client.user_memory.generate_user_memory(tenant_id='tenant_1234', sub_tenant_id='sub_tenant_4567', user_message='I prefer detailed technical explanations and works in the Pacific timezone', user_name='John Doe', )
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.generate_user_memory(
-            tenant_id=tenant_id,
-            user_message=user_message,
-            user_name=user_name,
-            sub_tenant_id=sub_tenant_id,
-            request_options=request_options,
-        )
-        return _response.data
-
-    async def add_user_memory(
-        self,
-        *,
-        tenant_id: str,
-        user_memory: str,
-        sub_tenant_id: typing.Optional[str] = None,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> AddUserMemoryResponse:
-        """
-        Store a new user memory for future reference.
-
-        This endpoint allows you to manually add a memory that will be stored and
-        can be retrieved later through memory search. Use this to save important
-        preferences, context, or information that you want the system to remember.
+        raw_text : typing.Optional[str]
+            Single raw text memory to store
 
-        The stored memory will be indexed and available for semantic search, making
-        it accessible when relevant to future queries or interactions.
+        user_assistant_pairs : typing.Optional[typing.Sequence[UserAssistantPair]]
+            Array of user/assistant conversation pairs to store as a single memory
 
-        Parameters
-        ----------
-        tenant_id : str
-            Unique identifier for the tenant/organization
+        expiry_time : typing.Optional[int]
+            Expiry time in seconds for the memory (optional)
 
-        user_memory : str
-            The memory content to store for future reference
+        infer : typing.Optional[bool]
+            If true, process and compress chunks into inferred representations before indexing (default: False)
 
-        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.
+        custom_instructions : typing.Optional[str]
+            Custom instructions to guide cortex
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -578,10 +499,17 @@ class AsyncUserMemoryClient:
 
         client = AsyncCortexAI(token="YOUR_TOKEN", )
         async def main() -> None:
-            await client.user_memory.add_user_memory(tenant_id='tenant_1234', sub_tenant_id='sub_tenant_4567', user_memory='I prefer detailed technical explanations and works in the Pacific timezone', )
+            await client.user_memory.add_user_memory(tenant_id='tenant_1234', sub_tenant_id='sub_tenant_4567', )
         asyncio.run(main())
         """
         _response = await self._raw_client.add_user_memory(
-            tenant_id=tenant_id, user_memory=user_memory, sub_tenant_id=sub_tenant_id, request_options=request_options
+            tenant_id=tenant_id,
+            sub_tenant_id=sub_tenant_id,
+            raw_text=raw_text,
+            user_assistant_pairs=user_assistant_pairs,
+            expiry_time=expiry_time,
+            infer=infer,
+            custom_instructions=custom_instructions,
+            request_options=request_options,
         )
         return _response.data