Skip to content

Session Settings

Session configuration settings.

SessionSettings

Settings for session operations.

This class holds optional session configuration parameters that can be used when interacting with session methods.

Source code in src/agents/memory/session_settings.py 
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
@dataclass
class SessionSettings:
    """Settings for session operations.

    This class holds optional session configuration parameters that can be used
    when interacting with session methods.
    """

    limit: int | None = None
    """Maximum number of items to retrieve. If None, retrieves all items."""

    def resolve(self, override: SessionSettings | dict[str, Any] | None) -> SessionSettings:
        """Produce a new SessionSettings by overlaying any non-None values from the
        override on top of this instance."""
        if override is None:
            return self
        override_fields = (
            set(_dataclass_input_values(override, type(self)))
            if isinstance(override, dict)
            else None
        )
        override = _coerce_session_settings(override, settings_type=type(self))

        changes = {
            field.name: getattr(override, field.name)
            for field in fields(self)
            if (override_fields is None or field.name in override_fields)
            and getattr(override, field.name) is not None
        }

        return replace(self, **changes)

    def to_dict(self) -> dict[str, Any]:
        """Convert settings to a dictionary."""
        return dataclasses.asdict(self)

limit class-attribute instance-attribute 

limit: int | None = None

Maximum number of items to retrieve. If None, retrieves all items.

resolve 

resolve(
    override: SessionSettings | dict[str, Any] | None,
) -> SessionSettings

Produce a new SessionSettings by overlaying any non-None values from the override on top of this instance.

Source code in src/agents/memory/session_settings.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def resolve(self, override: SessionSettings | dict[str, Any] | None) -> SessionSettings:
    """Produce a new SessionSettings by overlaying any non-None values from the
    override on top of this instance."""
    if override is None:
        return self
    override_fields = (
        set(_dataclass_input_values(override, type(self)))
        if isinstance(override, dict)
        else None
    )
    override = _coerce_session_settings(override, settings_type=type(self))

    changes = {
        field.name: getattr(override, field.name)
        for field in fields(self)
        if (override_fields is None or field.name in override_fields)
        and getattr(override, field.name) is not None
    }

    return replace(self, **changes)

to_dict 

to_dict() -> dict[str, Any]

Convert settings to a dictionary.

Source code in src/agents/memory/session_settings.py 
62
63
64
def to_dict(self) -> dict[str, Any]:
    """Convert settings to a dictionary."""
    return dataclasses.asdict(self)

resolve_session_limit 

resolve_session_limit(
    explicit_limit: int | None,
    settings: SessionSettings | dict[str, Any] | None,
) -> int | None

Safely resolve the effective limit for session operations.

Source code in src/agents/memory/session_settings.py 
18
19
20
21
22
23
24
25
26
27
def resolve_session_limit(
    explicit_limit: int | None,
    settings: SessionSettings | dict[str, Any] | None,
) -> int | None:
    """Safely resolve the effective limit for session operations."""
    if explicit_limit is not None:
        return explicit_limit
    if settings is not None:
        return coerce_session_settings(settings).limit
    return None

coerce_session_settings 

coerce_session_settings(
    value: SessionSettings | dict[str, Any],
) -> SessionSettings

Normalize session settings while preserving existing typed instances.

Source code in src/agents/memory/session_settings.py 
67
68
69
70
71
def coerce_session_settings(
    value: SessionSettings | dict[str, Any],
) -> SessionSettings:
    """Normalize session settings while preserving existing typed instances."""
    return _coerce_session_settings(value, settings_type=SessionSettings)