Files
letta-server/letta/schemas/block.py

125 lines
3.9 KiB
Python

from typing import Optional
from pydantic import Field, model_validator
from typing_extensions import Self
from letta.schemas.letta_base import LettaBase
# block of the LLM context
class BaseBlock(LettaBase, validate_assignment=True):
"""Base block of the LLM context"""
__id_prefix__ = "block"
# data value
value: Optional[str] = Field(None, description="Value of the block.")
limit: int = Field(2000, description="Character limit of the block.")
# template data (optional)
template_name: Optional[str] = Field(None, description="Name of the block if it is a template.")
template: bool = Field(False, description="Whether the block is a template (e.g. saved human/persona options).")
# context window label
label: str = Field(None, description="Label of the block (e.g. 'human', 'persona') in the context window.")
# metadata
description: Optional[str] = Field(None, description="Description of the block.")
metadata_: Optional[dict] = Field({}, description="Metadata of the block.")
# associated user/agent
user_id: Optional[str] = Field(None, description="The unique identifier of the user associated with the block.")
@model_validator(mode="after")
def verify_char_limit(self) -> Self:
try:
assert len(self) <= self.limit
except AssertionError:
error_msg = f"Edit failed: Exceeds {self.limit} character limit (requested {len(self)}) - {str(self)}."
raise ValueError(error_msg)
except Exception as e:
raise e
return self
def __len__(self):
return len(self.value)
def __setattr__(self, name, value):
"""Run validation if self.value is updated"""
super().__setattr__(name, value)
if name == "value":
# run validation
self.__class__.model_validate(self.model_dump(exclude_unset=True))
class Block(BaseBlock):
"""
A Block represents a reserved section of the LLM's context window which is editable. `Block` objects contained in the `Memory` object, which is able to edit the Block values.
Parameters:
name (str): The name of the block.
value (str): The value of the block. This is the string that is represented in the context window.
limit (int): The character limit of the block.
template (bool): Whether the block is a template (e.g. saved human/persona options). Non-template blocks are not stored in the database and are ephemeral, while templated blocks are stored in the database.
label (str): The label of the block (e.g. 'human', 'persona'). This defines a category for the block.
description (str): Description of the block.
metadata_ (Dict): Metadata of the block.
user_id (str): The unique identifier of the user associated with the block.
"""
id: str = BaseBlock.generate_id_field()
value: str = Field(..., description="Value of the block.")
class Human(Block):
"""Human block of the LLM context"""
label: str = "human"
class Persona(Block):
"""Persona block of the LLM context"""
label: str = "persona"
class CreateBlock(BaseBlock):
"""Create a block"""
template: bool = True
label: str = Field(..., description="Label of the block.")
class CreatePersona(BaseBlock):
"""Create a persona block"""
template: bool = True
label: str = "persona"
class CreateHuman(BaseBlock):
"""Create a human block"""
template: bool = True
label: str = "human"
class UpdateBlock(BaseBlock):
"""Update a block"""
id: str = Field(..., description="The unique identifier of the block.")
limit: Optional[int] = Field(2000, description="Character limit of the block.")
class UpdatePersona(UpdateBlock):
"""Update a persona block"""
label: str = "persona"
class UpdateHuman(UpdateBlock):
"""Update a human block"""
label: str = "human"