Перейти к основному содержимому

POST /recognize

Распознает фото, которые были загружены на портал с помощью /uploads или /uploads_by_url.

Изображения обрабатываются партиями — сценами. Для всех изображений в сцене составляется отчет. В одной сцене могут быть фотографии разных частей одной полки или фото нескольких полок одной товаркой категории.

Адрес: POST https://instance_name/api/v1.5/recognize/

Content-type: application/json

На заметку

На запросы к точке есть ограничение — 100 запросов в минуту.

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

images list of strings

Список идентификаторов изображений для обработки.

display string (ID)

Список идентификаторов /display/.

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

report_types list of strings

Список отчетов, которые будут сформированны после выполнения запроса.

visit string

Поле для включения изображений в ранее созданный визит.

Поле необязательно. Если не указано, то будет создан новый визит.

datetime string (date-time)

Дата и время визита. Поле необязательно к заполнению.

webhook string (url)

Вебхук для уменьшения задержки. Если заполнено, визиты будут отправлены по POST запросу на этот URL-адрес. Отправка выполняется сразу после формирования отчета (один за другим).

Это поле является необязательным. Если не заполнено, визиты нужно опрашивать вручную.

panorama_stack_height number

Высота панорамного изображения в сцене в пикселях.

panorama_stack_width number

Ширина панорамного изображения в сцене в пикселях.

counry_code string

Двухсимвольный код страны по стандарту ISO 3166 (A2). Указывает на то, из какой страны SKU на фотографии, например «RU», «KZ». Необязательный

retail_chain string

Указывает на то, к какой розничной сети принадлежит магазин.

metadata object (dictionary)

Словарь дополнительных параметров.

agent_id string

Идентификатор агента. Если агент с этим идентификатором существует и имя было изменено, то оно будет обновлено в карточке. Созданная сцена будет связана с этим агентом.

agent_name string

Имя агента. Используется для создания или обновления карточки агента.

Пример запроса

{
  "images": [156673, 156674, 156675, 156676], 
    "display": 13,
    "report_types": [
    "FACING_COUNT", 
    "PLANOGRAM_COMPLIANCE"
  ],
  "country_code": "RU",
  "metadata": {"agent_id": 23, "agent_name": "Paul McCartney"}
}

В ответе на успешный запрос, система выдает идентификаторы отчетов. Доступ к отчетам можно получить позднее, через /reports.

Пример ответа

Код ответа: 201 (CREATED)

{
  "id": 11234,
  "images": [156673, 156674, 156675, 156676],
  "display": 13,  
  "scene": "4d8b66992cd841f6922723afe9bd8cf8",
  "reports": {
    "FACING_COUNT": 1786,
    "PLANOGRAM_COMPLIANCE": 1789
   }
}

Если в запросе был указан вебхук, то после создания отчетов ему будет отправлен JSON с запросом POST.

{
  "id": 11234,
  "images": [156673, 156674, 156675, 156676],
  "display": 13,  
  "reports": {
    "1786": {...}, // JSON-текст отчета
    "1786": {...} // JSON-текст отчета
  }
}

Параметры ответа

id string (ID)

Идентификатор отчета.

images list of strings

Список идентификаторов изображений из запроса.

display integer

Список идентификаторов /display.

reports dictionary report type -> report ID.

Идентификаторы отчетов для сцены.

scene string

Uuid, идентификатор созданной сцены.