open-webui/backend/open_webui/models/chats.py

1235 lines
42 KiB
Python
Raw Normal View History

import logging
2023-12-26 05:44:28 +00:00
import json
import time
2024-08-27 22:10:27 +00:00
import uuid
from typing import Optional
2024-12-10 08:54:13 +00:00
from open_webui.internal.db import Base, get_db
from open_webui.models.tags import TagModel, Tag, Tags
2025-08-09 22:10:18 +00:00
from open_webui.models.folders import Folders
from open_webui.env import SRC_LOG_LEVELS
2024-10-11 06:22:53 +00:00
2024-08-27 22:10:27 +00:00
from pydantic import BaseModel, ConfigDict
from sqlalchemy import BigInteger, Boolean, Column, String, Text, JSON, Index
2024-10-11 06:22:53 +00:00
from sqlalchemy import or_, func, select, and_, text
from sqlalchemy.sql import exists
2025-06-13 11:05:33 +00:00
from sqlalchemy.sql.expression import bindparam
2023-12-26 05:44:28 +00:00
####################
# Chat DB Schema
####################
log = logging.getLogger(__name__)
log.setLevel(SRC_LOG_LEVELS["MODELS"])
2023-12-26 05:44:28 +00:00
2025-02-27 06:18:18 +00:00
class Chat(Base):
__tablename__ = "chat"
2024-04-20 23:24:18 +00:00
id = Column(String, primary_key=True, unique=True)
user_id = Column(String)
title = Column(Text)
chat = Column(JSON)
2024-04-20 23:24:18 +00:00
created_at = Column(BigInteger)
updated_at = Column(BigInteger)
2023-12-26 05:44:28 +00:00
share_id = Column(Text, unique=True, nullable=True)
archived = Column(Boolean, default=False)
2024-10-11 06:22:53 +00:00
pinned = Column(Boolean, default=False, nullable=True)
meta = Column(JSON, server_default="{}")
2024-10-17 04:05:03 +00:00
folder_id = Column(Text, nullable=True)
2023-12-26 05:44:28 +00:00
__table_args__ = (
# Performance indexes for common queries
# WHERE folder_id = ...
Index("folder_id_idx", "folder_id"),
# WHERE user_id = ... AND pinned = ...
Index("user_id_pinned_idx", "user_id", "pinned"),
# WHERE user_id = ... AND archived = ...
Index("user_id_archived_idx", "user_id", "archived"),
# WHERE user_id = ... ORDER BY updated_at DESC
Index("updated_at_user_id_idx", "updated_at", "user_id"),
# WHERE folder_id = ... AND user_id = ...
Index("folder_id_user_id_idx", "folder_id", "user_id"),
)
2023-12-26 05:44:28 +00:00
class ChatModel(BaseModel):
model_config = ConfigDict(from_attributes=True)
2023-12-26 05:44:28 +00:00
id: str
user_id: str
title: str
chat: dict
2024-04-20 23:24:18 +00:00
created_at: int # timestamp in epoch
updated_at: int # timestamp in epoch
share_id: Optional[str] = None
2024-04-20 22:03:39 +00:00
archived: bool = False
2024-10-11 06:22:53 +00:00
pinned: Optional[bool] = False
meta: dict = {}
2024-10-17 04:05:03 +00:00
folder_id: Optional[str] = None
2023-12-26 05:44:28 +00:00
####################
# Forms
####################
class ChatForm(BaseModel):
chat: dict
2025-07-12 18:14:41 +00:00
folder_id: Optional[str] = None
2023-12-26 05:44:28 +00:00
2024-10-14 22:29:43 +00:00
2024-10-18 03:13:28 +00:00
class ChatImportForm(ChatForm):
2024-10-21 01:02:41 +00:00
meta: Optional[dict] = {}
2024-10-18 03:13:28 +00:00
pinned: Optional[bool] = False
created_at: Optional[int] = None
updated_at: Optional[int] = None
2024-10-18 03:13:28 +00:00
class ChatsImportForm(BaseModel):
chats: list[ChatImportForm]
2024-10-12 16:12:31 +00:00
class ChatTitleMessagesForm(BaseModel):
title: str
messages: list[dict]
2023-12-26 05:44:28 +00:00
2024-10-14 22:29:43 +00:00
2023-12-26 18:41:55 +00:00
class ChatTitleForm(BaseModel):
title: str
2023-12-26 09:27:43 +00:00
class ChatResponse(BaseModel):
2023-12-26 05:44:28 +00:00
id: str
2023-12-26 09:27:43 +00:00
user_id: str
title: str
chat: dict
2024-04-20 23:24:18 +00:00
updated_at: int # timestamp in epoch
created_at: int # timestamp in epoch
share_id: Optional[str] = None # id of the chat to be shared
archived: bool
2024-10-11 06:22:53 +00:00
pinned: Optional[bool] = False
meta: dict = {}
folder_id: Optional[str] = None
2023-12-26 05:44:28 +00:00
class ChatTitleIdResponse(BaseModel):
id: str
title: str
2024-04-20 23:24:18 +00:00
updated_at: int
created_at: int
2023-12-26 05:44:28 +00:00
2025-12-10 17:22:40 +00:00
class ChatListResponse(BaseModel):
items: list[ChatModel]
total: int
class ChatUsageStatsResponse(BaseModel):
id: str # chat id
models: dict = {} # models used in the chat with their usage counts
message_count: int # number of messages in the chat
history_models: dict = {} # models used in the chat history with their usage counts
history_message_count: int # number of messages in the chat history
history_user_message_count: int # number of user messages in the chat history
history_assistant_message_count: (
int # number of assistant messages in the chat history
)
average_response_time: (
float # average response time of assistant messages in seconds
)
average_user_message_content_length: (
float # average length of user message contents
)
average_assistant_message_content_length: (
float # average length of assistant message contents
)
tags: list[str] = [] # tags associated with the chat
last_message_at: int # timestamp of the last message
updated_at: int
created_at: int
model_config = ConfigDict(extra="allow")
class ChatUsageStatsListResponse(BaseModel):
items: list[ChatUsageStatsResponse]
total: int
model_config = ConfigDict(extra="allow")
2023-12-26 05:44:28 +00:00
class ChatTable:
2025-11-23 01:50:27 +00:00
def _clean_null_bytes(self, obj):
"""
Recursively remove actual null bytes (\x00) and unicode escape \\u0000
from strings inside dict/list structures.
Safe for JSON objects.
"""
if isinstance(obj, str):
return obj.replace("\x00", "").replace("\u0000", "")
elif isinstance(obj, dict):
return {k: self._clean_null_bytes(v) for k, v in obj.items()}
elif isinstance(obj, list):
return [self._clean_null_bytes(v) for v in obj]
return obj
def _sanitize_chat_row(self, chat_item):
"""
Clean a Chat SQLAlchemy model's title + chat JSON,
and return True if anything changed.
"""
changed = False
# Clean title
if chat_item.title:
cleaned = self._clean_null_bytes(chat_item.title)
if cleaned != chat_item.title:
chat_item.title = cleaned
changed = True
# Clean JSON
if chat_item.chat:
cleaned = self._clean_null_bytes(chat_item.chat)
if cleaned != chat_item.chat:
chat_item.chat = cleaned
changed = True
return changed
2024-06-24 07:57:08 +00:00
def insert_new_chat(self, user_id: str, form_data: ChatForm) -> Optional[ChatModel]:
2024-07-04 06:32:39 +00:00
with get_db() as db:
id = str(uuid.uuid4())
chat = ChatModel(
**{
"id": id,
"user_id": user_id,
2025-11-23 01:50:27 +00:00
"title": self._clean_null_bytes(
2024-07-04 06:32:39 +00:00
form_data.chat["title"]
if "title" in form_data.chat
else "New Chat"
),
2025-11-23 01:50:27 +00:00
"chat": self._clean_null_bytes(form_data.chat),
2025-07-12 18:14:41 +00:00
"folder_id": form_data.folder_id,
2024-07-04 06:32:39 +00:00
"created_at": int(time.time()),
"updated_at": int(time.time()),
}
)
2025-11-23 01:50:27 +00:00
chat_item = Chat(**chat.model_dump())
db.add(chat_item)
2024-07-04 06:32:39 +00:00
db.commit()
2025-11-23 01:50:27 +00:00
db.refresh(chat_item)
return ChatModel.model_validate(chat_item) if chat_item else None
2024-10-18 03:13:28 +00:00
def _chat_import_form_to_chat_model(
2024-10-18 03:13:28 +00:00
self, user_id: str, form_data: ChatImportForm
) -> ChatModel:
id = str(uuid.uuid4())
chat = ChatModel(
**{
"id": id,
"user_id": user_id,
2025-11-23 01:50:27 +00:00
"title": self._clean_null_bytes(
form_data.chat["title"] if "title" in form_data.chat else "New Chat"
),
2025-11-23 01:50:27 +00:00
"chat": self._clean_null_bytes(form_data.chat),
"meta": form_data.meta,
"pinned": form_data.pinned,
"folder_id": form_data.folder_id,
"created_at": (
form_data.created_at if form_data.created_at else int(time.time())
),
"updated_at": (
form_data.updated_at if form_data.updated_at else int(time.time())
),
}
)
return chat
def import_chats(
2025-11-24 00:47:21 +00:00
self, user_id: str, chat_import_forms: list[ChatImportForm]
) -> list[ChatModel]:
2024-10-18 03:13:28 +00:00
with get_db() as db:
chats = []
2024-10-18 03:13:28 +00:00
2025-11-24 00:47:21 +00:00
for form_data in chat_import_forms:
chat = self._chat_import_form_to_chat_model(user_id, form_data)
chats.append(Chat(**chat.model_dump()))
db.add_all(chats)
2024-10-18 03:13:28 +00:00
db.commit()
return [ChatModel.model_validate(chat) for chat in chats]
2023-12-26 05:44:28 +00:00
2024-06-24 07:57:08 +00:00
def update_chat_by_id(self, id: str, chat: dict) -> Optional[ChatModel]:
try:
2024-07-04 06:32:39 +00:00
with get_db() as db:
chat_item = db.get(Chat, id)
2025-11-23 01:50:27 +00:00
chat_item.chat = self._clean_null_bytes(chat)
chat_item.title = (
self._clean_null_bytes(chat["title"])
if "title" in chat
else "New Chat"
)
chat_item.updated_at = int(time.time())
2025-11-23 01:50:27 +00:00
2024-07-04 06:32:39 +00:00
db.commit()
db.refresh(chat_item)
2024-07-04 06:32:39 +00:00
return ChatModel.model_validate(chat_item)
2024-08-27 22:10:27 +00:00
except Exception:
return None
2024-12-19 09:00:32 +00:00
def update_chat_title_by_id(self, id: str, title: str) -> Optional[ChatModel]:
chat = self.get_chat_by_id(id)
if chat is None:
return None
chat = chat.chat
chat["title"] = title
return self.update_chat_by_id(id, chat)
def update_chat_tags_by_id(
self, id: str, tags: list[str], user
) -> Optional[ChatModel]:
chat = self.get_chat_by_id(id)
if chat is None:
return None
self.delete_all_tags_by_id_and_user_id(id, user.id)
for tag in chat.meta.get("tags", []):
if self.count_chats_by_tag_name_and_user_id(tag, user.id) == 0:
Tags.delete_tag_by_name_and_user_id(tag, user.id)
for tag_name in tags:
if tag_name.lower() == "none":
continue
self.add_chat_tag_by_id_and_user_id_and_tag_name(id, user.id, tag_name)
return self.get_chat_by_id(id)
2024-12-19 23:14:09 +00:00
def get_chat_title_by_id(self, id: str) -> Optional[str]:
chat = self.get_chat_by_id(id)
if chat is None:
return None
return chat.chat.get("title", "New Chat")
2025-09-14 08:26:46 +00:00
def get_messages_map_by_chat_id(self, id: str) -> Optional[dict]:
2024-12-19 09:00:32 +00:00
chat = self.get_chat_by_id(id)
if chat is None:
return None
return chat.chat.get("history", {}).get("messages", {}) or {}
2024-12-29 03:31:03 +00:00
def get_message_by_id_and_message_id(
self, id: str, message_id: str
) -> Optional[dict]:
chat = self.get_chat_by_id(id)
if chat is None:
return None
return chat.chat.get("history", {}).get("messages", {}).get(message_id, {})
2024-12-19 09:00:32 +00:00
def upsert_message_to_chat_by_id_and_message_id(
self, id: str, message_id: str, message: dict
) -> Optional[ChatModel]:
chat = self.get_chat_by_id(id)
if chat is None:
return None
2025-06-13 11:05:33 +00:00
# Sanitize message content for null characters before upserting
if isinstance(message.get("content"), str):
message["content"] = message["content"].replace("\x00", "")
2024-12-19 09:00:32 +00:00
chat = chat.chat
history = chat.get("history", {})
if message_id in history.get("messages", {}):
history["messages"][message_id] = {
**history["messages"][message_id],
**message,
}
else:
history["messages"][message_id] = message
history["currentId"] = message_id
chat["history"] = history
return self.update_chat_by_id(id, chat)
2024-12-25 01:03:14 +00:00
def add_message_status_to_chat_by_id_and_message_id(
self, id: str, message_id: str, status: dict
) -> Optional[ChatModel]:
chat = self.get_chat_by_id(id)
if chat is None:
return None
chat = chat.chat
history = chat.get("history", {})
if message_id in history.get("messages", {}):
status_history = history["messages"][message_id].get("statusHistory", [])
status_history.append(status)
history["messages"][message_id]["statusHistory"] = status_history
chat["history"] = history
return self.update_chat_by_id(id, chat)
2025-11-19 07:16:09 +00:00
def add_message_files_by_id_and_message_id(
self, id: str, message_id: str, files: list[dict]
) -> list[dict]:
chat = self.get_chat_by_id(id)
if chat is None:
return None
chat = chat.chat
history = chat.get("history", {})
message_files = []
if message_id in history.get("messages", {}):
message_files = history["messages"][message_id].get("files", [])
message_files = message_files + files
history["messages"][message_id]["files"] = message_files
chat["history"] = history
self.update_chat_by_id(id, chat)
return message_files
2024-06-24 07:57:08 +00:00
def insert_shared_chat_by_chat_id(self, chat_id: str) -> Optional[ChatModel]:
2024-07-04 06:32:39 +00:00
with get_db() as db:
# Get the existing chat to share
chat = db.get(Chat, chat_id)
# Check if the chat is already shared
if chat.share_id:
return self.get_chat_by_id_and_user_id(chat.share_id, "shared")
# Create a new chat with the same data, but with a new ID
shared_chat = ChatModel(
**{
"id": str(uuid.uuid4()),
"user_id": f"shared-{chat_id}",
"title": chat.title,
"chat": chat.chat,
"meta": chat.meta,
"pinned": chat.pinned,
"folder_id": chat.folder_id,
2024-07-04 06:32:39 +00:00
"created_at": chat.created_at,
"updated_at": int(time.time()),
}
)
shared_result = Chat(**shared_chat.model_dump())
db.add(shared_result)
db.commit()
db.refresh(shared_result)
2024-07-08 06:01:15 +00:00
2024-07-04 06:32:39 +00:00
# Update the original chat with the share_id
result = (
db.query(Chat)
.filter_by(id=chat_id)
.update({"share_id": shared_chat.id})
)
2024-07-08 06:01:15 +00:00
db.commit()
2024-07-04 06:32:39 +00:00
return shared_chat if (shared_result and result) else None
2024-06-24 07:57:08 +00:00
def update_shared_chat_by_chat_id(self, chat_id: str) -> Optional[ChatModel]:
try:
2024-07-04 06:32:39 +00:00
with get_db() as db:
chat = db.get(Chat, chat_id)
2024-11-18 13:17:35 +00:00
shared_chat = (
db.query(Chat).filter_by(user_id=f"shared-{chat_id}").first()
)
if shared_chat is None:
return self.insert_shared_chat_by_chat_id(chat_id)
shared_chat.title = chat.title
shared_chat.chat = chat.chat
shared_chat.meta = chat.meta
shared_chat.pinned = chat.pinned
shared_chat.folder_id = chat.folder_id
2024-11-18 13:17:35 +00:00
shared_chat.updated_at = int(time.time())
2024-07-04 06:32:39 +00:00
db.commit()
2024-11-18 13:17:35 +00:00
db.refresh(shared_chat)
2024-07-04 06:32:39 +00:00
2024-11-18 13:17:35 +00:00
return ChatModel.model_validate(shared_chat)
2024-08-14 12:38:19 +00:00
except Exception:
return None
2024-04-02 14:42:37 +00:00
def delete_shared_chat_by_chat_id(self, chat_id: str) -> bool:
2024-04-02 13:33:59 +00:00
try:
2024-07-04 06:32:39 +00:00
with get_db() as db:
db.query(Chat).filter_by(user_id=f"shared-{chat_id}").delete()
2024-07-06 15:10:58 +00:00
db.commit()
2024-07-04 06:32:39 +00:00
return True
2024-08-14 12:38:19 +00:00
except Exception:
return False
def unarchive_all_chats_by_user_id(self, user_id: str) -> bool:
try:
with get_db() as db:
db.query(Chat).filter_by(user_id=user_id).update({"archived": False})
db.commit()
return True
except Exception:
2024-04-02 13:33:59 +00:00
return False
def update_chat_share_id_by_id(
self, id: str, share_id: Optional[str]
) -> Optional[ChatModel]:
try:
2024-07-04 06:32:39 +00:00
with get_db() as db:
chat = db.get(Chat, id)
chat.share_id = share_id
db.commit()
db.refresh(chat)
return ChatModel.model_validate(chat)
2024-08-14 12:38:19 +00:00
except Exception:
return None
2024-10-11 06:22:53 +00:00
def toggle_chat_pinned_by_id(self, id: str) -> Optional[ChatModel]:
try:
with get_db() as db:
chat = db.get(Chat, id)
chat.pinned = not chat.pinned
chat.updated_at = int(time.time())
db.commit()
db.refresh(chat)
return ChatModel.model_validate(chat)
except Exception:
return None
def toggle_chat_archive_by_id(self, id: str) -> Optional[ChatModel]:
2024-04-20 22:03:39 +00:00
try:
2024-07-04 06:32:39 +00:00
with get_db() as db:
chat = db.get(Chat, id)
chat.archived = not chat.archived
2025-11-23 05:05:27 +00:00
chat.folder_id = None
2024-10-11 06:22:53 +00:00
chat.updated_at = int(time.time())
2024-07-04 06:32:39 +00:00
db.commit()
db.refresh(chat)
return ChatModel.model_validate(chat)
2024-08-14 12:38:19 +00:00
except Exception:
2024-04-20 22:03:39 +00:00
return None
def archive_all_chats_by_user_id(self, user_id: str) -> bool:
2024-05-26 09:00:31 +00:00
try:
2024-07-04 06:32:39 +00:00
with get_db() as db:
db.query(Chat).filter_by(user_id=user_id).update({"archived": True})
2024-07-08 06:01:15 +00:00
db.commit()
2024-07-04 06:32:39 +00:00
return True
2024-08-14 12:38:19 +00:00
except Exception:
2024-05-26 09:00:31 +00:00
return False
2024-04-27 22:12:57 +00:00
def get_archived_chat_list_by_user_id(
2025-05-24 20:48:30 +00:00
self,
user_id: str,
filter: Optional[dict] = None,
skip: int = 0,
limit: int = 50,
2024-08-14 12:46:31 +00:00
) -> list[ChatModel]:
2025-05-24 20:48:30 +00:00
2024-07-04 06:32:39 +00:00
with get_db() as db:
2025-05-24 20:48:30 +00:00
query = db.query(Chat).filter_by(user_id=user_id, archived=True)
if filter:
query_key = filter.get("query")
if query_key:
query = query.filter(Chat.title.ilike(f"%{query_key}%"))
2025-05-24 21:23:12 +00:00
order_by = filter.get("order_by")
direction = filter.get("direction")
2025-10-20 04:48:01 +00:00
if order_by and direction:
if not getattr(Chat, order_by, None):
2025-10-20 04:48:01 +00:00
raise ValueError("Invalid order_by field")
2025-05-24 21:23:12 +00:00
if direction.lower() == "asc":
query = query.order_by(getattr(Chat, order_by).asc())
elif direction.lower() == "desc":
query = query.order_by(getattr(Chat, order_by).desc())
else:
raise ValueError("Invalid direction for ordering")
else:
query = query.order_by(Chat.updated_at.desc())
2025-05-24 20:48:30 +00:00
if skip:
query = query.offset(skip)
if limit:
query = query.limit(limit)
all_chats = query.all()
2024-07-04 06:32:39 +00:00
return [ChatModel.model_validate(chat) for chat in all_chats]
2024-04-20 23:24:18 +00:00
2024-04-27 22:12:57 +00:00
def get_chat_list_by_user_id(
2024-05-26 09:00:31 +00:00
self,
user_id: str,
include_archived: bool = False,
2025-05-24 21:44:53 +00:00
filter: Optional[dict] = None,
2024-05-26 09:00:31 +00:00
skip: int = 0,
limit: int = 50,
2024-08-14 12:46:31 +00:00
) -> list[ChatModel]:
2024-07-04 06:32:39 +00:00
with get_db() as db:
query = db.query(Chat).filter_by(user_id=user_id)
2024-07-04 06:32:39 +00:00
if not include_archived:
query = query.filter_by(archived=False)
2024-10-15 04:21:45 +00:00
2025-05-24 21:44:53 +00:00
if filter:
query_key = filter.get("query")
if query_key:
query = query.filter(Chat.title.ilike(f"%{query_key}%"))
order_by = filter.get("order_by")
direction = filter.get("direction")
if order_by and direction and getattr(Chat, order_by):
if direction.lower() == "asc":
query = query.order_by(getattr(Chat, order_by).asc())
elif direction.lower() == "desc":
query = query.order_by(getattr(Chat, order_by).desc())
else:
raise ValueError("Invalid direction for ordering")
else:
query = query.order_by(Chat.updated_at.desc())
2024-10-15 04:21:45 +00:00
if skip:
query = query.offset(skip)
if limit:
query = query.limit(limit)
all_chats = query.all()
2024-07-04 06:32:39 +00:00
return [ChatModel.model_validate(chat) for chat in all_chats]
2024-07-22 18:45:47 +00:00
def get_chat_title_id_list_by_user_id(
self,
user_id: str,
include_archived: bool = False,
include_folders: bool = False,
2025-10-14 23:06:29 +00:00
include_pinned: bool = False,
2024-08-26 10:27:00 +00:00
skip: Optional[int] = None,
limit: Optional[int] = None,
2024-08-14 12:46:31 +00:00
) -> list[ChatTitleIdResponse]:
with get_db() as db:
query = db.query(Chat).filter_by(user_id=user_id)
if not include_folders:
query = query.filter_by(folder_id=None)
2025-10-14 23:06:29 +00:00
if not include_pinned:
query = query.filter(or_(Chat.pinned == False, Chat.pinned == None))
2024-10-15 10:11:03 +00:00
if not include_archived:
query = query.filter_by(archived=False)
2024-08-26 10:27:00 +00:00
query = query.order_by(Chat.updated_at.desc()).with_entities(
Chat.id, Chat.title, Chat.updated_at, Chat.created_at
)
2024-08-26 10:27:00 +00:00
if skip:
query = query.offset(skip)
2024-10-09 06:37:37 +00:00
if limit:
query = query.limit(limit)
2024-08-26 10:27:00 +00:00
all_chats = query.all()
2025-05-05 12:14:59 +00:00
# result has to be destructured from sqlalchemy `row` and mapped to a dict since the `ChatModel`is not the returned dataclass.
2024-07-24 10:25:07 +00:00
return [
ChatTitleIdResponse.model_validate(
{
"id": chat[0],
"title": chat[1],
"updated_at": chat[2],
"created_at": chat[3],
}
2024-07-22 18:45:47 +00:00
)
2024-07-24 10:25:07 +00:00
for chat in all_chats
]
2023-12-26 05:44:28 +00:00
2024-04-27 22:12:57 +00:00
def get_chat_list_by_chat_ids(
2024-08-14 12:46:31 +00:00
self, chat_ids: list[str], skip: int = 0, limit: int = 50
) -> list[ChatModel]:
2024-07-04 06:32:39 +00:00
with get_db() as db:
all_chats = (
db.query(Chat)
.filter(Chat.id.in_(chat_ids))
.filter_by(archived=False)
.order_by(Chat.updated_at.desc())
.all()
)
return [ChatModel.model_validate(chat) for chat in all_chats]
def get_chat_by_id(self, id: str) -> Optional[ChatModel]:
2024-04-02 14:04:29 +00:00
try:
2024-07-04 06:32:39 +00:00
with get_db() as db:
2025-11-23 01:50:27 +00:00
chat_item = db.get(Chat, id)
if chat_item is None:
return None
if self._sanitize_chat_row(chat_item):
db.commit()
db.refresh(chat_item)
return ChatModel.model_validate(chat_item)
2024-08-14 12:38:19 +00:00
except Exception:
2024-04-02 14:04:29 +00:00
return None
def get_chat_by_share_id(self, id: str) -> Optional[ChatModel]:
2024-04-07 08:21:12 +00:00
try:
2024-07-04 06:32:39 +00:00
with get_db() as db:
# it is possible that the shared link was deleted. hence,
# we check if the chat is still shared by checking if a chat with the share_id exists
2024-07-04 06:32:39 +00:00
chat = db.query(Chat).filter_by(share_id=id).first()
if chat:
return self.get_chat_by_id(id)
else:
return None
2024-08-27 22:10:27 +00:00
except Exception:
2024-04-07 08:21:12 +00:00
return None
2024-06-24 07:57:08 +00:00
def get_chat_by_id_and_user_id(self, id: str, user_id: str) -> Optional[ChatModel]:
2023-12-26 05:44:28 +00:00
try:
2024-07-04 06:32:39 +00:00
with get_db() as db:
chat = db.query(Chat).filter_by(id=id, user_id=user_id).first()
return ChatModel.model_validate(chat)
2024-08-14 12:38:19 +00:00
except Exception:
2023-12-26 05:44:28 +00:00
return None
2024-08-14 12:46:31 +00:00
def get_chats(self, skip: int = 0, limit: int = 50) -> list[ChatModel]:
2024-07-04 06:32:39 +00:00
with get_db() as db:
all_chats = (
db.query(Chat)
# .limit(limit).offset(skip)
.order_by(Chat.updated_at.desc())
)
return [ChatModel.model_validate(chat) for chat in all_chats]
2025-12-10 17:22:40 +00:00
def get_chats_by_user_id(
self, user_id: str, skip: Optional[int] = None, limit: Optional[int] = None
) -> ChatListResponse:
2024-07-04 06:32:39 +00:00
with get_db() as db:
2025-12-10 17:22:40 +00:00
query = (
2024-07-04 06:32:39 +00:00
db.query(Chat)
.filter_by(user_id=user_id)
.order_by(Chat.updated_at.desc())
)
2025-12-10 17:22:40 +00:00
total = query.count()
if skip is not None:
query = query.offset(skip)
if limit is not None:
query = query.limit(limit)
all_chats = query.all()
return ChatListResponse(
**{
"items": [ChatModel.model_validate(chat) for chat in all_chats],
"total": total,
}
)
2024-10-11 06:22:53 +00:00
def get_pinned_chats_by_user_id(self, user_id: str) -> list[ChatModel]:
with get_db() as db:
all_chats = (
db.query(Chat)
2024-10-14 22:29:43 +00:00
.filter_by(user_id=user_id, pinned=True, archived=False)
2024-10-11 06:22:53 +00:00
.order_by(Chat.updated_at.desc())
)
return [ChatModel.model_validate(chat) for chat in all_chats]
2024-08-14 12:46:31 +00:00
def get_archived_chats_by_user_id(self, user_id: str) -> list[ChatModel]:
2024-07-04 06:32:39 +00:00
with get_db() as db:
all_chats = (
db.query(Chat)
.filter_by(user_id=user_id, archived=True)
.order_by(Chat.updated_at.desc())
)
return [ChatModel.model_validate(chat) for chat in all_chats]
2024-10-09 06:37:37 +00:00
def get_chats_by_user_id_and_search_text(
self,
user_id: str,
search_text: str,
include_archived: bool = False,
skip: int = 0,
limit: int = 60,
) -> list[ChatModel]:
"""
Filters chats based on a search query using Python, allowing pagination using skip and limit.
"""
2025-06-13 11:05:33 +00:00
search_text = search_text.replace("\u0000", "").lower().strip()
2024-10-15 00:31:52 +00:00
2024-10-09 06:37:37 +00:00
if not search_text:
2025-05-24 21:44:53 +00:00
return self.get_chat_list_by_user_id(
user_id, include_archived, filter={}, skip=skip, limit=limit
)
2024-10-09 06:37:37 +00:00
2024-10-15 00:31:52 +00:00
search_text_words = search_text.split(" ")
# search_text might contain 'tag:tag_name' format so we need to extract the tag_name, split the search_text and remove the tags
2024-10-15 02:02:08 +00:00
tag_ids = [
2024-10-15 05:57:11 +00:00
word.replace("tag:", "").replace(" ", "_").lower()
for word in search_text_words
if word.startswith("tag:")
2024-10-15 02:02:08 +00:00
]
2024-10-15 05:57:11 +00:00
2025-08-09 22:10:18 +00:00
# Extract folder names - handle spaces and case insensitivity
folders = Folders.search_folders_by_names(
user_id,
[
word.replace("folder:", "")
for word in search_text_words
if word.startswith("folder:")
],
)
folder_ids = [folder.id for folder in folders]
is_pinned = None
if "pinned:true" in search_text_words:
is_pinned = True
elif "pinned:false" in search_text_words:
is_pinned = False
is_archived = None
if "archived:true" in search_text_words:
is_archived = True
elif "archived:false" in search_text_words:
is_archived = False
is_shared = None
if "shared:true" in search_text_words:
is_shared = True
elif "shared:false" in search_text_words:
is_shared = False
2024-10-15 02:02:08 +00:00
search_text_words = [
word
for word in search_text_words
if (
not word.startswith("tag:")
and not word.startswith("folder:")
and not word.startswith("pinned:")
and not word.startswith("archived:")
and not word.startswith("shared:")
)
2024-10-15 02:02:08 +00:00
]
2024-10-15 00:31:52 +00:00
search_text = " ".join(search_text_words)
2024-10-09 06:37:37 +00:00
with get_db() as db:
query = db.query(Chat).filter(Chat.user_id == user_id)
if is_archived is not None:
query = query.filter(Chat.archived == is_archived)
elif not include_archived:
2024-10-09 06:37:37 +00:00
query = query.filter(Chat.archived == False)
if is_pinned is not None:
query = query.filter(Chat.pinned == is_pinned)
if is_shared is not None:
if is_shared:
query = query.filter(Chat.share_id.isnot(None))
else:
query = query.filter(Chat.share_id.is_(None))
2025-08-09 22:10:18 +00:00
if folder_ids:
query = query.filter(Chat.folder_id.in_(folder_ids))
2024-10-11 07:00:13 +00:00
query = query.order_by(Chat.updated_at.desc())
# Check if the database dialect is either 'sqlite' or 'postgresql'
dialect_name = db.bind.dialect.name
if dialect_name == "sqlite":
# SQLite case: using JSON1 extension for JSON searching
2025-06-13 11:05:33 +00:00
sqlite_content_sql = (
"EXISTS ("
" SELECT 1 "
" FROM json_each(Chat.chat, '$.messages') AS message "
" WHERE LOWER(message.value->>'content') LIKE '%' || :content_key || '%'"
")"
)
sqlite_content_clause = text(sqlite_content_sql)
2024-10-11 07:00:13 +00:00
query = query.filter(
2025-06-13 11:05:33 +00:00
or_(
2025-07-12 18:14:41 +00:00
Chat.title.ilike(bindparam("title_key")), sqlite_content_clause
2025-06-13 11:05:33 +00:00
).params(title_key=f"%{search_text}%", content_key=search_text)
2024-10-11 07:00:13 +00:00
)
2024-10-15 00:31:52 +00:00
# Check if there are any tags to filter, it should have all the tags
2024-10-20 04:16:59 +00:00
if "none" in tag_ids:
query = query.filter(
text(
"""
NOT EXISTS (
SELECT 1
FROM json_each(Chat.meta, '$.tags') AS tag
)
"""
)
)
elif tag_ids:
2024-10-15 00:31:52 +00:00
query = query.filter(
and_(
*[
text(
f"""
EXISTS (
SELECT 1
FROM json_each(Chat.meta, '$.tags') AS tag
2024-10-15 05:57:11 +00:00
WHERE tag.value = :tag_id_{tag_idx}
2024-10-15 00:31:52 +00:00
)
"""
2024-10-15 05:57:11 +00:00
).params(**{f"tag_id_{tag_idx}": tag_id})
for tag_idx, tag_id in enumerate(tag_ids)
2024-10-15 00:31:52 +00:00
]
)
)
2024-10-11 07:00:13 +00:00
elif dialect_name == "postgresql":
# PostgreSQL doesn't allow null bytes in text. We filter those out by checking
# the JSON representation for \u0000 before attempting text extraction
# Safety filter: JSON field must not contain \u0000
query = query.filter(text("Chat.chat::text NOT LIKE '%\\\\u0000%'"))
# Safety filter: title must not contain actual null bytes
query = query.filter(text("Chat.title::text NOT LIKE '%\\x00%'"))
2025-11-21 23:31:03 +00:00
postgres_content_sql = """
EXISTS (
SELECT 1
FROM json_array_elements(Chat.chat->'messages') AS message
WHERE json_typeof(message->'content') = 'string'
AND LOWER(message->>'content') LIKE '%' || :content_key || '%'
2025-11-21 23:31:03 +00:00
)
"""
postgres_content_clause = text(postgres_content_sql)
2024-10-11 07:00:13 +00:00
query = query.filter(
2025-06-13 11:05:33 +00:00
or_(
2025-07-12 18:14:41 +00:00
Chat.title.ilike(bindparam("title_key")),
postgres_content_clause,
)
).params(title_key=f"%{search_text}%", content_key=search_text.lower())
2024-10-15 00:31:52 +00:00
# Check if there are any tags to filter, it should have all the tags
2024-10-20 04:16:59 +00:00
if "none" in tag_ids:
query = query.filter(
text(
"""
NOT EXISTS (
SELECT 1
FROM json_array_elements_text(Chat.meta->'tags') AS tag
)
"""
)
)
elif tag_ids:
2024-10-15 00:31:52 +00:00
query = query.filter(
and_(
*[
text(
f"""
EXISTS (
SELECT 1
FROM json_array_elements_text(Chat.meta->'tags') AS tag
2024-10-15 05:57:11 +00:00
WHERE tag = :tag_id_{tag_idx}
2024-10-15 00:31:52 +00:00
)
"""
2024-10-15 05:57:11 +00:00
).params(**{f"tag_id_{tag_idx}": tag_id})
for tag_idx, tag_id in enumerate(tag_ids)
2024-10-15 00:31:52 +00:00
]
)
)
2024-10-11 07:00:13 +00:00
else:
raise NotImplementedError(
f"Unsupported dialect: {db.bind.dialect.name}"
)
2024-10-09 06:37:37 +00:00
2024-10-11 07:00:13 +00:00
# Perform pagination at the SQL level
all_chats = query.offset(skip).limit(limit).all()
2024-10-09 06:37:37 +00:00
log.info(f"The number of chats: {len(all_chats)}")
2024-10-15 04:21:45 +00:00
2024-10-11 07:00:13 +00:00
# Validate and return chats
return [ChatModel.model_validate(chat) for chat in all_chats]
2024-10-09 06:37:37 +00:00
2024-10-17 04:05:03 +00:00
def get_chats_by_folder_id_and_user_id(
2025-09-27 01:48:17 +00:00
self, folder_id: str, user_id: str, skip: int = 0, limit: int = 60
2024-10-17 04:05:03 +00:00
) -> list[ChatModel]:
with get_db() as db:
2024-10-18 02:09:01 +00:00
query = db.query(Chat).filter_by(folder_id=folder_id, user_id=user_id)
2024-10-18 21:18:13 +00:00
query = query.filter(or_(Chat.pinned == False, Chat.pinned == None))
2024-10-18 02:09:01 +00:00
query = query.filter_by(archived=False)
query = query.order_by(Chat.updated_at.desc())
2025-09-27 01:48:17 +00:00
if skip:
query = query.offset(skip)
if limit:
query = query.limit(limit)
2024-10-18 02:09:01 +00:00
all_chats = query.all()
2024-10-17 04:05:03 +00:00
return [ChatModel.model_validate(chat) for chat in all_chats]
2024-10-19 09:42:12 +00:00
def get_chats_by_folder_ids_and_user_id(
self, folder_ids: list[str], user_id: str
) -> list[ChatModel]:
with get_db() as db:
query = db.query(Chat).filter(
Chat.folder_id.in_(folder_ids), Chat.user_id == user_id
)
query = query.filter(or_(Chat.pinned == False, Chat.pinned == None))
query = query.filter_by(archived=False)
query = query.order_by(Chat.updated_at.desc())
all_chats = query.all()
return [ChatModel.model_validate(chat) for chat in all_chats]
2024-10-17 04:05:03 +00:00
def update_chat_folder_id_by_id_and_user_id(
self, id: str, user_id: str, folder_id: str
) -> Optional[ChatModel]:
try:
with get_db() as db:
chat = db.get(Chat, id)
chat.folder_id = folder_id
chat.updated_at = int(time.time())
2024-10-18 21:18:13 +00:00
chat.pinned = False
2024-10-17 04:05:03 +00:00
db.commit()
db.refresh(chat)
return ChatModel.model_validate(chat)
except Exception:
return None
2024-10-11 06:22:53 +00:00
def get_chat_tags_by_id_and_user_id(self, id: str, user_id: str) -> list[TagModel]:
with get_db() as db:
chat = db.get(Chat, id)
tags = chat.meta.get("tags", [])
return [Tags.get_tag_by_name_and_user_id(tag, user_id) for tag in tags]
def get_chat_list_by_user_id_and_tag_name(
self, user_id: str, tag_name: str, skip: int = 0, limit: int = 50
) -> list[ChatModel]:
with get_db() as db:
query = db.query(Chat).filter_by(user_id=user_id)
tag_id = tag_name.replace(" ", "_").lower()
log.info(f"DB dialect name: {db.bind.dialect.name}")
2024-10-11 06:22:53 +00:00
if db.bind.dialect.name == "sqlite":
# SQLite JSON1 querying for tags within the meta JSON field
query = query.filter(
text(
f"EXISTS (SELECT 1 FROM json_each(Chat.meta, '$.tags') WHERE json_each.value = :tag_id)"
)
).params(tag_id=tag_id)
elif db.bind.dialect.name == "postgresql":
# PostgreSQL JSON query for tags within the meta JSON field (for `json` type)
query = query.filter(
text(
"EXISTS (SELECT 1 FROM json_array_elements_text(Chat.meta->'tags') elem WHERE elem = :tag_id)"
)
).params(tag_id=tag_id)
else:
raise NotImplementedError(
f"Unsupported dialect: {db.bind.dialect.name}"
)
all_chats = query.all()
log.debug(f"all_chats: {all_chats}")
2024-10-11 06:22:53 +00:00
return [ChatModel.model_validate(chat) for chat in all_chats]
def add_chat_tag_by_id_and_user_id_and_tag_name(
self, id: str, user_id: str, tag_name: str
) -> Optional[ChatModel]:
tag = Tags.get_tag_by_name_and_user_id(tag_name, user_id)
if tag is None:
tag = Tags.insert_new_tag(tag_name, user_id)
try:
with get_db() as db:
chat = db.get(Chat, id)
tag_id = tag.id
if tag_id not in chat.meta.get("tags", []):
chat.meta = {
**chat.meta,
2024-10-15 06:04:10 +00:00
"tags": list(set(chat.meta.get("tags", []) + [tag_id])),
2024-10-11 06:22:53 +00:00
}
db.commit()
db.refresh(chat)
return ChatModel.model_validate(chat)
except Exception:
return None
def count_chats_by_tag_name_and_user_id(self, tag_name: str, user_id: str) -> int:
with get_db() as db: # Assuming `get_db()` returns a session object
2024-10-15 05:57:11 +00:00
query = db.query(Chat).filter_by(user_id=user_id, archived=False)
2024-10-11 06:22:53 +00:00
# Normalize the tag_name for consistency
tag_id = tag_name.replace(" ", "_").lower()
if db.bind.dialect.name == "sqlite":
# SQLite JSON1 support for querying the tags inside the `meta` JSON field
query = query.filter(
text(
f"EXISTS (SELECT 1 FROM json_each(Chat.meta, '$.tags') WHERE json_each.value = :tag_id)"
)
).params(tag_id=tag_id)
elif db.bind.dialect.name == "postgresql":
# PostgreSQL JSONB support for querying the tags inside the `meta` JSON field
query = query.filter(
text(
"EXISTS (SELECT 1 FROM json_array_elements_text(Chat.meta->'tags') elem WHERE elem = :tag_id)"
)
).params(tag_id=tag_id)
else:
raise NotImplementedError(
f"Unsupported dialect: {db.bind.dialect.name}"
)
# Get the count of matching records
count = query.count()
# Debugging output for inspection
log.info(f"Count of chats for tag '{tag_name}': {count}")
2024-10-11 06:22:53 +00:00
return count
2025-09-24 14:04:54 +00:00
def count_chats_by_folder_id_and_user_id(self, folder_id: str, user_id: str) -> int:
with get_db() as db:
query = db.query(Chat).filter_by(user_id=user_id)
query = query.filter_by(folder_id=folder_id)
count = query.count()
log.info(f"Count of chats for folder '{folder_id}': {count}")
return count
2024-10-11 06:22:53 +00:00
def delete_tag_by_id_and_user_id_and_tag_name(
self, id: str, user_id: str, tag_name: str
) -> bool:
try:
with get_db() as db:
chat = db.get(Chat, id)
tags = chat.meta.get("tags", [])
tag_id = tag_name.replace(" ", "_").lower()
tags = [tag for tag in tags if tag != tag_id]
chat.meta = {
**chat.meta,
2024-10-15 06:04:10 +00:00
"tags": list(set(tags)),
2024-10-11 06:22:53 +00:00
}
db.commit()
return True
except Exception:
return False
def delete_all_tags_by_id_and_user_id(self, id: str, user_id: str) -> bool:
try:
with get_db() as db:
chat = db.get(Chat, id)
chat.meta = {
**chat.meta,
"tags": [],
}
db.commit()
return True
except Exception:
return False
def delete_chat_by_id(self, id: str) -> bool:
2024-04-27 22:24:59 +00:00
try:
2024-07-04 06:32:39 +00:00
with get_db() as db:
db.query(Chat).filter_by(id=id).delete()
2024-07-06 15:10:58 +00:00
db.commit()
2024-04-27 22:24:59 +00:00
2024-07-04 06:32:39 +00:00
return True and self.delete_shared_chat_by_chat_id(id)
2024-08-14 12:38:19 +00:00
except Exception:
2024-04-27 22:24:59 +00:00
return False
def delete_chat_by_id_and_user_id(self, id: str, user_id: str) -> bool:
2023-12-26 09:27:43 +00:00
try:
2024-07-04 06:32:39 +00:00
with get_db() as db:
db.query(Chat).filter_by(id=id, user_id=user_id).delete()
2024-07-06 15:10:58 +00:00
db.commit()
2024-07-04 06:32:39 +00:00
return True and self.delete_shared_chat_by_chat_id(id)
2024-08-14 12:38:19 +00:00
except Exception:
2023-12-26 09:27:43 +00:00
return False
def delete_chats_by_user_id(self, user_id: str) -> bool:
2023-12-29 07:17:58 +00:00
try:
2024-07-04 06:32:39 +00:00
with get_db() as db:
self.delete_shared_chats_by_user_id(user_id)
db.query(Chat).filter_by(user_id=user_id).delete()
2024-07-06 15:10:58 +00:00
db.commit()
2024-07-04 06:32:39 +00:00
return True
2024-08-14 12:38:19 +00:00
except Exception:
2024-04-02 14:55:56 +00:00
return False
2024-10-18 01:24:58 +00:00
def delete_chats_by_user_id_and_folder_id(
self, user_id: str, folder_id: str
) -> bool:
try:
with get_db() as db:
db.query(Chat).filter_by(user_id=user_id, folder_id=folder_id).delete()
db.commit()
return True
except Exception:
return False
def move_chats_by_user_id_and_folder_id(
self, user_id: str, folder_id: str, new_folder_id: Optional[str]
) -> bool:
try:
with get_db() as db:
db.query(Chat).filter_by(user_id=user_id, folder_id=folder_id).update(
{"folder_id": new_folder_id}
)
db.commit()
return True
except Exception:
return False
def delete_shared_chats_by_user_id(self, user_id: str) -> bool:
2024-04-02 14:55:56 +00:00
try:
2024-07-04 06:32:39 +00:00
with get_db() as db:
chats_by_user = db.query(Chat).filter_by(user_id=user_id).all()
shared_chat_ids = [f"shared-{chat.id}" for chat in chats_by_user]
db.query(Chat).filter(Chat.user_id.in_(shared_chat_ids)).delete()
2024-07-06 15:10:58 +00:00
db.commit()
2024-04-02 14:55:56 +00:00
2024-07-04 06:32:39 +00:00
return True
2024-08-14 12:38:19 +00:00
except Exception:
2023-12-29 07:17:58 +00:00
return False
2023-12-26 05:44:28 +00:00
Chats = ChatTable()