We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 139af73 commit a7a4806Copy full SHA for a7a4806
1 file changed
docs-website/reference/haystack-api/hooks_api.md
@@ -955,14 +955,21 @@ read(reference: str) -> str
955
956
Read back the content previously written to `reference`.
957
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
+
961
**Parameters:**
962
-- **reference** (<code>str</code>) – A path returned by `write`.
963
+- **reference** (<code>str</code>) – A store reference returned by `write`.
964
965
**Returns:**
966
967
- <code>str</code> – The stored content.
968
969
+**Raises:**
970
971
+- <code>ValueError</code> – If `reference` resolves to a location outside the store root.
972
973
#### to_dict
974
975
```python
0 commit comments