Skip to content

armgit / letta

Public Imported from GitHub
0

Platform for stateful agents: AI with advanced memory that can learn and self-improve over time.

refactor: include_return_message_types on list endpoints (#10197)

Kian Jones2d731e72ddae
diff --git a/fern/openapi.json b/fern/openapi.json
index bd5870861..d5e614911 100644
--- a/fern/openapi.json
+++ b/fern/openapi.json
@@ -7852,6 +7852,27 @@
"title": "Include Err"
},
"description": "Whether to include error messages and error statuses. For debugging purposes only."
+ },
+ {
+ "name": "include_return_message_types",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/MessageType"
+ }
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Message types to include in response. When null, all message types are returned.",
+ "title": "Include Return Message Types"
+ },
+ "description": "Message types to include in response. When null, all message types are returned."
}
],
"responses": {
@@ -9253,6 +9274,27 @@
"title": "Include Err"
},
"description": "Whether to include error messages and error statuses. For debugging purposes only."
+ },
+ {
+ "name": "include_return_message_types",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/MessageType"
+ }
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Message types to include in response. When null, all message types are returned.",
+ "title": "Include Return Message Types"
+ },
+ "description": "Message types to include in response. When null, all message types are returned."
}
],
"responses": {
@@ -10472,6 +10514,27 @@
},
"description": "The name of the message argument.",
"deprecated": true
+ },
+ {
+ "name": "include_return_message_types",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/MessageType"
+ }
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Message types to include in response. When null, all message types are returned.",
+ "title": "Include Return Message Types"
+ },
+ "description": "Message types to include in response. When null, all message types are returned."
}
],
"responses": {
@@ -17392,6 +17455,27 @@
"title": "Conversation Id"
},
"description": "Conversation ID to filter messages by"
+ },
+ {
+ "name": "include_return_message_types",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/MessageType"
+ }
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Message types to include in response. When null, all message types are returned.",
+ "title": "Include Return Message Types"
+ },
+ "description": "Message types to include in response. When null, all message types are returned."
}
],
"responses": {
diff --git a/letta/schemas/message.py b/letta/schemas/message.py
index 2496f5968..80a92f61a 100644
--- a/letta/schemas/message.py
+++ b/letta/schemas/message.py
@@ -350,6 +350,7 @@ class Message(BaseMessage):
include_err: Optional[bool] = None,
text_is_assistant_message: bool = False,
convert_summary_to_user: bool = True,
+ include_return_message_types: Optional[List[MessageType]] = None,
) -> List[LettaMessage]:
if use_assistant_message:
message_ids_to_remove = []
@@ -372,7 +373,7 @@ class Message(BaseMessage):
messages = [msg for msg in messages if msg.id not in message_ids_to_remove]
# Convert messages to LettaMessages
- return [
+ letta_messages = [
msg
for m in messages
for msg in m.to_letta_messages(
@@ -386,6 +387,12 @@ class Message(BaseMessage):
)
]
+ if include_return_message_types is not None:
+ # Filter to only the specified message types
+ letta_messages = [msg for msg in letta_messages if msg.message_type in include_return_message_types]
+
+ return letta_messages
+
@staticmethod
@trace_method
def to_letta_search_results_from_list(
diff --git a/letta/server/rest_api/routers/v1/agents.py b/letta/server/rest_api/routers/v1/agents.py
index dd2e19d52..1fdfdade0 100644
--- a/letta/server/rest_api/routers/v1/agents.py
+++ b/letta/server/rest_api/routers/v1/agents.py
@@ -1598,6 +1598,7 @@ async def list_messages(
include_err: bool | None = Query(
None, description="Whether to include error messages and error statuses. For debugging purposes only."
),
+ include_return_message_types: Optional[List[MessageType]] = Query(None, description="Message types to include in response. When null, all message types are returned."),
headers: HeaderParams = Depends(get_headers),
):
"""
@@ -1618,6 +1619,7 @@ async def list_messages(
assistant_message_tool_name=assistant_message_tool_name,
assistant_message_tool_kwarg=assistant_message_tool_kwarg,
include_err=include_err,
+ include_return_message_types=include_return_message_types,
actor=actor,
)
diff --git a/letta/server/rest_api/routers/v1/conversations.py b/letta/server/rest_api/routers/v1/conversations.py
index 87ae108fe..ebc9e7fdc 100644
--- a/letta/server/rest_api/routers/v1/conversations.py
+++ b/letta/server/rest_api/routers/v1/conversations.py
@@ -16,7 +16,7 @@ from letta.log import get_logger
from letta.schemas.conversation import Conversation, CreateConversation, UpdateConversation
from letta.schemas.enums import RunStatus
from letta.schemas.job import LettaRequestConfig
-from letta.schemas.letta_message import LettaMessageUnion
+from letta.schemas.letta_message import LettaMessageUnion, MessageType
from letta.schemas.letta_request import ConversationMessageRequest, LettaStreamingRequest, RetrieveStreamRequest
from letta.schemas.letta_response import LettaResponse
from letta.schemas.provider_trace import BillingContext
@@ -211,6 +211,7 @@ async def list_conversation_messages(
include_err: Optional[bool] = Query(
None, description="Whether to include error messages and error statuses. For debugging purposes only."
),
+ include_return_message_types: Optional[List[MessageType]] = Query(None, description="Message types to include in response. When null, all message types are returned."),
):
"""
List all messages in a conversation.
@@ -244,6 +245,7 @@ async def list_conversation_messages(
reverse=(order == "desc"),
return_message_object=False,
include_err=include_err,
+ include_return_message_types=include_return_message_types,
actor=actor,
)
@@ -256,6 +258,7 @@ async def list_conversation_messages(
reverse=(order == "desc"),
group_id=group_id,
include_err=include_err,
+ include_return_message_types=include_return_message_types,
)
diff --git a/letta/server/rest_api/routers/v1/groups.py b/letta/server/rest_api/routers/v1/groups.py
index 29edd0b66..99aca6fec 100644
--- a/letta/server/rest_api/routers/v1/groups.py
+++ b/letta/server/rest_api/routers/v1/groups.py
@@ -6,7 +6,7 @@ from pydantic import Field
from letta.constants import DEFAULT_MESSAGE_TOOL, DEFAULT_MESSAGE_TOOL_KWARG
from letta.schemas.group import Group, GroupCreate, GroupUpdate, ManagerType
-from letta.schemas.letta_message import LettaMessageUnion, LettaMessageUpdateUnion
+from letta.schemas.letta_message import LettaMessageUnion, LettaMessageUpdateUnion, MessageType
from letta.server.rest_api.dependencies import HeaderParams, get_headers, get_letta_server
from letta.server.server import SyncServer
from letta.validators import GroupId, MessageId
@@ -165,6 +165,7 @@ async def list_group_messages(
use_assistant_message: bool = Query(True, description="Whether to use assistant messages", deprecated=True),
assistant_message_tool_name: str = Query(DEFAULT_MESSAGE_TOOL, description="The name of the designated message tool.", deprecated=True),
assistant_message_tool_kwarg: str = Query(DEFAULT_MESSAGE_TOOL_KWARG, description="The name of the message argument.", deprecated=True),
+ include_return_message_types: Optional[List[MessageType]] = Query(None, description="Message types to include in response. When null, all message types are returned."),
server: "SyncServer" = Depends(get_letta_server),
headers: HeaderParams = Depends(get_headers),
):
@@ -175,7 +176,6 @@ async def list_group_messages(
group = await server.group_manager.retrieve_group_async(group_id=group_id, actor=actor)
if group.manager_agent_id:
return await server.get_agent_recall_async(
- user_id=actor.id,
agent_id=group.manager_agent_id,
after=after,
before=before,
@@ -186,6 +186,8 @@ async def list_group_messages(
use_assistant_message=use_assistant_message,
assistant_message_tool_name=assistant_message_tool_name,
assistant_message_tool_kwarg=assistant_message_tool_kwarg,
+ include_return_message_types=include_return_message_types,
+ actor=actor,
)
else:
return await server.group_manager.list_group_messages_async(
@@ -193,11 +195,11 @@ async def list_group_messages(
after=after,
before=before,
limit=limit,
- ascending=(order == "asc"),
actor=actor,
use_assistant_message=use_assistant_message,
assistant_message_tool_name=assistant_message_tool_name,
assistant_message_tool_kwarg=assistant_message_tool_kwarg,
+ include_return_message_types=include_return_message_types,
)
diff --git a/letta/server/rest_api/routers/v1/messages.py b/letta/server/rest_api/routers/v1/messages.py
index 7dfcda593..748382b4c 100644
--- a/letta/server/rest_api/routers/v1/messages.py
+++ b/letta/server/rest_api/routers/v1/messages.py
@@ -8,7 +8,7 @@ from letta.agents.letta_agent_batch import LettaAgentBatch
from letta.errors import LettaInvalidArgumentError
from letta.log import get_logger
from letta.schemas.job import BatchJob, JobStatus, JobType, JobUpdate
-from letta.schemas.letta_message import LettaMessageSearchResult, LettaMessageUnion
+from letta.schemas.letta_message import LettaMessageSearchResult, LettaMessageUnion, MessageType
from letta.schemas.letta_request import CreateBatch
from letta.schemas.letta_response import LettaBatchMessages
from letta.schemas.message import Message, SearchAllMessagesRequest
@@ -42,6 +42,7 @@ async def list_all_messages(
"desc", description="Sort order for messages by creation time. 'asc' for oldest first, 'desc' for newest first"
),
conversation_id: Optional[str] = Query(None, description="Conversation ID to filter messages by"),
+ include_return_message_types: Optional[List[MessageType]] = Query(None, description="Message types to include in response. When null, all message types are returned."),
):
"""
List messages across all agents for the current user.
@@ -54,6 +55,7 @@ async def list_all_messages(
reverse=(order == "desc"),
return_message_object=False,
conversation_id=conversation_id,
+ include_return_message_types=include_return_message_types,
actor=actor,
)
diff --git a/letta/server/server.py b/letta/server/server.py
index e5cfc5c71..0ba968c5e 100644
--- a/letta/server/server.py
+++ b/letta/server/server.py
@@ -39,7 +39,7 @@ from letta.schemas.embedding_config import EmbeddingConfig
from letta.schemas.enums import AgentType, JobStatus, ProviderCategory, ProviderType, ToolSourceType
from letta.schemas.group import GroupCreate, SleeptimeManager, VoiceSleeptimeManager
from letta.schemas.job import Job, JobUpdate
-from letta.schemas.letta_message import LettaMessage, ToolReturnMessage
+from letta.schemas.letta_message import LettaMessage, MessageType, ToolReturnMessage
from letta.schemas.llm_config import LLMConfig
from letta.schemas.memory import Memory
from letta.schemas.message import Message
@@ -948,6 +948,7 @@ class SyncServer(object):
assistant_message_tool_kwarg: str = constants.DEFAULT_MESSAGE_TOOL_KWARG,
include_err: Optional[bool] = None,
conversation_id: Optional[str] = None,
+ include_return_message_types: Optional[List[MessageType]] = None,
) -> Union[List[Message], List[LettaMessage]]:
records = await self.message_manager.list_messages(
agent_id=agent_id,
@@ -974,6 +975,7 @@ class SyncServer(object):
reverse=reverse,
include_err=include_err,
text_is_assistant_message=text_is_assistant_message,
+ include_return_message_types=include_return_message_types,
)
if reverse:
@@ -995,6 +997,7 @@ class SyncServer(object):
assistant_message_tool_kwarg: str = constants.DEFAULT_MESSAGE_TOOL_KWARG,
include_err: Optional[bool] = None,
conversation_id: Optional[str] = None,
+ include_return_message_types: Optional[List[MessageType]] = None,
) -> Union[List[Message], List[LettaMessage]]:
records = await self.message_manager.list_messages(
agent_id=None,
@@ -1021,6 +1024,7 @@ class SyncServer(object):
reverse=reverse,
include_err=include_err,
text_is_assistant_message=text_is_assistant_message,
+ include_return_message_types=include_return_message_types,
)
if reverse:
diff --git a/letta/services/conversation_manager.py b/letta/services/conversation_manager.py
index c2288822c..0a7b5edfa 100644
--- a/letta/services/conversation_manager.py
+++ b/letta/services/conversation_manager.py
@@ -19,7 +19,7 @@ from letta.otel.tracing import trace_method
from letta.schemas.agent import AgentState
from letta.schemas.block import Block as PydanticBlock
from letta.schemas.conversation import Conversation as PydanticConversation, CreateConversation, UpdateConversation
-from letta.schemas.letta_message import LettaMessage
+from letta.schemas.letta_message import LettaMessage, MessageType
from letta.schemas.message import Message as PydanticMessage
from letta.schemas.user import User as PydanticUser
from letta.server.db import db_registry
@@ -808,6 +808,7 @@ class ConversationManager:
reverse: bool = False,
group_id: Optional[str] = None,
include_err: Optional[bool] = None,
+ include_return_message_types: Optional[List[MessageType]] = None,
) -> List[LettaMessage]:
"""
List all messages in a conversation with pagination support.
@@ -885,7 +886,7 @@ class ConversationManager:
# Convert to LettaMessages (reverse=False keeps sub-messages in natural order)
return PydanticMessage.to_letta_messages_from_list(
- messages, reverse=False, include_err=include_err, text_is_assistant_message=True
+ messages, reverse=False, include_err=include_err, text_is_assistant_message=True, include_return_message_types=include_return_message_types
)
# ==================== Isolated Blocks Methods ====================
diff --git a/letta/services/group_manager.py b/letta/services/group_manager.py
index 4b4123f10..ee7ee4808 100644
--- a/letta/services/group_manager.py
+++ b/letta/services/group_manager.py
@@ -13,7 +13,7 @@ from letta.orm.message import Message as MessageModel
from letta.otel.tracing import trace_method
from letta.schemas.enums import PrimitiveType
from letta.schemas.group import Group as PydanticGroup, GroupCreate, GroupUpdate, InternalTemplateGroupCreate, ManagerType
-from letta.schemas.letta_message import LettaMessage
+from letta.schemas.letta_message import LettaMessage, MessageType
from letta.schemas.message import Message as PydanticMessage
from letta.schemas.user import User as PydanticUser
from letta.server.db import db_registry
@@ -207,6 +207,7 @@ class GroupManager:
use_assistant_message: bool = True,
assistant_message_tool_name: str = "send_message",
assistant_message_tool_kwarg: str = "message",
+ include_return_message_types: Optional[List[MessageType]] = None,
) -> list[LettaMessage]:
async with db_registry.async_session() as session:
filters = {
@@ -227,6 +228,7 @@ class GroupManager:
use_assistant_message=use_assistant_message,
assistant_message_tool_name=assistant_message_tool_name,
assistant_message_tool_kwarg=assistant_message_tool_kwarg,
+ include_return_message_types=include_return_message_types,
)
# TODO: filter messages to return a clean conversation history