Распознавание
-------------

REST API v2 предоставляет улучшенные возможности для настройки и управления процессом распознавания товаров, включая гибкие настройки скорости, режимов обучения и обратной связи.

Установка скорости распознавания
=================================

Установить скорость распознавания (чем быстрее, тем ниже точность распознавания). Скорость может быть **normal** или **fast**. **fast** аналогична предыдущей версии. **normal** медленнее предыдущей, но дает лучший результат распознавания. По умолчанию **fast**.

**URL интерфейса:** http://172.22.0.6/api/set_predict_speed

**Метод запроса:** POST

**Content-Type:** json

**Параметры тела запроса**

.. code::

    {
        "speed": "normal"
    }

+----------+-----------+---------+-----------+----------------------+
|Параметр  |Пример     |Тип      |Обязательно|Описание              |
|          |значения   |         |?          |                      |
+==========+===========+=========+===========+======================+
|speed     |normal     |String   |Да         |Скорость распознавания|
+----------+-----------+---------+-----------+----------------------+

**Пример успешного ответа**

.. code::

    {
        "code": 0,
        "data": null
    }

+----------+-----------+---------+-------------------------+
|Параметр  |Пример     |Тип      |Описание                 |
|          |значения   |         |                         |
+==========+===========+=========+=========================+
|code      |0          |Number   |Код результата: 0 - успех|
+----------+-----------+---------+-------------------------+
|data      |—          |Null     |—                        |
+----------+-----------+---------+-------------------------+

Получение результата распознавания
====================================

Получить результат распознавания на основе текущего изображения камеры.

**URL интерфейса:** http://172.22.0.6/api/get_result

**Метод запроса:** GET

**Content-Type:** none

**Пример успешного ответа**

.. code::

    {
        "code": 0,
        "data": {
            "items": [
                {
                    "id": "002",
                    "score": 0.29
                },
                {
                    "id": "003",
                    "score": 0.28
                },
                {
                    "id": "001",
                    "score": 0.25
                },
                {
                    "id": "004",
                    "score": 0.18
                }
            ],
            "sid": "19700101082633041672962"
        }
    }

+----------+-----------------------+---------+-------------------------+
|Параметр  |Пример значения        |Тип      |Описание                 |
|          |                       |         |                         |
+==========+=======================+=========+=========================+
|code      |0                      |Number   |Код результата: 0 - успех|
+----------+-----------------------+---------+-------------------------+
|data.items|—                      |Array    |Список PLU и оценок      |
+----------+-----------------------+---------+-------------------------+
|data.sid  |19700101082633041672962|String   |ID этого распознавания   |
+----------+-----------------------+---------+-------------------------+

Установка максимального количества результатов
=================================================

Установить максимальное количество результатов за одно распознавание, от 1 до 5.

**URL интерфейса:** http://172.22.0.6/api/set_max_result

**Метод запроса:** POST

**Content-Type:** json

**Параметры тела запроса**

.. code::

    {
        "num": 3
    }

+----------+-----------+---------+-----------+------------------------------+
|Параметр  |Пример     |Тип      |Обязательно|Описание                      |
|          |значения   |         |?          |                              |
+==========+===========+=========+===========+==============================+
|num       |3          |Number   |Да         |Максимальное количество       |
|          |           |         |           |результатов                   |
+----------+-----------+---------+-----------+------------------------------+

**Пример успешного ответа**

.. code::

    {
        "code": 0,
        "data": null
    }

+----------+-----------+---------+-------------------------+
|Параметр  |Пример     |Тип      |Описание                 |
|          |значения   |         |                         |
+==========+===========+=========+=========================+
|code      |0          |Number   |Код результата: 0 - успех|
+----------+-----------+---------+-------------------------+
|data      |—          |Null     |—                        |
+----------+-----------+---------+-------------------------+

Отзыв о результате распознавания
==================================

Передать результаты распознавания модулю распознавания для самообучения. Функция имеет 3 варианта, которые можно установить через **set_learnmode**:

disabled : не влияет на модуль распознавания
limited : только оптимизирует точность распознавания товара, не добавляя новые шаблоны
full : оптимизирует точность распознавания товара и добавляет новые шаблоны при необходимости

**URL интерфейса:** http://172.22.0.6/api/result_feedback

**Метод запроса:** POST

**Content-Type:** json

**Параметры тела запроса**

.. code::

    {
        "sid": "19700101082633041672962",
        "id": "001"
    }

+----------+-----------------------+---------+------------+------------------------+
|Параметр  |Пример значения        |Тип      |Обязательно?|Описание                |
+==========+=======================+=========+============+========================+
|sid       |19700101082633041672962|String   |Да          |ID распознавания,       |
|          |                       |         |            |возвращенный            |
|          |                       |         |            |**get_result**          |
+----------+-----------------------+---------+------------+------------------------+
|id        |001                    |String   |Да          |PLU товара, выбранный   |
|          |                       |         |            |пользователем           |
+----------+-----------------------+---------+------------+------------------------+

**Пример успешного ответа**

.. code::

    {
        "code": 0,
        "data": null
    }

+----------+-----------+---------+-------------------------+
|Параметр  |Пример     |Тип      |Описание                 |
|          |значения   |         |                         |
+==========+===========+=========+=========================+
|code      |0          |Number   |Код результата: 0 - успех|
+----------+-----------+---------+-------------------------+
|data      |—          |Null     |—                        |
+----------+-----------+---------+-------------------------+

Установка режима обучения
===========================

Установить режим обучения. Модуль распознавания имеет два способа улучшения производительности распознавания: **add/delete_item_template** и **result_feedback**. Эта опция может устанавливать их в различные режимы.

Режимы обучения:

0: отключает и **add/delete_item_template**, и **result_feedback**
1: включает **add/delete_item_template** и устанавливает полную функциональность **result_feedback**
2: включает **add/delete_item_template** и устанавливает ограниченную функциональность **result_feedback**

**URL интерфейса:** http://172.22.0.6/api/set_learnmode

**Метод запроса:** POST

**Content-Type:** json

**Параметры тела запроса**

.. code::

    {
        "mode": 1
    }

+----------+-----------+---------+-----------+----------------------------+
|Параметр  |Пример     |Тип      |Обязательно|Описание                    |
|          |значения   |         |?          |                            |
+==========+===========+=========+===========+============================+
|mode      |1          |Number   |Да         |Режим обучения, допустимы   |
|          |           |         |           |значения 0, 1, 2            |
+----------+-----------+---------+-----------+----------------------------+

**Пример успешного ответа**

.. code::

    {
        "code": 0,
        "data": null
    }

+----------+-----------+---------+-------------------------+
|Параметр  |Пример     |Тип      |Описание                 |
|          |значения   |         |                         |
+==========+===========+=========+=========================+
|code      |0          |Number   |Код результата: 0 - успех|
+----------+-----------+---------+-------------------------+
|data      |—          |Null     |—                        |
+----------+-----------+---------+-------------------------+

Проверка настроек режима обучения
===================================

Проверить настройки режима обучения.

**URL интерфейса:** http://172.22.0.6/api/get_learnmode

**Метод запроса:** GET

**Content-Type:** none

**Пример успешного ответа**

.. code::

    {
        "code": 0,
        "data": {
            "mode": 1
        }
    }

+----------+-----------+---------+----------------------------------+
|Параметр  |Пример     |Тип      |Описание                          |
|          |значения   |         |                                  |
+==========+===========+=========+==================================+
|code      |0          |Number   |Код результата: 0 - успех         |
+----------+-----------+---------+----------------------------------+
|data.mode |1          |Number   |Режим обучения, допустимы значения|
|          |           |         |0, 1, 2. По умолчанию 1           |
+----------+-----------+---------+----------------------------------+