Skip to content

Commit 43b5092

Browse files
HaystackBotsjrl
andauthored
docs: sync Haystack API reference on Docusaurus (#12184)
Co-authored-by: sjrl <10526848+sjrl@users.noreply.github.com>
1 parent 66fb9d0 commit 43b5092

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

docs-website/reference/haystack-api/data_classes_api.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,11 @@ A dataclass to hold the state of the pipeline at a specific point in time.
123123
- **component_visits** (<code>dict\[str, int\]</code>) – A dictionary mapping component names to their visit counts.
124124
- **inputs** (<code>dict\[str, Any\]</code>) – The inputs processed by the pipeline at the time of the snapshot.
125125
- **pipeline_outputs** (<code>dict\[str, Any\]</code>) – Dictionary containing the final outputs of the pipeline up to the breakpoint.
126+
- **inputs_format** (<code>str | None</code>) – Which format `inputs` are stored in. `"internal"` means each input records the component
127+
that sent it, keyed by the position it arrived in, as in
128+
`{component: {socket: {"0": {"sender": ..., "value": ...}}}}`. `None` marks snapshots taken before Haystack
129+
recorded the sender, which hold one flattened value per socket, `{component: {socket: value}}`, and can only
130+
be resumed on a component's first visit.
126131

127132
#### to_dict
128133

0 commit comments

Comments
 (0)