.. _custom-metadata:

Custom Metadata in Tarantool
======================================================

It is often necessary to assign additional metadata to the faces extracted from images uploaded to the record index and now stored in the feature vector database.



.. rubric:: In this section:

.. contents::
   :local:
 

To assign custom meta fields to the face objects, do the following:

#. Prepare the list of custom meta fields to assign.
#. Open the ``/etc/findface-security/config.py`` configuration file. 

   .. code::

      sudo vi /etc/findface-security/config.py
      
#. In the ``FFSECURITY`` section, uncomment the ``CUSTOM_FIELDS`` -> ``face_object`` section and modify the exemplary content, considering the following:

   * ``field_name``: field's name;
   * ``type``: data type;
   * ``default``: field's default value. If a default value exceeds ``1e14 - 1``, use a string data type to specify it, for example, ``"123123.."`` instead of ``123123..``.

   .. code::

      FFSECURITY = {

      ...

          # -- Custom model fields --
          ...
          # Edit CUSTOM_FIELDS -> `face_object` section to customize face object fields.
          ...
          # 'CUSTOM_FIELDS': {
                ...
                'face_object': {
                    'items': [
                        {
                            "field_name": "tag_name_1",
                            "type": "string",
                            "default": "change_me"
                        },
                        {
                            "field_name": "tag_name_2",
                            "type": "uint",
                            "default": 123
                        },
                        {
                            "field_name": "tag_name_3",
                            "type": "bool",
                            "default": True
                        },
                    ]
                }

            }


#. :ref:`Add the new meta fields <modify-schema>` to the feature vector database structure.  

#. Restart the ``findface-security`` service.

   .. code::

      sudo systemctl restart findface-security.service

   You can work with the new meta fields through :ref:`HTTP API <api>` using the ``objects/faces/`` methods. 
 

.. seealso::
   To create custom tabs, fields, and filters in records, refer to :ref:`custom-tabs`.