Skip to main content

ModelResult

Kind: Class
Domain: Graph, serialization, and replay
Canonical import: from cadflow import ModelResult

Signature

class ModelResult(value: 'Any', session: 'GraphSession', result_node_ids: 'Tuple[str, ...]', model_json: 'str', session_json: 'str', artifact_paths: 'Mapping[str, Path]' = <factory>) -> None

Description

The value and durable graph artifacts produced by @model.

Parameters

NameTypeRequiredDefaultSource description
value'Any'yes-Not explicitly described in the source docstring.
session'GraphSession'yes-Not explicitly described in the source docstring.
result_node_ids'Tuple[str, ...]'yes-Not explicitly described in the source docstring.
model_json'str'yes-Not explicitly described in the source docstring.
session_json'str'yes-Not explicitly described in the source docstring.
artifact_paths'Mapping[str, Path]'no&lt;factory&gt;Not explicitly described in the source docstring.

Returns

Type: None

The source docstring does not declare additional return semantics.

Errors

The source docstring does not declare a narrower exception contract. Invalid types, values, ownership, paths, or backend state may still raise the corresponding public error.

Data fields

NameTypeDefault
value'Any'required
session'GraphSession'required
result_node_ids'Tuple[str, ...]'required
model_json'str'required
session_json'str'required
artifact_paths'Mapping[str, Path]'factory

Public members

MemberKindSignatureDescription
export_artifactsmethod(self, *, output_dir: 'str | Path') -&gt; "'ModelResult'"Write one self-contained Scene ZIP for the captured model.
replaymethod(self, *, strict: 'bool' = True) -&gt; 'List[Any]'Replay the captured canonical model result.

Behavior and constraints

  • Instances are immutable dataclass values; update workflows return a replacement value.

Import check

from cadflow import ModelResult

See also