feat: log search queries and results

cognee-frontend/src/modules/chat/getHistory.ts

@@ -0,0 +1,8 @@
+import { fetch } from '@/utils';
+
+export default function getHistory() {
+  return fetch(
+    '/v1/search',
+  )
+    .then((response) => response.json());
+}

cognee-frontend/src/ui/Partials/SearchView/SearchView.tsx

@@ -1,9 +1,12 @@
+'use client';
+
 import { v4 } from 'uuid';
 import classNames from 'classnames';
-import { useCallback, useState } from 'react';
+import { useCallback, useEffect, useState } from 'react';
 import { CTAButton, Stack, Text, DropdownSelect, TextArea, useBoolean } from 'ohmy-ui';
 import { fetch } from '@/utils';
 import styles from './SearchView.module.css';
+import getHistory from '@/modules/chat/getHistory';
 
 interface Message {
   id: string;
@@ -52,6 +55,14 @@ export default function SearchView() {
     }, 300);
   }, []);
 
+  useEffect(() => {
+    getHistory()
+      .then((history) => {
+        setMessages(history);
+        scrollToBottom();
+      });
+  }, [scrollToBottom]);
+
   const handleSearchSubmit = useCallback((event: React.FormEvent<HTMLFormElement>) => {
     event.preventDefault();
 
@@ -78,7 +89,7 @@ export default function SearchView() {
         'Content-Type': 'application/json',
       },
       body: JSON.stringify({
-        query: inputValue,
+        query: inputValue.trim(),
         searchType: searchTypeValue,
       }),
     })

cognee/__init__.py

@@ -2,7 +2,7 @@
 from .api.v1.add import add
 from .api.v1.cognify import cognify
 from .api.v1.datasets.datasets import datasets
-from .api.v1.search import search, SearchType
+from .api.v1.search import search, SearchType, get_search_history
 from .api.v1.prune import prune
 
 # Pipelines

cognee/api/client.py

@@ -15,6 +15,7 @@
 
 from cognee.api.DTO import InDTO, OutDTO
 from cognee.api.v1.search import SearchType
+from cognee.modules.search.operations import get_history
 from cognee.modules.users.models import User
 from cognee.modules.users.methods import get_authenticated_user
 from cognee.modules.pipelines.models import PipelineRunStatus
@@ -350,6 +351,24 @@ async def search(payload: SearchPayloadDTO, user: User = Depends(get_authenticat
             content = {"error": str(error)}
         )
 
+class SearchHistoryItem(OutDTO):
+    id: UUID
+    text: str
+    user: str
+    created_at: datetime
+
+@app.get("/api/v1/search", response_model = list[SearchHistoryItem])
+async def get_search_history(user: User = Depends(get_authenticated_user)):
+    try:
+        history = await get_history(user.id)
+
+        return history
+    except Exception as error:
+        return JSONResponse(
+            status_code = 500,
+            content = {"error": str(error)}
+        )
+
 from cognee.modules.settings.get_settings import LLMConfig, VectorDBConfig
 
 class LLMConfigDTO(OutDTO, LLMConfig):

cognee/api/v1/search/__init__.py

@@ -1 +1,2 @@
 from .search_v2 import search, SearchType
+from .get_search_history import get_search_history

cognee/api/v1/search/get_search_history.py

@@ -0,0 +1,9 @@
+from cognee.modules.search.operations import get_history
+from cognee.modules.users.methods import get_default_user
+from cognee.modules.users.models import User
+
+async def get_search_history(user: User = None) -> list:
+    if not user:
+        user = await get_default_user()
+
+    return await get_history(user.id)

cognee/api/v1/search/search_v2.py

@@ -1,6 +1,8 @@
+import json
 from uuid import UUID
 from enum import Enum
 from typing import Callable, Dict
+from cognee.modules.search.operations import log_query, log_result
 from cognee.shared.utils import send_telemetry
 from cognee.modules.users.models import User
 from cognee.modules.users.methods import get_default_user
@@ -14,15 +16,17 @@ class SearchType(Enum):
     INSIGHTS = "INSIGHTS"
     CHUNKS = "CHUNKS"
 
-async def search(search_type: SearchType, query: str, user: User = None) -> list:
+async def search(query_type: SearchType, query_text: str, user: User = None) -> list:
     if user is None:
         user = await get_default_user()
 
     if user is None:
         raise PermissionError("No user found in the system. Please create a user.")
 
+    query = await log_query(query_text, str(query_type), user.id)
+
     own_document_ids = await get_document_ids_for_user(user.id)
-    search_results = await specific_search(search_type, query, user)
+    search_results = await specific_search(query_type, query_text, user)
 
     filtered_search_results = []
 
@@ -33,19 +37,21 @@ async def search(search_type: SearchType, query: str, user: User = None) -> list
         if document_id is None or document_id in own_document_ids:
             filtered_search_results.append(search_result)
 
+    await log_result(query.id, json.dumps(filtered_search_results), user.id)
+
     return filtered_search_results
 
-async def specific_search(search_type: SearchType, query: str, user) -> list:
+async def specific_search(query_type: SearchType, query: str, user) -> list:
     search_tasks: Dict[SearchType, Callable] = {
         SearchType.SUMMARIES: query_summaries,
         SearchType.INSIGHTS: query_graph_connections,
         SearchType.CHUNKS: query_chunks,
     }
 
-    search_task = search_tasks.get(search_type)
+    search_task = search_tasks.get(query_type)
 
     if search_task is None:
-        raise ValueError(f"Unsupported search type: {search_type}")
+        raise ValueError(f"Unsupported search type: {query_type}")
 
     send_telemetry("cognee.search EXECUTION STARTED", user.id)
 

cognee/modules/search/models/Query.py

@@ -0,0 +1,16 @@
+from uuid import uuid4
+from datetime import datetime, timezone
+from sqlalchemy import Column, DateTime, String
+from cognee.infrastructure.databases.relational import Base, UUID
+
+class Query(Base):
+    __tablename__ = "queries"
+
+    id = Column(UUID, primary_key = True, default = uuid4)
+
+    text = Column(String)
+    query_type = Column(String)
+    user_id = Column(UUID)
+
+    created_at = Column(DateTime(timezone = True), default = lambda: datetime.now(timezone.utc))
+    updated_at = Column(DateTime(timezone = True), onupdate = lambda: datetime.now(timezone.utc))

cognee/modules/search/models/Result.py

@@ -0,0 +1,16 @@
+from datetime import datetime, timezone
+from uuid import uuid4
+from sqlalchemy import Column, DateTime, Text
+from cognee.infrastructure.databases.relational import Base, UUID
+
+class Result(Base):
+    __tablename__ = "results"
+
+    id = Column(UUID, primary_key = True, default = uuid4)
+
+    value = Column(Text)
+    query_id = Column(UUID)
+    user_id = Column(UUID)
+
+    created_at = Column(DateTime(timezone = True), default = lambda: datetime.now(timezone.utc))
+    updated_at = Column(DateTime(timezone = True), onupdate = lambda: datetime.now(timezone.utc))

cognee/modules/search/operations/__init__.py

@@ -0,0 +1,3 @@
+from .log_query import log_query
+from .log_result import log_result
+from .get_history import get_history

cognee/modules/search/operations/get_history.py

@@ -0,0 +1,31 @@
+from uuid import UUID
+from sqlalchemy import literal, select
+from cognee.infrastructure.databases.relational import get_relational_engine
+from ..models.Query import Query
+from ..models.Result import Result
+
+async def get_history(user_id: UUID, limit: int = 10) -> list[Result]:
+    db_engine = get_relational_engine()
+
+    queries_query = select(
+        Query.id,
+        Query.text.label("text"),
+        Query.created_at,
+        literal("user").label("user")
+    ) \
+        .filter(Query.user_id == user_id)
+
+    results_query = select(
+        Result.id,
+        Result.value.label("text"),
+        Result.created_at,
+        literal("system").label("user")
+    ) \
+        .filter(Result.user_id == user_id)
+
+    history_query = queries_query.union(results_query).order_by("created_at").limit(limit)
+
+    async with db_engine.get_async_session() as session:
+        history = (await session.execute(history_query)).all()
+
+        return history

cognee/modules/search/operations/get_queries.py

@@ -0,0 +1,17 @@
+from uuid import UUID
+from sqlalchemy import select
+from cognee.infrastructure.databases.relational import get_relational_engine
+from ..models.Query import Query
+
+async def get_queries(user_id: UUID, limit: int) -> list[Query]:
+    db_engine = get_relational_engine()
+
+    async with db_engine.get_async_session() as session:
+        datasets = (await session.scalars(
+            select(Query)
+                .filter(Query.user_id == user_id)
+                .order_by(Query.created_at.desc())
+                .limit(limit)
+        )).all()
+
+        return datasets

cognee/modules/search/operations/get_results.py

@@ -0,0 +1,17 @@
+from uuid import UUID
+from sqlalchemy import select
+from cognee.infrastructure.databases.relational import get_relational_engine
+from ..models.Result import Result
+
+async def get_results(user_id: UUID, limit: int = 10) -> list[Result]:
+    db_engine = get_relational_engine()
+
+    async with db_engine.get_async_session() as session:
+        datasets = (await session.scalars(
+            select(Result)
+                .filter(Result.user_id == user_id)
+                .order_by(Result.created_at.desc())
+                .limit(limit)
+        )).all()
+
+        return datasets

cognee/modules/search/operations/log_query.py

@@ -0,0 +1,19 @@
+from uuid import UUID
+from cognee.infrastructure.databases.relational import get_relational_engine
+from ..models.Query import Query
+
+async def log_query(query_text: str, query_type: str, user_id: UUID) -> Query:
+    db_engine = get_relational_engine()
+
+    async with db_engine.get_async_session() as session:
+        query = Query(
+            text = query_text,
+            query_type = query_type,
+            user_id = user_id,
+        )
+
+        session.add(query)
+
+        await session.commit()
+
+        return query

cognee/modules/search/operations/log_result.py

@@ -0,0 +1,15 @@
+from uuid import UUID
+from cognee.infrastructure.databases.relational import get_relational_engine
+from ..models.Result import Result
+
+async def log_result(query_id: UUID, result: str, user_id: UUID):
+    db_engine = get_relational_engine()
+
+    async with db_engine.get_async_session() as session:
+        session.add(Result(
+            value = result,
+            query_id = query_id,
+            user_id = user_id,
+        ))
+
+        await session.commit()

cognee/tests/test_library.py

@@ -35,24 +35,27 @@ async def  main():
     random_node = (await vector_engine.search("entities", "AI"))[0]
     random_node_name = random_node.payload["name"]
 
-    search_results = await cognee.search(SearchType.INSIGHTS, query = random_node_name)
+    search_results = await cognee.search(SearchType.INSIGHTS, query_text = random_node_name)
     assert len(search_results) != 0, "The search results list is empty."
     print("\n\nExtracted sentences are:\n")
     for result in search_results:
         print(f"{result}\n")
 
-    search_results = await cognee.search(SearchType.CHUNKS, query = random_node_name)
+    search_results = await cognee.search(SearchType.CHUNKS, query_text = random_node_name)
     assert len(search_results) != 0, "The search results list is empty."
     print("\n\nExtracted chunks are:\n")
     for result in search_results:
         print(f"{result}\n")
 
-    search_results = await cognee.search(SearchType.SUMMARIES, query = random_node_name)
+    search_results = await cognee.search(SearchType.SUMMARIES, query_text = random_node_name)
     assert len(search_results) != 0, "Query related summaries don't exist."
     print("\n\Extracted summaries are:\n")
     for result in search_results:
         print(f"{result}\n")
 
+    history = await cognee.get_search_history()
+
+    assert len(history) == 6, "Search history is not correct."
 
 if __name__ == "__main__":
     import asyncio

cognee/tests/test_neo4j.py

@@ -39,24 +39,27 @@ async def main():
     random_node = (await vector_engine.search("entities", "AI"))[0]
     random_node_name = random_node.payload["name"]
 
-    search_results = await cognee.search(SearchType.INSIGHTS, query = random_node_name)
+    search_results = await cognee.search(SearchType.INSIGHTS, query_text = random_node_name)
     assert len(search_results) != 0, "The search results list is empty."
     print("\n\nExtracted sentences are:\n")
     for result in search_results:
         print(f"{result}\n")
 
-    search_results = await cognee.search(SearchType.CHUNKS, query = random_node_name)
+    search_results = await cognee.search(SearchType.CHUNKS, query_text = random_node_name)
     assert len(search_results) != 0, "The search results list is empty."
     print("\n\nExtracted chunks are:\n")
     for result in search_results:
         print(f"{result}\n")
 
-    search_results = await cognee.search(SearchType.SUMMARIES, query = random_node_name)
+    search_results = await cognee.search(SearchType.SUMMARIES, query_text = random_node_name)
     assert len(search_results) != 0, "Query related summaries don't exist."
     print("\n\Extracted summaries are:\n")
     for result in search_results:
         print(f"{result}\n")
 
+    history = await cognee.get_search_history()
+
+    assert len(history) == 6, "Search history is not correct."
 
 if __name__ == "__main__":
     import asyncio

cognee/tests/test_pgvector.py

@@ -68,24 +68,27 @@ async def main():
     random_node = (await vector_engine.search("entities", "AI"))[0]
     random_node_name = random_node.payload["name"]
 
-    search_results = await cognee.search(SearchType.INSIGHTS, query=random_node_name)
+    search_results = await cognee.search(SearchType.INSIGHTS, query_text = random_node_name)
     assert len(search_results) != 0, "The search results list is empty."
     print("\n\nExtracted sentences are:\n")
     for result in search_results:
         print(f"{result}\n")
 
-    search_results = await cognee.search(SearchType.CHUNKS, query=random_node_name)
+    search_results = await cognee.search(SearchType.CHUNKS, query_text = random_node_name)
     assert len(search_results) != 0, "The search results list is empty."
     print("\n\nExtracted chunks are:\n")
     for result in search_results:
         print(f"{result}\n")
 
-    search_results = await cognee.search(SearchType.SUMMARIES, query=random_node_name)
+    search_results = await cognee.search(SearchType.SUMMARIES, query_text = random_node_name)
     assert len(search_results) != 0, "Query related summaries don't exist."
     print("\n\nExtracted summaries are:\n")
     for result in search_results:
         print(f"{result}\n")
 
+    history = await cognee.get_search_history()
+
+    assert len(history) == 6, "Search history is not correct."
 
 if __name__ == "__main__":
     import asyncio