medkit.core.collection
======================

.. py:module:: medkit.core.collection


Classes
-------

.. autoapisummary::

   medkit.core.collection.Collection


Module Contents
---------------

.. py:class:: Collection(*, text_docs: list[medkit.core.text.TextDocument] | None = None, audio_docs: list[medkit.core.audio.AudioDocument] | None = None)

   
   Collection of documents of any modality (text, audio).

   This class allows to group together a set of documents representing a common
   unit (for instance a patient), even if they don't belong to the same modality.

   This class is still a work-in-progress. In the future it should be possible to attach
   additional information to a `Collection`.

   :Parameters:

       **text_docs** : list of TextDocument, optional
           List of text documents.

       **audio_docs: list of TextDocument, optional**
           List of audio documents.














   ..
       !! processed by numpydoc !!

   .. py:property:: all_docs
      :type: list[medkit.core.document.Document]

      
      Return all documents belonging to the collection.
















      ..
          !! processed by numpydoc !!


   .. py:method:: to_dict() -> dict[str, Any]