letta-nightly 0.5.0.dev20241021104213__py3-none-any.whl → 0.5.0.dev20241023104105__py3-none-any.whl

letta/orm/mixins.py

@@ -0,0 +1,40 @@
+from typing import Optional, Type
+from uuid import UUID
+
+from letta.orm.base import Base
+
+
+class MalformedIdError(Exception):
+    pass
+
+
+def _relation_getter(instance: "Base", prop: str) -> Optional[str]:
+    prefix = prop.replace("_", "")
+    formatted_prop = f"_{prop}_id"
+    try:
+        uuid_ = getattr(instance, formatted_prop)
+        return f"{prefix}-{uuid_}"
+    except AttributeError:
+        return None
+
+
+def _relation_setter(instance: Type["Base"], prop: str, value: str) -> None:
+    formatted_prop = f"_{prop}_id"
+    prefix = prop.replace("_", "")
+    if not value:
+        setattr(instance, formatted_prop, None)
+        return
+    try:
+        found_prefix, id_ = value.split("-", 1)
+    except ValueError as e:
+        raise MalformedIdError(f"{value} is not a valid ID.") from e
+    assert (
+        # TODO: should be able to get this from the Mapped typing, not sure how though
+        # prefix = getattr(?, "prefix")
+        found_prefix
+        == prefix
+    ), f"{found_prefix} is not a valid id prefix, expecting {prefix}"
+    try:
+        setattr(instance, formatted_prop, UUID(id_))
+    except ValueError as e:
+        raise MalformedIdError("Hash segment of {value} is not a valid UUID") from e

letta/orm/organization.py

@@ -0,0 +1,35 @@
+from typing import TYPE_CHECKING
+
+from sqlalchemy.exc import NoResultFound
+from sqlalchemy.orm import Mapped, mapped_column
+
+from letta.orm.sqlalchemy_base import SqlalchemyBase
+from letta.schemas.organization import Organization as PydanticOrganization
+
+if TYPE_CHECKING:
+    from sqlalchemy.orm import Session
+
+
+class Organization(SqlalchemyBase):
+    """The highest level of the object tree. All Entities belong to one and only one Organization."""
+
+    __tablename__ = "organizations"
+    __pydantic_model__ = PydanticOrganization
+
+    name: Mapped[str] = mapped_column(doc="The display name of the organization.")
+
+    # TODO: Map these relationships later when we actually make these models
+    # below is just a suggestion
+    # users: Mapped[List["User"]] = relationship("User", back_populates="organization", cascade="all, delete-orphan")
+    # agents: Mapped[List["Agent"]] = relationship("Agent", back_populates="organization", cascade="all, delete-orphan")
+    # sources: Mapped[List["Source"]] = relationship("Source", back_populates="organization", cascade="all, delete-orphan")
+    # tools: Mapped[List["Tool"]] = relationship("Tool", back_populates="organization", cascade="all, delete-orphan")
+    # documents: Mapped[List["Document"]] = relationship("Document", back_populates="organization", cascade="all, delete-orphan")
+
+    @classmethod
+    def default(cls, db_session: "Session") -> "Organization":
+        """Get the default org, or create it if it doesn't exist."""
+        try:
+            return db_session.query(cls).filter(cls.name == "Default Organization").one()
+        except NoResultFound:
+            return cls(name="Default Organization").create(db_session)

letta/orm/sqlalchemy_base.py

@@ -0,0 +1,214 @@
+from typing import TYPE_CHECKING, List, Literal, Optional, Type, Union
+from uuid import UUID, uuid4
+
+from humps import depascalize
+from sqlalchemy import Boolean, String, select
+from sqlalchemy.orm import Mapped, mapped_column
+
+from letta.log import get_logger
+from letta.orm.base import Base, CommonSqlalchemyMetaMixins
+from letta.orm.errors import NoResultFound
+
+if TYPE_CHECKING:
+    from pydantic import BaseModel
+    from sqlalchemy.orm import Session
+
+    # from letta.orm.user import User
+
+logger = get_logger(__name__)
+
+
+class SqlalchemyBase(CommonSqlalchemyMetaMixins, Base):
+    __abstract__ = True
+
+    __order_by_default__ = "created_at"
+
+    _id: Mapped[str] = mapped_column(String, primary_key=True, default=lambda: f"{uuid4()}")
+
+    deleted: Mapped[bool] = mapped_column(Boolean, default=False, doc="Is this record deleted? Used for universal soft deletes.")
+
+    @classmethod
+    def __prefix__(cls) -> str:
+        return depascalize(cls.__name__)
+
+    @property
+    def id(self) -> Optional[str]:
+        if self._id:
+            return f"{self.__prefix__()}-{self._id}"
+
+    @id.setter
+    def id(self, value: str) -> None:
+        if not value:
+            return
+        prefix, id_ = value.split("-", 1)
+        assert prefix == self.__prefix__(), f"{prefix} is not a valid id prefix for {self.__class__.__name__}"
+        assert SqlalchemyBase.is_valid_uuid4(id_), f"{id_} is not a valid uuid4"
+        self._id = id_
+
+    @classmethod
+    def list(
+        cls, *, db_session: "Session", cursor: Optional[str] = None, limit: Optional[int] = 50, **kwargs
+    ) -> List[Type["SqlalchemyBase"]]:
+        """List records with optional cursor (for pagination) and limit."""
+        with db_session as session:
+            # Start with the base query filtered by kwargs
+            query = select(cls).filter_by(**kwargs)
+
+            # Add a cursor condition if provided
+            if cursor:
+                cursor_uuid = cls.get_uid_from_identifier(cursor)  # Assuming the cursor is an _id value
+                query = query.where(cls._id > cursor_uuid)
+
+            # Add a limit to the query if provided
+            query = query.order_by(cls._id).limit(limit)
+
+            # Handle soft deletes if the class has the 'is_deleted' attribute
+            if hasattr(cls, "is_deleted"):
+                query = query.where(cls.is_deleted == False)
+
+            # Execute the query and return the results as a list of model instances
+            return list(session.execute(query).scalars())
+
+    @classmethod
+    def get_uid_from_identifier(cls, identifier: str, indifferent: Optional[bool] = False) -> str:
+        """converts the id into a uuid object
+        Args:
+            identifier: the string identifier, such as `organization-xxxx-xx...`
+            indifferent: if True, will not enforce the prefix check
+        """
+        try:
+            uuid_string = identifier.split("-", 1)[1] if indifferent else identifier.replace(f"{cls.__prefix__()}-", "")
+            assert SqlalchemyBase.is_valid_uuid4(uuid_string)
+            return uuid_string
+        except ValueError as e:
+            raise ValueError(f"{identifier} is not a valid identifier for class {cls.__name__}") from e
+
+    @classmethod
+    def is_valid_uuid4(cls, uuid_string: str) -> bool:
+        try:
+            # Try to create a UUID object from the string
+            uuid_obj = UUID(uuid_string)
+            # Check if the UUID is version 4
+            return uuid_obj.version == 4
+        except ValueError:
+            # Raised if the string is not a valid UUID
+            return False
+
+    @classmethod
+    def read(
+        cls,
+        db_session: "Session",
+        identifier: Union[str, UUID],
+        actor: Optional["User"] = None,
+        access: Optional[List[Literal["read", "write", "admin"]]] = ["read"],
+        **kwargs,
+    ) -> Type["SqlalchemyBase"]:
+        """The primary accessor for an ORM record.
+        Args:
+            db_session: the database session to use when retrieving the record
+            identifier: the identifier of the record to read, can be the id string or the UUID object for backwards compatibility
+            actor: if specified, results will be scoped only to records the user is able to access
+            access: if actor is specified, records will be filtered to the minimum permission level for the actor
+            kwargs: additional arguments to pass to the read, used for more complex objects
+        Returns:
+            The matching object
+        Raises:
+            NoResultFound: if the object is not found
+        """
+        del kwargs  # arity for more complex reads
+        identifier = cls.get_uid_from_identifier(identifier)
+        query = select(cls).where(cls._id == identifier)
+        # if actor:
+        #     query = cls.apply_access_predicate(query, actor, access)
+        if hasattr(cls, "is_deleted"):
+            query = query.where(cls.is_deleted == False)
+        if found := db_session.execute(query).scalar():
+            return found
+        raise NoResultFound(f"{cls.__name__} with id {identifier} not found")
+
+    def create(self, db_session: "Session") -> Type["SqlalchemyBase"]:
+        # self._infer_organization(db_session)
+
+        with db_session as session:
+            session.add(self)
+            session.commit()
+            session.refresh(self)
+            return self
+
+    def delete(self, db_session: "Session") -> Type["SqlalchemyBase"]:
+        self.is_deleted = True
+        return self.update(db_session)
+
+    def update(self, db_session: "Session") -> Type["SqlalchemyBase"]:
+        with db_session as session:
+            session.add(self)
+            session.commit()
+            session.refresh(self)
+            return self
+
+    @classmethod
+    def read_or_create(cls, *, db_session: "Session", **kwargs) -> Type["SqlalchemyBase"]:
+        """get an instance by search criteria or create it if it doesn't exist"""
+        try:
+            return cls.read(db_session=db_session, identifier=kwargs.get("id", None))
+        except NoResultFound:
+            clean_kwargs = {k: v for k, v in kwargs.items() if k in cls.__table__.columns}
+            return cls(**clean_kwargs).create(db_session=db_session)
+
+    # TODO: Add back later when access predicates are actually important
+    # The idea behind this is that you can add a WHERE clause restricting the actions you can take, e.g. R/W
+    # @classmethod
+    # def apply_access_predicate(
+    #     cls,
+    #     query: "Select",
+    #     actor: "User",
+    #     access: List[Literal["read", "write", "admin"]],
+    # ) -> "Select":
+    #     """applies a WHERE clause restricting results to the given actor and access level
+    #     Args:
+    #         query: The initial sqlalchemy select statement
+    #         actor: The user acting on the query. **Note**: this is called 'actor' to identify the
+    #                person or system acting. Users can act on users, making naming very sticky otherwise.
+    #         access:
+    #             what mode of access should the query restrict to? This will be used with granular permissions,
+    #             but because of how it will impact every query we want to be explicitly calling access ahead of time.
+    #     Returns:
+    #         the sqlalchemy select statement restricted to the given access.
+    #     """
+    #     del access  # entrypoint for row-level permissions. Defaults to "same org as the actor, all permissions" at the moment
+    #     org_uid = getattr(actor, "_organization_id", getattr(actor.organization, "_id", None))
+    #     if not org_uid:
+    #         raise ValueError("object %s has no organization accessor", actor)
+    #     return query.where(cls._organization_id == org_uid, cls.is_deleted == False)
+
+    @property
+    def __pydantic_model__(self) -> Type["BaseModel"]:
+        raise NotImplementedError("Sqlalchemy models must declare a __pydantic_model__ property to be convertable.")
+
+    def to_pydantic(self) -> Type["BaseModel"]:
+        """converts to the basic pydantic model counterpart"""
+        return self.__pydantic_model__.model_validate(self)
+
+    def to_record(self) -> Type["BaseModel"]:
+        """Deprecated accessor for to_pydantic"""
+        logger.warning("to_record is deprecated, use to_pydantic instead.")
+        return self.to_pydantic()
+
+    # TODO: Look into this later and maybe add back?
+    # def _infer_organization(self, db_session: "Session") -> None:
+    #     """🪄 MAGIC ALERT! 🪄
+    #     Because so much of the original API is centered around user scopes,
+    #     this allows us to continue with that scope and then infer the org from the creating user.
+    #
+    #     IF a created_by_id is set, we will use that to infer the organization and magic set it at create time!
+    #     If not do nothing to the object. Mutates in place.
+    #     """
+    #     if self.created_by_id and hasattr(self, "_organization_id"):
+    #         try:
+    #             from letta.orm.user import User  # to avoid circular import
+    #
+    #             created_by = User.read(db_session, self.created_by_id)
+    #         except NoResultFound:
+    #             logger.warning(f"User {self.created_by_id} not found, unable to infer organization.")
+    #             return
+    #         self._organization_id = created_by._organization_id

letta/schemas/organization.py

@@ -7,13 +7,13 @@ from letta.schemas.letta_base import LettaBase
 
 
 class OrganizationBase(LettaBase):
-    __id_prefix__ = "org"
+    __id_prefix__ = "organization"
 
 
 class Organization(OrganizationBase):
-    id: str = OrganizationBase.generate_id_field()
+    id: str = Field(..., description="The id of the organization.")
     name: str = Field(..., description="The name of the organization.")
-    created_at: datetime = Field(default_factory=datetime.utcnow, description="The creation date of the user.")
+    created_at: datetime = Field(default_factory=datetime.utcnow, description="The creation date of the organization.")
 
 
 class OrganizationCreate(OrganizationBase):