040eb33ea6
* improve ci and tests * add more tests * fixes * fix tests * fix more * fix * fix * fix * fix * fix for real * tests and doc * fix cp * fix link pg0 * fix pg0 * fix pg0 * fix pg0 * even better * more * fix
78 lines
No EOL
11 KiB
Text
78 lines
No EOL
11 KiB
Text
---
|
|
id: recall-memories
|
|
title: "Recall memory"
|
|
description: "Recall memory using semantic similarity and spreading activation."
|
|
sidebar_label: "Recall memory"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWW1v2zgS/isDfkkLyO9O2go4HNI02AvQbLqNbxfYbGDQ0tjmWiK1JJXEMPzfD0NStvyaNC0Oh8XlQ5NKw+G8Ps9QXLAUTaJFYYWSLGZfMeFZBjnmSs+hNEJOwGDOpRUJGJGLjGth58BlCqbQyFOS4IkVD5xUNP+Qf0gAgMEUwc4LhIJrnqNFDcKAcvvwzK3PS2NhhKAkghrHfl0DTh6VztKTGH5CiZpnMJPqMcN0gsBHqrRQoCoyjKDIeIImAnxAaU3kdNqpkBMDdsotTHlRoFypxacCtUCZ4EkM1+SgQBNUrt9FkCj5gNo4d0hr4v4Ay2cowybczAwUqMdK55iudlCFkELJk9h5P+JydmLAy8AIM4FjE9EyUyAFDIPNDwIfCyWkNVXwbtGCkElWpjhEaYUVaP5hdYlgFUzQgns4BzUyqH3gDfBMyYkRKYL2SdRoysyaJouYKlA7sauUxcy/H+YhBixiqyQZFt8tmOQ5spiRB0ORsogJqo2C2ymLmMa/SqExZTFZFDGTTDHnLF4wyjeLmbFayAmLmBU2owcfuZzBVcqWy3u/HI39qNI5rdnWlihpUVp6xYsiE4kzu/WnofJc1DYrNDlFkaH//VWinh+z4RcnsIycgFvC5fxm7NwVFnOzuzgIs5hxrTktXknIMssYeVOpHzit0VY3fRbGghrDmCfWdYOhBIb0vElxzClB9IweiDFIZYGqQ4wFpm/JglGZTtCFI4izmOUuJ9ueoixzFt+xTD2yKMhMxWTKamZ+9Nq27fSPIcMHzFzFBhtbGscZJhZW9WOaZFTOn4ZWzVDWoyakxQnqWsyv+RMMvFi0Nr/f/nBGodU8wdrykVIZcllbPnAStZVjnhlcRj7ZQytyNJbnxWYyt3N4OGeuJGCwUrMdlavbG9e93ELKLYJXCW+wOWlGcNJtd3uN9mmj1x50e3G/HbfbJy5loXN9zuoKbwrfqRRgL+TAM01FQMWUWw5vqo4HrrGCgRRGcwiBeEsNu1H91YrNSGzKvC5ndfOv+ZPIyxy8FufFHhyqJ+y03V6uu0iN/sTE1va6dKuvvIchODu77g/aPgAUcgf59qV/K8l+930Kmw6HrQJaSr9TYfgoW8k6awyRXt3nzUiHCCTTUs7+++nx28Kb8Dvnc+Jbq0uZcEsAU7P7fedD91iyLkjHq3IVdv+u9Gj+GPSssrJY0r8oKSXRTo4qdI2rJ+nbJjvm35Zr+0TXXHUXCKeGJn5y+urZbScy4TnkKsWshrCAMnXcTzWETzwvMgccFewHHK9BSr3X91Ra/REhbVRRI/uNZqJUpHCeiQTB8HkYfnKeTIVEyJBrKeTkn2wPxLI9cMdWKO65O1DrHXMTnHOoGqvY/ZJ+KIamUNJ4+7vt9i5K3pZJgsaMywy+BmH26rkglBr9uWL5TQmRHhsbaGqJmMUne0xqQO9XBfM6NqIJgnTsx/IfMKJcVoqXIZrep9fYehGWLyOmkqTUGtOhsVy/WuFN0AK3TktdL8r0u7VeSpfGnGKrJKZD/mpLrysdcO7sTFVSkt6heLWZn4IKuApWWk6DwKa69ZTwZaN8D9VDAK3jroSNKoL6Dh8cO/gZ/zhu+tGVimcPdlKv7kDnrZCTbOtQA9QPW5C5doH1T8/w3fsP7QZ2uqNGr5+eNvjZu/eND+1Ot9c/PaN3rNYFBFgzEHKs2FZGmUFDFD/ko6TT7bF6f94xh6QsYj8pNcmQPHJrOt0e0i4NfP9h1Oh0016D90/PGv3u2Vmn33nXbzvs3CxHAth+o91pdE4HnXbcI4D9nW2Wg1GlTlxGMp7MdtvkkI7tJj0kF6LhCYJiYoBb8N6BkmCnCOdXYJHn6wOIB/vlNhTVs+sxuD70P1fYa0J5WS37s8JB+DzUPXvG6PnwOCP4oTX0asKlkiLh2dAfmQ8vu6gk4WeSpNTVh+bD/PRS7vnx4PZMJ283sQ/MzdqrGntvdvS5rM/ZYQrhMszVzR1WqyF6PWbPGbhO506itqK/48Wt5RYP2n9BzSQtUMh5FmY6Nd7vwguKd8XM2xuFWjNkTe3ARWfDVbr9XL3qsH0njZdV/48chAIWyxSfjh5nAm04OQcP4WTyzHeBSmo7Xr9N0U5RO5xyJgAZDI/crA89kPrPaG5IhkzkwprdjwwvZrFNX7cZ8RMB9075OMvcWZ9SysF4hnOKvrF0Lny6927hK4a+PZkIZjj3HxFWNPmcj1VR7ePp/X1RvTh8yjH7ONtV34soe83yvrLagXBfyPffQG9NuJ3iiYERonuu0bnTgzlybZpNf5ask42fBcjCLU5YTQk1ennJiNDZRilq5ZfNDN/C48v7cCzz56S7HzdI/bhJ6X9nyrmvzTCyzIeruHVeedCmI/bQYKJkaljcbna6vWU4Kve73d3T8a88E6nnzUutlX790ThFy0V2ZPLIVLLx9gUTRYXwy/vDHP5ZeQPd0GImx+jkGo3hE6wfrQ+OZRQM8IfoZ4CN/PJbB7kawq3D66N72I1PPnzHPin9azD4sqPQ5zZHO1VUy4VyX4vc3UrMWg+dVmCiFt2+mNYiXMIsW9V1TctjKosYZfjr+jrl8m/9+Yi8GCtXAlV4hUyNmEwtUKDh/MvVDiNVLxx4r+RDz/DE9UxA6Wt/5Xk7NxZzyju5SSy3FjkveDJF6DbJ9FJnLGZTawsTt1qPj49N7l43lZ60wlrT+nx1cfnz7WWj22w3pzbPSDHdLnrzOs12s02PqApyLmt7bVzEbvu1WPf8/29s/543tgFTiKtaRcaFg0tXc4sAFnfsoVMbXCN3XUujYLy+t61d8QbUuI/YlCAnvmOLxYgb/LfOlkt6HBr97j5iD1wL+mbuwL76fh5G4yOl+OZrQNm3cMiDCkwl1fQDz0r6H4vYDOe1C2dHH1PkKWpngn974TdqOJBfr97hPOIjv+I8SbCwR2Xva1j85eZ2QHEMV9M0xdJtOaf7VPrXWaqK1YndPVuwjMtJSTQVM6+Tfv4DGXJM5w==
|
|
sidebar_class_name: "post api-method"
|
|
info_path: docs/api-reference/endpoints/hindsight-http-api
|
|
custom_edit_url: null
|
|
---
|
|
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import ParamsDetails from "@theme/ParamsDetails";
|
|
import RequestSchema from "@theme/RequestSchema";
|
|
import StatusCodes from "@theme/StatusCodes";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
import Heading from "@theme/Heading";
|
|
|
|
<Heading
|
|
as={"h1"}
|
|
className={"openapi__heading"}
|
|
children={"Recall memory"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"post"}
|
|
path={"/v1/default/banks/{bank_id}/memories/recall"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Recall memory using semantic similarity and spreading activation.
|
|
|
|
The type parameter is optional and must be one of:
|
|
- 'world': General knowledge about people, places, events, and things that happen
|
|
- 'experience': Memories about experience, conversations, actions taken, and tasks performed
|
|
- 'opinion': The bank's formed beliefs, perspectives, and viewpoints
|
|
|
|
Set include_entities=true to get entity observations alongside recall results.
|
|
|
|
<Heading
|
|
id={"request"}
|
|
as={"h2"}
|
|
className={"openapi-tabs__heading"}
|
|
children={"Request"}
|
|
>
|
|
</Heading>
|
|
|
|
<ParamsDetails
|
|
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}}]}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"type":"string","title":"Query"},"types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Types","description":"List of fact types to recall (defaults to all if not specified)"},"budget":{"default":"mid","type":"string","enum":["low","mid","high"],"title":"Budget","description":"Budget levels for recall/reflect operations."},"max_tokens":{"type":"integer","title":"Max Tokens","default":4096},"trace":{"type":"boolean","title":"Trace","default":false},"query_timestamp":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query Timestamp","description":"ISO format date string (e.g., '2023-05-30T23:40:00')"},"include":{"description":"Options for including additional data (entities are included by default)","properties":{"entities":{"anyOf":[{"properties":{"max_tokens":{"type":"integer","title":"Max Tokens","description":"Maximum tokens for entity observations","default":500}},"type":"object","title":"EntityIncludeOptions","description":"Options for including entity observations in recall results."},{"type":"null"}],"description":"Include entity observations. Set to null to disable entity inclusion.","default":{"max_tokens":500}},"chunks":{"anyOf":[{"properties":{"max_tokens":{"type":"integer","title":"Max Tokens","description":"Maximum tokens for chunks (chunks may be truncated)","default":8192}},"type":"object","title":"ChunkIncludeOptions","description":"Options for including chunks in recall results."},{"type":"null"}],"description":"Include raw chunks. Set to {} to enable, null to disable (default: disabled)."}},"type":"object","title":"IncludeOptions"}},"type":"object","required":["query"],"title":"RecallRequest","description":"Request model for recall endpoint.","example":{"budget":"mid","include":{"entities":{"max_tokens":500}},"max_tokens":4096,"query":"What did Alice say about machine learning?","query_timestamp":"2023-05-30T23:40:00","trace":true,"types":["world","experience"]}}}}}}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"results":{"items":{"properties":{"id":{"type":"string","title":"Id"},"text":{"type":"string","title":"Text"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"entities":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Entities"},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context"},"occurred_start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred Start"},"occurred_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occurred End"},"mentioned_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mentioned At"},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Id"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata"},"chunk_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chunk Id"}},"type":"object","required":["id","text"],"title":"RecallResult","description":"Single recall result item.","example":{"chunk_id":"456e7890-e12b-34d5-a678-901234567890","context":"work info","document_id":"session_abc123","entities":["Alice","Google"],"id":"123e4567-e89b-12d3-a456-426614174000","mentioned_at":"2024-01-15T10:30:00Z","metadata":{"source":"slack"},"occurred_end":"2024-01-15T10:30:00Z","occurred_start":"2024-01-15T10:30:00Z","text":"Alice works at Google on the AI team","type":"world"}},"type":"array","title":"Results"},"trace":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Trace"},"entities":{"anyOf":[{"additionalProperties":{"properties":{"entity_id":{"type":"string","title":"Entity Id"},"canonical_name":{"type":"string","title":"Canonical Name"},"observations":{"items":{"properties":{"text":{"type":"string","title":"Text"},"mentioned_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mentioned At"}},"type":"object","required":["text"],"title":"EntityObservationResponse","description":"An observation about an entity."},"type":"array","title":"Observations"}},"type":"object","required":["entity_id","canonical_name","observations"],"title":"EntityStateResponse","description":"Current mental model of an entity."},"type":"object"},{"type":"null"}],"title":"Entities","description":"Entity states for entities mentioned in results"},"chunks":{"anyOf":[{"additionalProperties":{"properties":{"id":{"type":"string","title":"Id"},"text":{"type":"string","title":"Text"},"chunk_index":{"type":"integer","title":"Chunk Index"},"truncated":{"type":"boolean","title":"Truncated","description":"Whether the chunk text was truncated due to token limits","default":false}},"type":"object","required":["id","text","chunk_index"],"title":"ChunkData","description":"Chunk data for a single chunk."},"type":"object"},{"type":"null"}],"title":"Chunks","description":"Chunks for facts, keyed by chunk_id"}},"type":"object","required":["results"],"title":"RecallResponse","description":"Response model for recall endpoints.","example":{"chunks":{"456e7890-e12b-34d5-a678-901234567890":{"chunk_index":0,"id":"456e7890-e12b-34d5-a678-901234567890","text":"Alice works at Google on the AI team. She's been there for 3 years..."}},"entities":{"Alice":{"canonical_name":"Alice","entity_id":"123e4567-e89b-12d3-a456-426614174001","observations":[{"mentioned_at":"2024-01-15T10:30:00Z","text":"Alice works at Google on the AI team"}]}},"results":[{"chunk_id":"456e7890-e12b-34d5-a678-901234567890","context":"work info","entities":["Alice","Google"],"id":"123e4567-e89b-12d3-a456-426614174000","occurred_end":"2024-01-15T10:30:00Z","occurred_start":"2024-01-15T10:30:00Z","text":"Alice works at Google on the AI team","type":"world"}],"trace":{"num_results":1,"query":"What did Alice say about machine learning?","time_seconds":0.123}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
|
>
|
|
|
|
</StatusCodes>
|
|
|
|
|
|
|