Skip to content

SyncFunctionResponses

Synchronous calls to the platform functions.run API return a SyncFunctionResponses object. It wraps one or more raw JSON payloads and exposes status, id, estimate, cost, and function_outputs accessors. Batch helpers (for example docking multiple ligands in a loop) aggregate multiple responses in one instance and sum costs and estimates when every response is in a consistent billing state.

For higher-level workflow classes (Docking, PocketFinder, SystemPrep, Molprops, Protonation), prefer the execution object’s own fields (estimate, cost, id) and domain return types from run() where applicable.

deeporigin.drug_discovery.sync_function_responses.SyncFunctionResponses dataclass

Wraps one or more raw functions.run JSON responses.

Holds a list of responses so batch runs (for example docking many ligands) can aggregate costs and estimates. Callers may attach domain-specific attributes on the instance (for example result.poses = LigandSet(...)).

Attributes:

Name Type Description
responses list[dict]

Raw JSON response dicts from the function API.

cost property 

cost: float | None

Total actual cost in dollars after completed execution.

estimate property 

estimate: float | None

Total cost estimate in dollars when quote=True was used.

function_key property 

function_key: str | None

The function key from the first response.

function_outputs property 

function_outputs: list[dict]

The functionOutputs dicts from all responses.

function_version property 

function_version: str | None

The function version from the first response.

id property 

id: str | None

The execution ID from the first response.

response property 

response: dict

The first raw API response (convenience for single-response results).

status property 

status: str | None

Execution status from the first response.