ump_sdk.adapter_client

module ump-sdk

Typed client for the engine adapter contract (ump_spec.adapter).

AdapterClient("redacted-engine") resolves the base URL from the port registry. Methods take a request model or a plain dict and return parsed response models. fit returns JobAccepted when the adapter answers 202. Unbuilt operations raise ProblemError (501 OPERATION_UNAVAILABLE).

Classes

AdapterClient

class

class AdapterClient

Fields

Name	Type	Default	Description
base_url		_resolve(name_or_url)

Methods and properties (12)

init constructor

AdapterClient(
    self,
    name_or_url: str,
    *,
    principal: str | None = None,
    timeout: float = 120.0,
    transport: httpx.BaseTransport | None = None,
) -> None

metadata method

def metadata(self) -> AdapterMetadata

fit method

def fit(self, req: FitRequest | dict[str, Any]) -> FitResponse | JobAccepted

score method

def score(self, req: ScoreRequest | dict[str, Any]) -> ScoreResponse

response_curve method

def response_curve(
    self,
    req: ResponseCurveRequest | dict[str, Any],
) -> ResponseCurveResponse

marginal_return method

def marginal_return(
    self,
    req: MarginalReturnRequest | dict[str, Any],
) -> MarginalReturnResponse

decompose method

def decompose(self, req: DecomposeRequest | dict[str, Any]) -> DecomposeResponse

optimize method

def optimize(self, req: OptimizeRequest | dict[str, Any]) -> OptimizeResponse

calibrate method

def calibrate(self, req: CalibrateRequest | dict[str, Any]) -> CalibrateResponse

update method

def update(self, req: UpdateRequest | dict[str, Any]) -> UpdateResponse

healthy method

def healthy(self) -> bool

close method

def close(self) -> None

Source: packages/ump-sdk/src/ump_sdk/adapter_client.py, line 52

AsyncAdapterClient

class

class AsyncAdapterClient

Fields

Name	Type	Default	Description
base_url		_resolve(name_or_url)

Methods and properties (11)

init constructor

AsyncAdapterClient(
    self,
    name_or_url: str,
    *,
    principal: str | None = None,
    timeout: float = 120.0,
    transport: httpx.AsyncBaseTransport | None = None,
) -> None

metadata method

async def metadata(self) -> AdapterMetadata

fit method

async def fit(self, req: FitRequest | dict[str, Any]) -> FitResponse | JobAccepted

score method

async def score(self, req: ScoreRequest | dict[str, Any]) -> ScoreResponse

response_curve method

async def response_curve(
    self,
    req: ResponseCurveRequest | dict[str, Any],
) -> ResponseCurveResponse

marginal_return method

async def marginal_return(
    self,
    req: MarginalReturnRequest | dict[str, Any],
) -> MarginalReturnResponse

decompose method

async def decompose(self, req: DecomposeRequest | dict[str, Any]) -> DecomposeResponse

optimize method

async def optimize(self, req: OptimizeRequest | dict[str, Any]) -> OptimizeResponse

calibrate method

async def calibrate(self, req: CalibrateRequest | dict[str, Any]) -> CalibrateResponse

update method

async def update(self, req: UpdateRequest | dict[str, Any]) -> UpdateResponse

aclose method

async def aclose(self) -> None

Source: packages/ump-sdk/src/ump_sdk/adapter_client.py, line 117

Constants

Name	Type	Value	Description
R		TypeVar('R', bound=BaseModel)