medkit.io.medkit_json._common
=============================

.. py:module:: medkit.io.medkit_json._common


Attributes
----------

.. autoapisummary::

   medkit.io.medkit_json._common.MEDKIT_JSON_VERSION


Classes
-------

.. autoapisummary::

   medkit.io.medkit_json._common.ContentType


Functions
---------

.. autoapisummary::

   medkit.io.medkit_json._common.build_header
   medkit.io.medkit_json._common.check_header


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

.. py:data:: MEDKIT_JSON_VERSION
   :value: '0.2'


.. py:class:: ContentType(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   
   Type of content.



   :Attributes:

       **TEXT_DOCUMENT** : Text document
           ..

       **TEXT_DOCUMENT_LIST** : List of text documents
           ..

       **TEXT_ANNOTATION_LIST** : List of text annotations
           ..

       **AUDIO_DOCUMENT** : Audio document
           ..

       **AUDIO_DOCUMENT_LIST** : List of audio documents
           ..

       **AUDIO_ANNOTATION_LIST** : List of audio annotations
           ..













   ..
       !! processed by numpydoc !!

   .. py:attribute:: TEXT_DOCUMENT
      :value: 'text_document'



   .. py:attribute:: TEXT_DOCUMENT_LIST
      :value: 'text_document_list'



   .. py:attribute:: TEXT_ANNOTATION_LIST
      :value: 'text_annotation_list'



   .. py:attribute:: AUDIO_DOCUMENT
      :value: 'audio_document'



   .. py:attribute:: AUDIO_DOCUMENT_LIST
      :value: 'audio_document_list'



   .. py:attribute:: AUDIO_ANNOTATION_LIST
      :value: 'audio_annotation_list'



.. py:function:: build_header(content_type: ContentType) -> dict[str, Any]

.. py:function:: check_header(data, expected_content_type: ContentType)