core.memory
===========

Memory vector recall: semantic search over PermanentHistory turns.

Tier 1 primitives:

- :class:`TurnHit` — ranked result returned by search.
- :class:`Entry` — storage tuple yielded by ``TurnVectorStore.iter_entries``.
- :class:`TurnVectorStore` — in-memory append-only vector store with
  cosine-similarity search.

L2 adds:

- :class:`Memory` — facade combining an ``Embeddings`` backend with a
  ``TurnVectorStore`` for high-level ``index_turn`` / ``search`` /
  ``reindex`` operations.

L3 adds:

- :func:`persist_store` / :func:`load_store` — Parquet persistence for
  the in-memory store.

.. automodule:: ffai.core.memory
   :members:
   :undoc-members:
   :show-inheritance:

Classes
-------

.. autoclass:: ffai.core.memory.Entry
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.core.memory.Memory
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.core.memory.TurnHit
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

.. autoclass:: ffai.core.memory.TurnVectorStore
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

Functions
---------

.. autofunction:: ffai.core.memory.cosine_similarity

.. autofunction:: ffai.core.memory.load_store

.. autofunction:: ffai.core.memory.persist_store