154 lines
5.4 KiB
Python
154 lines
5.4 KiB
Python
from typing import Optional
|
|
|
|
from pydantic import Field, model_validator
|
|
from typing_extensions import Self
|
|
|
|
from letta.constants import CORE_MEMORY_BLOCK_CHAR_LIMIT, DEFAULT_HUMAN_BLOCK_DESCRIPTION, DEFAULT_PERSONA_BLOCK_DESCRIPTION
|
|
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: str = Field(..., description="Value of the block.")
|
|
limit: int = Field(CORE_MEMORY_BLOCK_CHAR_LIMIT, 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.", alias="name")
|
|
is_template: bool = Field(False, description="Whether the block is a template (e.g. saved human/persona options).")
|
|
preserve_on_migration: bool = Field(False, description="Preserve the block on template migration.")
|
|
|
|
# context window label
|
|
label: Optional[str] = Field(None, description="Label of the block (e.g. 'human', 'persona') in the context window.")
|
|
|
|
# permissions of the agent
|
|
read_only: bool = Field(False, description="Whether the agent has read-only access to the block.")
|
|
|
|
# metadata
|
|
description: Optional[str] = Field(None, description="Description of the block.")
|
|
metadata: Optional[dict] = Field({}, description="Metadata of the block.")
|
|
|
|
# def __len__(self):
|
|
# return len(self.value)
|
|
|
|
class Config:
|
|
extra = "ignore" # Ignores extra fields
|
|
|
|
@model_validator(mode="after")
|
|
def verify_char_limit(self) -> Self:
|
|
# self.limit can be None from
|
|
if self.limit is not None and self.value and len(self.value) > self.limit:
|
|
error_msg = f"Edit failed: Exceeds {self.limit} character limit (requested {len(self.value)}) - {str(self)}."
|
|
raise ValueError(error_msg)
|
|
|
|
return self
|
|
|
|
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:
|
|
label (str): The label of the block (e.g. 'human', 'persona'). This defines a category for 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.
|
|
is_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.
|
|
template_name (str): The name of the block template (if it is a template).
|
|
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()
|
|
|
|
# associated user/agent
|
|
organization_id: Optional[str] = Field(None, description="The unique identifier of the organization associated with the block.")
|
|
|
|
# default orm fields
|
|
created_by_id: Optional[str] = Field(None, description="The id of the user that made this Block.")
|
|
last_updated_by_id: Optional[str] = Field(None, description="The id of the user that last updated this Block.")
|
|
|
|
|
|
class Human(Block):
|
|
"""Human block of the LLM context"""
|
|
|
|
label: str = "human"
|
|
description: Optional[str] = Field(DEFAULT_HUMAN_BLOCK_DESCRIPTION, description="Description of the block.")
|
|
|
|
|
|
class Persona(Block):
|
|
"""Persona block of the LLM context"""
|
|
|
|
label: str = "persona"
|
|
description: Optional[str] = Field(DEFAULT_PERSONA_BLOCK_DESCRIPTION, description="Description of the block.")
|
|
|
|
|
|
DEFAULT_BLOCKS = [Human(value=""), Persona(value="")]
|
|
|
|
|
|
class BlockUpdate(BaseBlock):
|
|
"""Update a block"""
|
|
|
|
limit: Optional[int] = Field(None, description="Character limit of the block.")
|
|
value: Optional[str] = Field(None, description="Value of the block.")
|
|
|
|
class Config:
|
|
extra = "ignore" # Ignores extra fields
|
|
|
|
|
|
class CreateBlock(BaseBlock):
|
|
"""Create a block"""
|
|
|
|
label: str = Field(..., description="Label of the block.")
|
|
limit: int = Field(CORE_MEMORY_BLOCK_CHAR_LIMIT, description="Character limit of the block.")
|
|
value: str = Field(..., description="Value of the block.")
|
|
|
|
# block templates
|
|
is_template: bool = False
|
|
template_name: Optional[str] = Field(None, description="Name of the block if it is a template.", alias="name")
|
|
|
|
|
|
class CreateHuman(CreateBlock):
|
|
"""Create a human block"""
|
|
|
|
label: str = "human"
|
|
|
|
|
|
class CreatePersona(CreateBlock):
|
|
"""Create a persona block"""
|
|
|
|
label: str = "persona"
|
|
|
|
|
|
class CreateBlockTemplate(CreateBlock):
|
|
"""Create a block template"""
|
|
|
|
is_template: bool = True
|
|
|
|
|
|
class CreateHumanBlockTemplate(CreateHuman):
|
|
"""Create a human block template"""
|
|
|
|
is_template: bool = True
|
|
label: str = "human"
|
|
|
|
|
|
class CreatePersonaBlockTemplate(CreatePersona):
|
|
"""Create a persona block template"""
|
|
|
|
is_template: bool = True
|
|
label: str = "persona"
|