agno 2.0.0rc2__py3-none-any.whl → 2.3.0__py3-none-any.whl

agno/db/surrealdb/models.py

@@ -0,0 +1,309 @@
+from dataclasses import asdict
+from datetime import date, datetime, timezone
+from textwrap import dedent
+from typing import Any, Dict, List, Literal, Optional, Sequence
+
+from surrealdb import RecordID
+
+from agno.db.base import SessionType
+from agno.db.schemas.culture import CulturalKnowledge
+from agno.db.schemas.evals import EvalRunRecord
+from agno.db.schemas.knowledge import KnowledgeRow
+from agno.db.schemas.memory import UserMemory
+from agno.session import Session
+from agno.session.agent import AgentSession
+from agno.session.team import TeamSession
+from agno.session.workflow import WorkflowSession
+
+TableType = Literal[
+    "agents",
+    "culture",
+    "evals",
+    "knowledge",
+    "memories",
+    "metrics",
+    "sessions",
+    "teams",
+    "users",
+    "workflows",
+]
+
+
+def deserialize_record_id(record: dict, agno_field: str, surreal_field: Optional[str] = None) -> dict:
+    if surreal_field is None:
+        surreal_field = agno_field
+    x = record.get(surreal_field)
+    if isinstance(x, RecordID):
+        record[agno_field] = x.id
+        if agno_field != surreal_field:
+            del record[surreal_field]
+    return record
+
+
+def surrealize_dates(record: dict) -> dict:
+    copy = record.copy()
+    for key, value in copy.items():
+        if isinstance(value, date):
+            copy[key] = datetime.combine(value, datetime.min.time()).replace(tzinfo=timezone.utc)
+        elif key in ["created_at", "updated_at"] and isinstance(value, (int, float)):
+            copy[key] = datetime.fromtimestamp(value).replace(tzinfo=timezone.utc)
+        elif key in ["created_at", "updated_at"] and isinstance(value, str):
+            # Handle ISO string format - convert back to datetime object for SurrealDB
+            try:
+                dt = datetime.fromisoformat(value)
+                if dt.tzinfo is None:
+                    dt = dt.replace(tzinfo=timezone.utc)
+                copy[key] = dt
+            except ValueError:
+                # If it's not a valid ISO format, leave it as is
+                pass
+        elif key in ["created_at", "updated_at"] and value is None:
+            # Set current time for None datetime fields
+            copy[key] = datetime.now(timezone.utc)
+        elif isinstance(value, datetime):
+            copy[key] = value.replace(tzinfo=timezone.utc)
+    return copy
+
+
+def desurrealize_dates(record: dict) -> dict:
+    copy = record.copy()
+    for key, value in copy.items():
+        if isinstance(value, datetime):
+            copy[key] = int(value.timestamp())
+    return copy
+
+
+def serialize_session(session: Session, table_names: dict[TableType, str]) -> dict:
+    _dict = session.to_dict()
+
+    if session.session_id is not None:
+        _dict["id"] = RecordID(table_names["sessions"], session.session_id)
+        del _dict["session_id"]
+
+    if isinstance(session, AgentSession):
+        _dict["agent"] = RecordID(table_names["agents"], session.agent_id)
+        del _dict["agent_id"]
+    elif isinstance(session, TeamSession):
+        _dict["team"] = RecordID(table_names["teams"], session.team_id)
+        del _dict["team_id"]
+    elif isinstance(session, WorkflowSession):
+        _dict["workflow"] = RecordID(table_names["workflows"], session.workflow_id)
+        del _dict["workflow_id"]
+
+    # surrealize dates
+    _dict = surrealize_dates(_dict)
+
+    return _dict
+
+
+def desurrealize_session(session_raw: dict, session_type: Optional[SessionType] = None) -> dict:
+    session_raw = deserialize_record_id(session_raw, "session_id", "id")
+    if session_type == SessionType.AGENT:
+        session_raw = deserialize_record_id(session_raw, "agent_id", "agent")
+    elif session_type == SessionType.TEAM:
+        session_raw = deserialize_record_id(session_raw, "team_id", "team")
+    elif session_type == SessionType.WORKFLOW:
+        session_raw = deserialize_record_id(session_raw, "workflow_id", "workflow")
+
+    session_raw = desurrealize_dates(session_raw)
+
+    if session_raw.get("agent_id"):
+        session_raw["session_type"] = SessionType.AGENT
+    elif session_raw.get("team_id"):
+        session_raw["session_type"] = SessionType.TEAM
+    elif session_raw.get("workflow_id"):
+        session_raw["session_type"] = SessionType.WORKFLOW
+
+    return session_raw
+
+
+def deserialize_session(session_type: SessionType, session_raw: dict) -> Optional[Session]:
+    session_raw = desurrealize_session(session_raw, session_type)
+
+    if session_type == SessionType.AGENT:
+        return AgentSession.from_dict(session_raw)
+    elif session_type == SessionType.TEAM:
+        return TeamSession.from_dict(session_raw)
+    elif session_type == SessionType.WORKFLOW:
+        return WorkflowSession.from_dict(session_raw)
+    else:
+        raise ValueError(f"Invalid session type: {session_type}")
+
+
+def deserialize_sessions(session_type: SessionType, sessions_raw: List[dict]) -> List[Session]:
+    return [x for x in [deserialize_session(session_type, x) for x in sessions_raw] if x is not None]
+
+
+def get_session_type(session: Session) -> SessionType:
+    if isinstance(session, AgentSession):
+        return SessionType.AGENT
+    elif isinstance(session, TeamSession):
+        return SessionType.TEAM
+    elif isinstance(session, WorkflowSession):
+        return SessionType.WORKFLOW
+    else:
+        raise ValueError(f"Invalid session instance: {type(session)}")
+
+
+def desurrealize_user_memory(memory_raw: dict) -> dict:
+    copy = memory_raw.copy()
+
+    copy = deserialize_record_id(copy, "memory_id", "id")
+    copy = deserialize_record_id(copy, "user_id", "user")
+    copy = deserialize_record_id(copy, "agent_id", "agent")
+    copy = deserialize_record_id(copy, "team_id", "team")
+    copy = deserialize_record_id(copy, "workflow_id", "workflow")
+
+    # TODO: is this ok? or should we cast datetimes to int? Like in desurrealize_session
+    # copy = desurrealize_dates(copy)
+    updated_at = copy.get("updated_at")
+    if not isinstance(updated_at, str):
+        copy["updated_at"] = str(updated_at)
+
+    return copy
+
+
+def deserialize_user_memory(memory_raw: dict) -> UserMemory:
+    return UserMemory.from_dict(desurrealize_user_memory(memory_raw))
+
+
+def deserialize_user_memories(memories_raw: Sequence[dict]) -> List[UserMemory]:
+    return [deserialize_user_memory(x) for x in memories_raw]
+
+
+def serialize_user_memory(memory: UserMemory, memory_table_name: str, user_table_name: str) -> dict:
+    dict_ = asdict(memory)
+    if memory.memory_id is not None:
+        dict_["id"] = RecordID(memory_table_name, memory.memory_id)
+        del dict_["memory_id"]
+    if memory.user_id is not None:
+        dict_["user"] = RecordID(user_table_name, memory.user_id)
+        del dict_["user_id"]
+
+    # surrealize dates
+    dict_ = surrealize_dates(dict_)
+
+    return dict_
+
+
+def deserialize_knowledge_row(knowledge_row_raw: dict) -> KnowledgeRow:
+    copy = knowledge_row_raw.copy()
+
+    copy = deserialize_record_id(copy, "id")
+    copy = desurrealize_dates(copy)
+
+    return KnowledgeRow.model_validate(copy)
+
+
+def serialize_knowledge_row(knowledge_row: KnowledgeRow, knowledge_table_name: str) -> dict:
+    dict_ = knowledge_row.model_dump()
+    if knowledge_row.id is not None:
+        dict_["id"] = RecordID(knowledge_table_name, knowledge_row.id)
+
+    # surrealize dates
+    dict_ = surrealize_dates(dict_)
+
+    return dict_
+
+
+def deserialize_cultural_knowledge(cultural_knowledge_raw: dict) -> CulturalKnowledge:
+    copy = cultural_knowledge_raw.copy()
+
+    copy = deserialize_record_id(copy, "id")
+    copy = desurrealize_dates(copy)
+
+    # Extract content, categories, and notes from the content field
+    content_json = copy.get("content", {}) or {}
+    if isinstance(content_json, dict):
+        copy["content"] = content_json.get("content")
+        copy["categories"] = content_json.get("categories")
+        copy["notes"] = content_json.get("notes")
+
+    return CulturalKnowledge.from_dict(copy)
+
+
+def serialize_cultural_knowledge(cultural_knowledge: CulturalKnowledge, culture_table_name: str) -> dict:
+    dict_ = asdict(cultural_knowledge)
+    if cultural_knowledge.id is not None:
+        dict_["id"] = RecordID(culture_table_name, cultural_knowledge.id)
+
+    # Serialize content, categories, and notes into a single content dict for DB storage
+    content_dict: Dict[str, Any] = {}
+    if cultural_knowledge.content is not None:
+        content_dict["content"] = cultural_knowledge.content
+    if cultural_knowledge.categories is not None:
+        content_dict["categories"] = cultural_knowledge.categories
+    if cultural_knowledge.notes is not None:
+        content_dict["notes"] = cultural_knowledge.notes
+
+    # Replace the separate fields with the combined content field
+    dict_["content"] = content_dict if content_dict else None
+    # Remove the now-redundant fields since they're in content
+    dict_.pop("categories", None)
+    dict_.pop("notes", None)
+
+    # surrealize dates
+    dict_ = surrealize_dates(dict_)
+
+    return dict_
+
+
+def desurrealize_eval_run_record(eval_run_record_raw: dict) -> dict:
+    copy = eval_run_record_raw.copy()
+
+    copy = deserialize_record_id(copy, "run_id", "id")
+    copy = deserialize_record_id(copy, "agent_id", "agent")
+    copy = deserialize_record_id(copy, "team_id", "team")
+    copy = deserialize_record_id(copy, "workflow_id", "workflow")
+
+    return copy
+
+
+def deserialize_eval_run_record(eval_run_record_raw: dict) -> EvalRunRecord:
+    return EvalRunRecord.model_validate(desurrealize_eval_run_record(eval_run_record_raw))
+
+
+def serialize_eval_run_record(eval_run_record: EvalRunRecord, table_names: dict[TableType, str]) -> dict:
+    dict_ = eval_run_record.model_dump()
+    if eval_run_record.run_id is not None:
+        dict_["id"] = RecordID(table_names["evals"], eval_run_record.run_id)
+        del dict_["run_id"]
+    if eval_run_record.agent_id is not None:
+        dict_["agent"] = RecordID(table_names["agents"], eval_run_record.agent_id)
+        del dict_["agent_id"]
+    if eval_run_record.team_id is not None:
+        dict_["team"] = RecordID(table_names["teams"], eval_run_record.team_id)
+        del dict_["team_id"]
+    if eval_run_record.workflow_id is not None:
+        dict_["workflow"] = RecordID(table_names["workflows"], eval_run_record.workflow_id)
+        del dict_["workflow_id"]
+    return dict_
+
+
+def get_schema(table_type: TableType, table_name: str) -> str:
+    define_table = f"DEFINE TABLE {table_name} SCHEMALESS;"
+    if table_type == "memories":
+        return dedent(f"""
+            {define_table}
+            DEFINE FIELD OVERWRITE updated_at ON {table_name} TYPE datetime VALUE time::now();
+            """)
+    elif table_type == "knowledge":
+        return dedent(f"""
+            {define_table}
+            DEFINE FIELD OVERWRITE created_at ON {table_name} TYPE datetime VALUE time::now();
+            DEFINE FIELD OVERWRITE updated_at ON {table_name} TYPE datetime VALUE time::now();
+            """)
+    elif table_type == "culture":
+        return dedent(f"""
+            {define_table}
+            DEFINE FIELD OVERWRITE created_at ON {table_name} TYPE datetime VALUE time::now();
+            DEFINE FIELD OVERWRITE updated_at ON {table_name} TYPE datetime VALUE time::now();
+            """)
+    elif table_type == "sessions":
+        return dedent(f"""
+            {define_table}
+            DEFINE FIELD OVERWRITE created_at ON {table_name} TYPE datetime VALUE time::now();
+            DEFINE FIELD OVERWRITE updated_at ON {table_name} TYPE datetime VALUE time::now();
+            """)
+    else:
+        return define_table

agno/db/surrealdb/queries.py

@@ -0,0 +1,71 @@
+from textwrap import dedent
+from typing import Any, Final, Literal, Optional
+
+OPERATOR = Literal["=", "!=", "<=", ">=", "~", "IN", "CONTAINSANY"]
+
+COUNT_QUERY: Final[str] = dedent("""
+    RETURN (
+        SELECT count(id) AS count
+        {group_fields}
+        FROM {table}
+        {where_clause}
+        {group_clause}
+    )[0] OR {{count: 0}}
+""")
+
+
+class WhereClause:
+    def __init__(self):
+        self._conditions = []
+        self._params = {}
+        self._param_count = 0
+
+    def _add_filter(self, field: str, operator: str, value: Any):
+        param_name = f"p{self._param_count}"
+        self._params[param_name] = value
+        self._param_count += 1
+
+        condition = f"{field} {operator} ${param_name}"
+        if not self._conditions:
+            self._conditions.append(condition)
+        else:
+            self._conditions.append("AND")
+            self._conditions.append(condition)
+        return self
+
+    def and_(self, field: str, value: Any, operator: OPERATOR = "="):
+        return self._add_filter(field, operator, value)
+
+    def build(self) -> tuple[str, dict[str, Any]]:
+        if not self._conditions:
+            return "", {}
+        return "WHERE " + " ".join(self._conditions), self._params
+
+
+def order_limit_start(
+    sort_by: Optional[str] = None,
+    sort_order: Optional[str] = None,
+    limit: Optional[int] = None,
+    page: Optional[int] = None,
+) -> str:
+    if sort_order is not None:
+        if "desc" in sort_order.lower():
+            sort_order = "DESC"
+        else:
+            sort_order = "ASC"
+
+    order_clause = f"ORDER BY {sort_by} {sort_order or ''}" if sort_by is not None else ""
+
+    if limit is not None:
+        limit_clause = f"LIMIT {limit}"
+        if page is not None:
+            offset = (page - 1) * limit
+            start_clause = f"START {offset}"
+        else:
+            start_clause = ""
+    else:
+        limit_clause = ""
+        start_clause = ""
+
+    clauses = [order_clause, limit_clause, start_clause]
+    return " ".join(clause for clause in clauses if clause)