recallrai 0.0.1__tar.gz → 0.1.0__tar.gz

recallrai-0.1.0/PKG-INFO

@@ -0,0 +1,268 @@
+Metadata-Version: 2.3
+Name: recallrai
+Version: 0.1.0
+Summary: Official Python SDK for RecallrAI - Revolutionary contextual memory system that enables AI assistants to form meaningful connections between conversations, just like human memory.
+License: MIT
+Keywords: ai,memory,context,llm,mem0,getzep,zep
+Author: Devasheesh Mishra
+Author-email: devasheeshmishra4@gmail.com
+Requires-Python: >=3.8,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: httpx (>=0.25.0,<0.26.0)
+Requires-Dist: pydantic (>=2.4.0,<3.0.0)
+Project-URL: Homepage, https://recallrai.com
+Project-URL: Repository, https://github.com/recallrai/sdk-python
+Description-Content-Type: text/markdown
+
+# RecallrAI Python SDK
+
+Official Python SDK for RecallrAI – a revolutionary contextual memory system that enables AI assistants to form meaningful connections between conversations, just like human memory.
+
+## Installation
+
+Install the SDK via Poetry or pip:
+
+```bash
+poetry add recallrai
+# or
+pip install recallrai
+```
+
+## Initialization
+
+Create a client instance with your API key and project ID:
+
+```python
+from recallrai import RecallrAI
+
+api_key = "rai_yourapikey"
+project_id = "project-uuid"
+client = RecallrAI(api_key=api_key, project_id=project_id)
+```
+
+## User Management
+
+### Create a User
+
+```python
+from recallrai.user import User
+
+user_id = "user123"
+metadata = {"key": "value"}
+user = client.create_user(user_id=user_id, metadata=metadata)
+print("Created user:", user.user_id)
+```
+
+### Get a User
+
+```python
+user = client.get_user("user123")
+print("User metadata:", user.metadata)
+```
+
+### List Users
+
+```python
+user_list = client.list_users(offset=0, limit=10)
+for user in user_list.users:
+    print(user.user_id, user.metadata)
+```
+
+### Update a User
+
+```python
+# Update the user's metadata and/or change the user ID
+updated_user = client.update_user(user_id="user123", new_metadata={"role": "user"}, new_user_id="user1234")
+print("Updated user id:", updated_user.user_id)
+```
+
+### Delete a User
+
+```python
+client.delete_user("user1234")
+print("User deleted.")
+```
+
+## Session Management
+
+### Create a Session
+
+```python
+from recallrai.session import Session
+
+# Create a session for a user; auto_process_after_minutes set to -1 disables auto-processing.
+session = client.create_session(user_id="user123", auto_process_after_minutes=5)
+print("Created session id:", session.session_id)
+```
+
+### Get an Existing Session
+
+```python
+# Retrieve an existing session by its ID
+session = client.get_session(user_id="user123", session_id="session-uuid")
+print("Session status:", session.get_status())
+```
+
+### List Sessions
+
+```python
+session_list = client.list_sessions(user_id="user123", offset=0, limit=10)
+for session in session_list.sessions:
+    print(session.session_id, session.status)
+```
+
+### Session – Adding Messages
+
+#### Add a User Message
+
+```python
+session.add_user_message("Hello! How are you?")
+```
+
+### Session – Retrieving Context
+
+```python
+context = session.get_context()
+print("Memory used:", context.memory_used)
+print("Context:", context.context)
+```
+
+#### Add an Assistant Message
+
+```python
+session.add_assistant_message("I'm an assistant. How can I help you?")
+```
+
+### Session – Process Session
+
+```python
+session.process()
+```
+
+### Session – Get Status and Messages
+
+```python
+status = session.get_status()
+print("Session status:", status)
+
+messages = session.get_messages()
+for message in messages:
+    print(f"{message.role}: {message.content} at {message.timestamp}")
+```
+
+## Example Usage with LLMs
+
+```python
+import openai
+from recallrai import RecallrAI
+
+# Initialize RecallrAI and OpenAI clients
+recallrai_client = RecallrAI(api_key="rai_yourapikey", project_id="project-uuid")
+openai_client = openai.OpenAI(api_key="your-openai-api-key")
+
+def chat_with_memory(user_id, session_id=None):
+    # Get or create user
+    try:
+        user = recallrai_client.get_user(user_id)
+    except:
+        user = recallrai_client.create_user(user_id)
+    
+    # Create a new session or get an existing one
+    if session_id:
+        session = recallrai_client.get_session(user_id=user_id, session_id=session_id)
+    else:
+        session = recallrai_client.create_session(user_id=user_id, auto_process_after_minutes=30)
+        print(f"Created new session: {session.session_id}")
+    
+    print("Chat session started. Type 'exit' to end the conversation.")
+    
+    while True:
+        # Get user input
+        user_message = input("You: ")
+        if user_message.lower() == 'exit':
+            break
+        
+        # Add the user message to RecallrAI
+        session.add_user_message(user_message)
+        
+        # Get context from RecallrAI after adding the user message
+        context = session.get_context()
+        
+        # Create a system prompt that includes the context
+        system_prompt = f"""You are a helpful assistant with memory of previous conversations.
+        
+        MEMORIES ABOUT THE USER:
+        {context.context}
+        
+        You can use the above memories to provide better responses to the user.
+        Don't mention that you have access to memories unless you are explicitly asked."""
+        
+        # Get previous messages
+        previous_messages = session.get_messages()
+        previous_messages = [{"role": message.role, "content": message.content} for message in previous_messages]
+
+        # Call the LLM with the system prompt and user message
+        response = openai_client.chat.completions.create(
+            model="gpt-4o-mini",
+            messages=[
+                {"role": "system", "content": system_prompt},
+                **previous_messages,
+            ],
+            temperature=0.7
+        )
+        
+        assistant_message = response.choices[0].message.content
+        
+        # Print the assistant's response
+        print(f"Assistant: {assistant_message}")
+        
+        # Add the assistant's response to RecallrAI
+        session.add_assistant_message(assistant_message)
+    
+    # Process the session at the end of the conversation
+    print("Processing session to update memory...")
+    session.process()
+    print(f"Session ended. Session ID: {session.session_id}")
+    return session.session_id
+
+# Example usage
+if __name__ == "__main__":
+    user_id = "user123"
+    # To continue a previous session, uncomment below and provide the session ID
+    # previous_session_id = "previously-saved-session-uuid"
+    # session_id = chat_with_memory(user_id, previous_session_id)
+    
+    # Start a new session
+    session_id = chat_with_memory(user_id)
+    print(f"To continue this conversation later, use session ID: {session_id}")
+```
+
+## Exception Handling
+
+> Exception handling will be improved in future.
+Each operation may raise custom exceptions defined in the SDK:
+
+```python
+from recallrai.utils.exceptions import NotFoundError, ValidationError
+
+try:
+    user = client.get_user("nonexistent_id")
+except NotFoundError as e:
+    print("User not found:", e.message)
+except ValidationError as e:
+    print("Invalid input:", e.message)
+```
+
+## Conclusion
+
+This README outlines the basic usage of the RecallrAI SDK functions for user and session management. For additional documentation and advanced usage, please see the [official documentation](https://recallrai.com) or the source code repository on [GitHub](https://github.com/recallrai/sdk-python).
+

recallrai-0.1.0/README.md

@@ -0,0 +1,242 @@
+# RecallrAI Python SDK
+
+Official Python SDK for RecallrAI – a revolutionary contextual memory system that enables AI assistants to form meaningful connections between conversations, just like human memory.
+
+## Installation
+
+Install the SDK via Poetry or pip:
+
+```bash
+poetry add recallrai
+# or
+pip install recallrai
+```
+
+## Initialization
+
+Create a client instance with your API key and project ID:
+
+```python
+from recallrai import RecallrAI
+
+api_key = "rai_yourapikey"
+project_id = "project-uuid"
+client = RecallrAI(api_key=api_key, project_id=project_id)
+```
+
+## User Management
+
+### Create a User
+
+```python
+from recallrai.user import User
+
+user_id = "user123"
+metadata = {"key": "value"}
+user = client.create_user(user_id=user_id, metadata=metadata)
+print("Created user:", user.user_id)
+```
+
+### Get a User
+
+```python
+user = client.get_user("user123")
+print("User metadata:", user.metadata)
+```
+
+### List Users
+
+```python
+user_list = client.list_users(offset=0, limit=10)
+for user in user_list.users:
+    print(user.user_id, user.metadata)
+```
+
+### Update a User
+
+```python
+# Update the user's metadata and/or change the user ID
+updated_user = client.update_user(user_id="user123", new_metadata={"role": "user"}, new_user_id="user1234")
+print("Updated user id:", updated_user.user_id)
+```
+
+### Delete a User
+
+```python
+client.delete_user("user1234")
+print("User deleted.")
+```
+
+## Session Management
+
+### Create a Session
+
+```python
+from recallrai.session import Session
+
+# Create a session for a user; auto_process_after_minutes set to -1 disables auto-processing.
+session = client.create_session(user_id="user123", auto_process_after_minutes=5)
+print("Created session id:", session.session_id)
+```
+
+### Get an Existing Session
+
+```python
+# Retrieve an existing session by its ID
+session = client.get_session(user_id="user123", session_id="session-uuid")
+print("Session status:", session.get_status())
+```
+
+### List Sessions
+
+```python
+session_list = client.list_sessions(user_id="user123", offset=0, limit=10)
+for session in session_list.sessions:
+    print(session.session_id, session.status)
+```
+
+### Session – Adding Messages
+
+#### Add a User Message
+
+```python
+session.add_user_message("Hello! How are you?")
+```
+
+### Session – Retrieving Context
+
+```python
+context = session.get_context()
+print("Memory used:", context.memory_used)
+print("Context:", context.context)
+```
+
+#### Add an Assistant Message
+
+```python
+session.add_assistant_message("I'm an assistant. How can I help you?")
+```
+
+### Session – Process Session
+
+```python
+session.process()
+```
+
+### Session – Get Status and Messages
+
+```python
+status = session.get_status()
+print("Session status:", status)
+
+messages = session.get_messages()
+for message in messages:
+    print(f"{message.role}: {message.content} at {message.timestamp}")
+```
+
+## Example Usage with LLMs
+
+```python
+import openai
+from recallrai import RecallrAI
+
+# Initialize RecallrAI and OpenAI clients
+recallrai_client = RecallrAI(api_key="rai_yourapikey", project_id="project-uuid")
+openai_client = openai.OpenAI(api_key="your-openai-api-key")
+
+def chat_with_memory(user_id, session_id=None):
+    # Get or create user
+    try:
+        user = recallrai_client.get_user(user_id)
+    except:
+        user = recallrai_client.create_user(user_id)
+    
+    # Create a new session or get an existing one
+    if session_id:
+        session = recallrai_client.get_session(user_id=user_id, session_id=session_id)
+    else:
+        session = recallrai_client.create_session(user_id=user_id, auto_process_after_minutes=30)
+        print(f"Created new session: {session.session_id}")
+    
+    print("Chat session started. Type 'exit' to end the conversation.")
+    
+    while True:
+        # Get user input
+        user_message = input("You: ")
+        if user_message.lower() == 'exit':
+            break
+        
+        # Add the user message to RecallrAI
+        session.add_user_message(user_message)
+        
+        # Get context from RecallrAI after adding the user message
+        context = session.get_context()
+        
+        # Create a system prompt that includes the context
+        system_prompt = f"""You are a helpful assistant with memory of previous conversations.
+        
+        MEMORIES ABOUT THE USER:
+        {context.context}
+        
+        You can use the above memories to provide better responses to the user.
+        Don't mention that you have access to memories unless you are explicitly asked."""
+        
+        # Get previous messages
+        previous_messages = session.get_messages()
+        previous_messages = [{"role": message.role, "content": message.content} for message in previous_messages]
+
+        # Call the LLM with the system prompt and user message
+        response = openai_client.chat.completions.create(
+            model="gpt-4o-mini",
+            messages=[
+                {"role": "system", "content": system_prompt},
+                **previous_messages,
+            ],
+            temperature=0.7
+        )
+        
+        assistant_message = response.choices[0].message.content
+        
+        # Print the assistant's response
+        print(f"Assistant: {assistant_message}")
+        
+        # Add the assistant's response to RecallrAI
+        session.add_assistant_message(assistant_message)
+    
+    # Process the session at the end of the conversation
+    print("Processing session to update memory...")
+    session.process()
+    print(f"Session ended. Session ID: {session.session_id}")
+    return session.session_id
+
+# Example usage
+if __name__ == "__main__":
+    user_id = "user123"
+    # To continue a previous session, uncomment below and provide the session ID
+    # previous_session_id = "previously-saved-session-uuid"
+    # session_id = chat_with_memory(user_id, previous_session_id)
+    
+    # Start a new session
+    session_id = chat_with_memory(user_id)
+    print(f"To continue this conversation later, use session ID: {session_id}")
+```
+
+## Exception Handling
+
+> Exception handling will be improved in future.
+Each operation may raise custom exceptions defined in the SDK:
+
+```python
+from recallrai.utils.exceptions import NotFoundError, ValidationError
+
+try:
+    user = client.get_user("nonexistent_id")
+except NotFoundError as e:
+    print("User not found:", e.message)
+except ValidationError as e:
+    print("Invalid input:", e.message)
+```
+
+## Conclusion
+
+This README outlines the basic usage of the RecallrAI SDK functions for user and session management. For additional documentation and advanced usage, please see the [official documentation](https://recallrai.com) or the source code repository on [GitHub](https://github.com/recallrai/sdk-python).

recallrai-0.1.0/pyproject.toml

@@ -0,0 +1,34 @@
+[tool.poetry]
+name = "recallrai"
+version = "0.1.0"
+description = "Official Python SDK for RecallrAI - Revolutionary contextual memory system that enables AI assistants to form meaningful connections between conversations, just like human memory."
+authors = ["Devasheesh Mishra <devasheeshmishra4@gmail.com>"]
+license = "MIT License"
+readme = "README.md"
+repository = "https://github.com/recallrai/sdk-python"
+keywords = ["ai", "memory", "context", "llm", "mem0", "getzep", "zep"]
+homepage = "https://recallrai.com"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+]
+package-mode = true
+
+[tool.poetry.dependencies]
+python = ">=3.8,<4.0"
+httpx = "^0.25.0"
+pydantic = "^2.4.0"
+
+[tool.poetry.group.dev.dependencies]
+twine = "^5.1.1"
+ipykernel = "^6.29.5"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

recallrai-0.1.0/recallrai/__init__.py

@@ -0,0 +1,19 @@
+# Path: recallrai/__init__.py
+# Description: Package initialization file with SDK version and main class exports
+
+"""
+RecallrAI Python SDK
+
+This package provides a Python interface to interact with the RecallrAI API.
+"""
+
+from .client import RecallrAI
+from .user import User
+from .session import Session
+
+__version__ = "0.1.0"
+__all__ = [
+    "RecallrAI",
+    "User",
+    "Session",
+]