Skip to content

utils

Utilities for file reading and parsing

status
Use mouse to pan and zoom
Use mouse to pan and zoom

CLASS DESCRIPTION
InvalidMessageFormatError

Exception that is raised when a dictionary cannot be parsed into a valid
FUNCTION DESCRIPTION
messages_from_dicts

Convert a sequence of dictionaries to a list of BaseMessage objects.

Classes

InvalidMessageFormatError 


              flowchart TD
              evallm.readers.utils.InvalidMessageFormatError[InvalidMessageFormatError]

              

              click evallm.readers.utils.InvalidMessageFormatError href "" "evallm.readers.utils.InvalidMessageFormatError"
Use mouse to pan and zoom

Exception that is raised when a dictionary cannot be parsed into a valid BaseMessage, either because it is missing a required key or because the message type is not supported.

Raised by:

Functions

messages_from_dicts 

messages_from_dicts(dicts: dict | Sequence[dict]) -> list[BaseMessage]

Convert a sequence of dictionaries to a list of BaseMessage objects.

PARAMETER DESCRIPTION
dicts

A single or a sequence of dictionaries to be converted into BaseMessage objects.

  • If a single dictionary is provided, the method will look for a "messages" key containing a list of message dictionaries to convert.
  • If more than one dictionary or a single dictionary without a "messages" key is provided, the method assumes that the input corresponds to a sequence of dictionaries, each representing a single message to be converted.

TYPE: dict | Sequence[dict]

RETURNS DESCRIPTION
list[BaseMessage]

list[BaseMessage]: A list of BaseMessage objects created from the input dictionaries.
RAISES DESCRIPTION
InvalidMessageFormatError

If any of the input dictionaries cannot be parsed into a valid BaseMessage format, an error will be raised.
Note

This method is a convenience wrapper around langchain_core.messages.utils.convert_to_messages and as such is subject to changes in the langchain-core library.

Source code in src/evallm/readers/utils.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
def messages_from_dicts(dicts: dict | Sequence[dict]) -> list[BaseMessage]:
    """Convert a sequence of dictionaries to a list of `BaseMessage` objects.

    Args:
        dicts (dict | Sequence[dict]): A single or a sequence of dictionaries to be
            converted into `BaseMessage` objects.

            - If a single dictionary is provided, the method will look for a
                `"messages"` key containing a list of message dictionaries to
                convert.
            - If more than one dictionary or a single dictionary without a
                `"messages"` key is provided, the method assumes that the input
                corresponds to a sequence of dictionaries, each representing a
                single message to be converted.

    Returns:
        list[BaseMessage]: A list of BaseMessage objects created from the input
            dictionaries.

    Raises:
        InvalidMessageFormatError: If any of the input dictionaries cannot be
            parsed into a valid `BaseMessage` format, an error will be raised.

    Note:
        This method is a convenience wrapper around
        [:simple-langchain: `langchain_core.messages.utils.convert_to_messages`](https://github.com/langchain-ai/langchain/blob/master/libs/core/langchain_core/messages/utils.py#L735)
        and as such is subject to changes in the langchain-core library.
    """
    try:
        if isinstance(dicts, dict):
            if "messages" in dicts:
                # {"messages":[{"role":"...","content":"..."},...]}"
                return convert_to_messages(dicts["messages"])
            # {"role":"...","content":"..."}
            return convert_to_messages([dicts])
        # [{"role":"...","content":"..."},...]
        return convert_to_messages(dicts)
    except ValueError as e:  # missing key
        raise InvalidMessageFormatError(
            "One or more dictionaries are missing required keys for conversion to "
            "BaseMessage format."
        ) from e
    except NotImplementedError as e:  # pragma: no cover
        # raised by langchain on unsupported message type
        raise InvalidMessageFormatError(
            "One or more dictionaries contain an unsupported message type for "
            "conversion to BaseMessage format."
        ) from e