Skip to content

Commit a7a4806

Browse files
docs: sync Haystack API reference on Docusaurus (#12096)
Co-authored-by: anakin87 <44616784+anakin87@users.noreply.github.com>
1 parent 139af73 commit a7a4806

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -955,14 +955,21 @@ read(reference: str) -> str
955955

956956
Read back the content previously written to `reference`.
957957

958+
The resolved reference must stay within the store root: callers must treat it as an opaque
959+
store-scoped reference, not as an arbitrary filesystem path.
960+
958961
**Parameters:**
959962

960-
- **reference** (<code>str</code>) – A path returned by `write`.
963+
- **reference** (<code>str</code>) – A store reference returned by `write`.
961964

962965
**Returns:**
963966

964967
- <code>str</code> – The stored content.
965968

969+
**Raises:**
970+
971+
- <code>ValueError</code> – If `reference` resolves to a location outside the store root.
972+
966973
#### to_dict
967974

968975
```python

0 commit comments

Comments
 (0)