imappingstrategy

Mapping Strategy Interface

IMappingStrategy dataclass

Bases: Protocol

Mapping Strategy Interface.

Source code in oteapi/interfaces/imappingstrategy.py

@dataclass  # type: ignore[misc]
class IMappingStrategy(Protocol):
    """Mapping Strategy Interface."""

    mapping_config: "MappingConfig"

    def get(self) -> "AttrDict":
        """Execute the strategy.

        Returns:
            An update model of key/value-pairs to be stored in the
            session-specific context from services.

        """

    def initialize(self) -> "AttrDict":
        """Initialize data class.

        This method will be called through the `/initialize` endpoint of the OTE-API
        Services.

        Returns:
            An update model of key/value-pairs to be stored in the
            session-specific context from services.

        """

get()

Execute the strategy.

Returns:

Type	Description
AttrDict	An update model of key/value-pairs to be stored in the
AttrDict	session-specific context from services.

Source code in oteapi/interfaces/imappingstrategy.py

def get(self) -> "AttrDict":
    """Execute the strategy.

    Returns:
        An update model of key/value-pairs to be stored in the
        session-specific context from services.

    """

initialize()

Initialize data class.

This method will be called through the /initialize endpoint of the OTE-API Services.

Returns:

Type	Description
AttrDict	An update model of key/value-pairs to be stored in the
AttrDict	session-specific context from services.

Source code in oteapi/interfaces/imappingstrategy.py

def initialize(self) -> "AttrDict":
    """Initialize data class.

    This method will be called through the `/initialize` endpoint of the OTE-API
    Services.

    Returns:
        An update model of key/value-pairs to be stored in the
        session-specific context from services.

    """