Large Face List - Add Face From Url

  • Ссылка
Service:
Cognitive Services - Face
API Version:
1.0

Добавление лица в указанный большой список лиц, до 1 000 000 лиц.
Чтобы справиться с изображением, содержит несколько лиц, входное лицо можно указать как изображение с прямоугольником targetFace. Он возвращает сохраненныйfaceId, представляющий добавленное лицо. Изображение не будет сохранено. Только извлеченная функция распознавания лиц будет храниться на сервере, пока не будет вызван метод LargeFaceList Face — Delete или LargeFaceList.
Примечание persistedFaceId отличается от faceId, созданного faceId — Detect.

  • Более высокое качество изображения лица означает лучшую точность распознавания. Рассмотрим высококачественные лица: передние, четкие и размер лица составляет 200x200 пикселей (100 пикселей между глазами) или больше.
  • Поддерживаются формат JPEG, PNG, GIF (первый кадр) и BMP. Допустимый размер файла изображения составляет от 1 КБ до 6 МБ.
  • Прямоугольник targetFace должен содержать одно лицо. Ноль или несколько лиц будут рассматриваться как ошибка. Если предоставленный прямоугольник targetFace не возвращается из Face — Detect, нет никакой гарантии успешного обнаружения и добавления лица.
  • Из-за обнаруживаемого размера лица (36x36 – 4096 x 4096 пикселей), большого размера головы или больших окклюзий произойдет сбой.
  • Добавление и удаление лиц в один и тот же список лиц обрабатываются последовательно и из разных списков лиц параллельно.
  • Минимальный размер распознаваемого лица составляет 36 x 36 пикселей на изображении, не превышающем 1920 x 1080 пикселей. Изображения с измерениями, превышающими 1920 x 1080 пикселей, потребуются пропорциональные минимальные размеры лиц.
  • Можно указать различные значения detectionModel. Сведения об использовании и сравнении различных моделей обнаружения см. в разделе "Как указать модель обнаружения"

Quota:

  • Квота подписки на бесплатный уровень: 1000 лиц на большой список лиц.
  • Квота подписки уровня S0: 1000 000 лиц на большой список лиц.
POST {Endpoint}/face/v1.0/largefacelists/{largeFaceListId}/persistedfaces
With optional parameters: 
POST {Endpoint}/face/v1.0/largefacelists/{largeFaceListId}/persistedfaces?userData={userData}&targetFace={targetFace}&detectionModel={detectionModel}

Параметры URI

Name In Required Type Description
Endpoint
 path True
  • string

Поддерживаемые конечные точки Cognitive Services (например, https://westus.api.cognitive.microsoft.comпротокол и имя узла).
largeFaceListId
 path True
  • string

Идентификатор, ссылающийся на определенный большой список лиц.

Regex pattern: ^[a-z0-9-_]+$
detectionModel
 query

Имя модели обнаружения. Модель обнаружения используется для обнаружения лиц на отправленном изображении. Имя модели обнаружения можно указать при выполнении face — Detect or (Large)FaceList — Add FaceGroup or (Large)PersonGroup — Add Face ( Add Face). Значение по умолчанию — "detection_01", если требуется другая модель, явно укажите ее.
targetFace
 query
  • array

Прямоугольник лица, указывающий целевое лицо, добавляемое пользователю в формате targetFace=left, top,width, height. Например, targetFace=10,10,100,100,100. Если на изображении несколько лиц, targetFace требуется, чтобы указать, какое лицо нужно добавить. Целевой интерфейс не означает, что на всем изображении обнаружено только одно лицо.
userData
 query
  • string

Указанные пользователем данные о лице для любых целей. Максимальная длина составляет 1 КБ.

Заголовок запроса

Name Required Type Description
Ocp-Apim-Subscription-Key True
  • string

Текст запроса

Name Required Type Description
url True
  • string

Общедоступный URL-адрес изображения

Ответы

Name Type Description
200 OK

Успешный вызов возвращает новый persistedFaceId.
Other Status Codes

Ответ об ошибке.

Безопасность

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Примеры

Create large face list face example

Sample Request

POST {Endpoint}/face/v1.0/largefacelists/sample_face_list/persistedfaces?userData={Customized user data}&targetFace=10,10,100,100&detectionModel=detection_01


{
  "url": "{Image Url here}"
}

Sample Response

Status code:
200 
{
  "persistedFaceId": "B8D802CF-DD8F-4E61-B15C-9E6C5844CCBA"
}

Определения

APIError

Сведения об ошибке, возвращаемые API
DetectionModel

Имя модели обнаружения. Модель обнаружения используется для обнаружения лиц на отправленном изображении. Имя модели обнаружения можно указать при выполнении face — Detect or (Large)FaceList — Add FaceGroup or (Large)PersonGroup — Add Face ( Add Face). Значение по умолчанию — "detection_01", если требуется другая модель, явно укажите ее.
Error

Текст ошибки.
ImageUrl
PersistedFace

Объект PersonFace.

APIError

Сведения об ошибке, возвращаемые API

Name Type Description
error

Текст ошибки.

DetectionModel

Имя модели обнаружения. Модель обнаружения используется для обнаружения лиц на отправленном изображении. Имя модели обнаружения можно указать при выполнении face — Detect or (Large)FaceList — Add FaceGroup or (Large)PersonGroup — Add Face ( Add Face). Значение по умолчанию — "detection_01", если требуется другая модель, явно укажите ее.

Name Type Description
detection_01
  • string
detection_02
  • string
detection_03
  • string

Error

Текст ошибки.

Name Type Description
code
  • string
message
  • string

ImageUrl

Name Type Description
url
  • string

Общедоступный URL-адрес изображения

PersistedFace

Объект PersonFace.

Name Type Description
persistedFaceId
  • string

СохраненныйFaceId целевого лица, который сохраняется и не истекает. Отличается от faceId, созданного лицом — обнаружение и истечение срока действия истекает во время, указанное faceIdTimeToLive после вызова обнаружения.
userData
  • string

Предоставленные пользователем данные, подключенные к лицу. Максимальный размер составляет 1 КБ.