Real-time serving (add-on)
==========================

Resident, in-process record matching (``madmatcher_pro.serving``): publish a batch
build's artifacts as a bundle once, load it into memory, and answer each incoming
record from the loaded state. This is a separately-licensed add-on;
``RealtimeMatcher.load`` requires the ``realtime`` license entitlement. Start with
:doc:`the real-time matching tutorial </tutorials/realtime/realtime-matching-tutorial>`;
this page documents every public entry point.

Publishing a bundle
-------------------

.. autofunction:: madmatcher_pro.serving.publish_serving_artifacts

.. autofunction:: madmatcher_pro.serving.check_embedding_store

The resident matcher
--------------------

.. autoclass:: madmatcher_pro.serving.RealtimeMatcher
   :members: load, match, match_batch, close

Serving pools
-------------

.. autoclass:: madmatcher_pro.serving.MatcherPool
   :members: submit, match, map, imap_unordered, scale, close, workers

.. autoclass:: madmatcher_pro.serving.MicroBatchMatcher
   :members: submit, match, scale, close, workers

.. autoclass:: madmatcher_pro.serving.ProcessMatcherPool
   :members: submit, match, map, imap_unordered, close, procs, in_flight, submitted

.. autoexception:: madmatcher_pro.serving.QueueFullError

Bundle refresh
--------------

.. autoclass:: madmatcher_pro.serving.HotSwappableMatcher
   :members: match, swap, close, version, current, undrained

.. autoclass:: madmatcher_pro.serving.BundleWatcher
   :members: start, stop, check_once, current_version

.. autofunction:: madmatcher_pro.serving.publish_bundle_version

.. autofunction:: madmatcher_pro.serving.read_bundle_version

Streaming runners
-----------------

.. autofunction:: madmatcher_pro.serving.run_matching

.. autofunction:: madmatcher_pro.serving.run_matching_durable

.. autoclass:: madmatcher_pro.serving.MatchRunStats
   :members: shards_done, shards_skipped

.. autofunction:: madmatcher_pro.serving.batched

Record sources
--------------

.. autoclass:: madmatcher_pro.serving.RecordSource
   :members: close

.. autoclass:: madmatcher_pro.serving.IterableSource

.. autoclass:: madmatcher_pro.serving.ParquetSource

.. autoclass:: madmatcher_pro.serving.CsvSource

.. autoclass:: madmatcher_pro.serving.QueueSource
   :members: put, close

Result sinks
------------

.. autoclass:: madmatcher_pro.serving.ResultSink
   :members: write, flush, close

.. autoclass:: madmatcher_pro.serving.MemorySink
   :members: to_frame

.. autoclass:: madmatcher_pro.serving.DataFrameSink
   :members: result

.. autoclass:: madmatcher_pro.serving.CallbackSink

.. autoclass:: madmatcher_pro.serving.ParquetSink

.. autoclass:: madmatcher_pro.serving.FanOutResultSink

Batch-to-serving handoff
------------------------

.. autoclass:: madmatcher_pro.serving.BatchToServing
   :members: accept, publish, start_serving, drain, match, close, state, spool,
             matcher

.. autoclass:: madmatcher_pro.serving.RecordSpool
   :members: append, close_segment, close, appended, pending, segments, source_for,
             recover_open_segments, clear_drained

Durable claims
--------------

Filesystem-only per-unit claims behind ``run_matching_durable``; use these directly
only for a custom durable runner.

.. autoclass:: madmatcher_pro.serving.RecordClaimStore

.. autoclass:: madmatcher_pro.serving.ShardClaimStore

Advanced: resident probes and feature state
-------------------------------------------

The pieces ``RealtimeMatcher`` composes, usable directly for a custom serving layer.

.. autoclass:: madmatcher_pro.serving.ResidentSparklyProbe

.. autoclass:: madmatcher_pro.serving.ResidentSemanticProbe

.. autoclass:: madmatcher_pro.serving.ResidentDelexProbe

.. autoclass:: madmatcher_pro.serving.ResidentEmbeddingStore
   :members: load, serialize, cosine_for_ids, close

.. autoclass:: madmatcher_pro.serving.ServedState
   :members: load, known_ids

.. autofunction:: madmatcher_pro.serving.featurize_one

.. autofunction:: madmatcher_pro.serving.publish_feature_state

.. autofunction:: madmatcher_pro.serving.reciprocal_rank_fusion_local

Probe serializers
-----------------

How an incoming record's fields become the one text a resident embedder embeds,
matching the batch-time corpus serialization.

.. autoclass:: madmatcher_pro.serving.ProbeSerializer

.. autoclass:: madmatcher_pro.serving.DittoProbeSerializer

.. autoclass:: madmatcher_pro.serving.PlainConcatProbeSerializer

.. autofunction:: madmatcher_pro.serving.register_serializer