MalformedMessageError sentinel exception (#27)

src/aviary/message.py

@@ -2,13 +2,15 @@
 
 import json
 from collections.abc import Iterable
-from typing import TYPE_CHECKING, ClassVar
+from typing import TYPE_CHECKING, ClassVar, Self
 
 from pydantic import BaseModel, Field, field_validator, model_validator
 
 from aviary.utils import encode_image_to_base64
 
 if TYPE_CHECKING:
+    from logging import LogRecord
+
     import numpy as np
 
 
@@ -118,7 +120,7 @@ def create_message(
         role: str = DEFAULT_ROLE,
         text: str | None = None,
         image: np.ndarray | None = None,
-    ) -> Message:
+    ) -> Self:
         # Assume no image, and update to image if present
         content: str | list[dict] | None = text
         if image is not None:
@@ -130,7 +132,7 @@ def create_message(
             ]
             if text is not None:
                 content.append({"type": "text", "text": text})
-        return Message(role=role, content=content)
+        return cls(role=role, content=content)
 
 
 def join(
@@ -139,3 +141,22 @@ def join(
     return delimiter.join(
         f"{f'{m.role}: ' if include_roles else ''}{m.content or ''}" for m in msgs
     )
+
+
+class MalformedMessageError(ValueError):
+    """Error to throw if some aspect of a Message variant is malformed."""
+
+    @classmethod
+    def common_retryable_errors_log_filter(cls, record: LogRecord) -> bool:
+        """
+        Filter out common parsing failures not worth looking into from logs.
+
+        Returns:
+            False if the LogRecord should be filtered out, otherwise True to keep it.
+        """
+        # NOTE: match both this Exception type's name and its content, to be robust
+        return not all(x in record.msg for x in (cls.__name__, EMPTY_CONTENT_BASE_MSG))
+
+
+# Define separately so we can filter out this message type
+EMPTY_CONTENT_BASE_MSG = "No content in message"

src/aviary/tools/utils.py

@@ -4,7 +4,7 @@
 
 from pydantic import BaseModel, Field
 
-from aviary.message import Message
+from aviary.message import MalformedMessageError, Message
 
 from .base import (
     MessagesAdapter,
@@ -61,7 +61,7 @@ async def __call__(
             len(model_response.choices) != 1
             or model_response.choices[0].finish_reason != "tool_calls"
         ):
-            raise NotImplementedError(
+            raise MalformedMessageError(
                 f"Unexpected shape of LiteLLM model response {model_response}."
             )
         usage = model_response.usage