Face Recognition Operations - Find Similar From Large Face List

Служба:

Azure AI Services

Версия API:

v1.1-preview.1

С учетом faceId запроса для поиска похожих лиц из большого списка лиц. LargeFaceListId создается Create большим списком лиц.
В зависимости от входных данных возвращенный список похожих лиц содержит faceIds или persistedFaceIds, ранжированные по подобию.

Функция Найти аналогичная имеет два режима работы: matchPerson и matchFace. MatchPerson — это режим по умолчанию, в котором он пытается найти лица одного и того же человека, как это возможно, с помощью внутренних пороговых значений одного и того же человека. Полезно найти другие фотографии известного человека. Обратите внимание, что пустой список возвращается, если ни один из лиц не проходит внутренние пороговые значения. Режим matchFace игнорирует пороговые значения для одного человека и в любом случае возвращает похожие лица, даже если сходство низкое. Его можно использовать в таких случаях, как поиск лиц знаменитостей.

"recognitionModel", связанный с запросом faceId, должен совпадать с "recognitionModel", используемым целевым крупным списком лиц.

POST {endpoint}/face/{apiVersion}/findsimilars

Параметры URI

Имя	В	Обязательно	Тип	Описание
apiVersion	path	True	string	Версия API
endpoint	path	True	string uri	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://{имя_ресурса}.cognitiveservices.azure.com).

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

Имя	Обязательно	Тип	Описание
faceId	True	string	faceId лица запроса. Пользователь должен сначала вызвать "Detect", чтобы получить допустимый faceId. Обратите внимание, что этот идентификатор faceId не сохраняется и истекает через 24 часа после вызова обнаружения.
largeFaceListId	True	string	Существующий определяемые пользователем уникальные потенциальные крупные списки лиц, созданные в Create большой список лиц. Большой список лиц содержит набор persistedFaceId, которые сохраняются и не истечет.
maxNumOfCandidatesReturned		integer	Количество возвращенных лиц, похожих на верхние. Допустимый диапазон — [1, 1000]. Значение по умолчанию — 20.
mode		FindSimilarMatchMode	Похожий режим поиска лиц. Это может быть matchPerson или matchFace. Значение по умолчанию — matchPerson.

Ответы

Имя	Тип	Описание
200 OK	FindSimilarResult[]	Успешный вызов возвращает массив наиболее похожих лиц, представленных в faceId, если входной параметр — faceIds или persistedFaceId, если входной параметр — faceListId или largeFaceListId.
Other Status Codes	FaceErrorResponse	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

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

Ocp-Apim-Subscription-Key

Секретный ключ для подписки Azure AI Face.

Тип: apiKey
В: header

AADToken

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://api.example.com/oauth2/authorize
URL-адрес токена: https://api.example.com/oauth2/token

Области

Имя	Описание
https://cognitiveservices.azure.com/.default

Примеры

Find Similar from LargeFaceList

Образец запроса

HTTP

POST {endpoint}/face/v1.1-preview.1/findsimilars

{
  "faceId": "c5c24a82-6845-4031-9d5d-978df9175426",
  "maxNumOfCandidatesReturned": 3,
  "mode": "matchPerson",
  "largeFaceListId": "your_large_face_list_id"
}

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

Код состояния:

200

[
  {
    "confidence": 0.8,
    "faceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9"
  }
]

Определения

Имя	Описание
FaceError	Объект error. Подробные сведения о кодах ошибок и сообщениях, возвращаемых службой распознавания лиц, см. по следующей ссылке: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Ответ, содержащий сведения об ошибке.
FindSimilarResult	Текст ответа для операции поиска аналогичного лица.

FaceError

Объект error. Подробные сведения о кодах ошибок и сообщениях, возвращаемых службой распознавания лиц, см. по следующей ссылке: https://aka.ms/face-error-codes-and-messages.

Имя	Тип	Описание
code	string	Один из определяемого сервером набора кодов ошибок.
message	string	Удобочитаемое представление ошибки.

FaceErrorResponse

Ответ, содержащий сведения об ошибке.

Имя	Тип	Описание
error	FaceError	Объект error.

FindSimilarResult

Текст ответа для операции поиска аналогичного лица.

Имя	Тип	Описание
confidence	number	Значение достоверности кандидата. Чем выше достоверность, тем более похожим. Диапазон между [0,1].
faceId	string	FaceId лица кандидата при поиске по faceIds. FaceId создается методом Detect и истечет через 24 часа после вызова обнаружения.
persistedFaceId	string	persistedFaceId потенциального лица при поиске по faceListId или largeFaceListId. persistedFaceId в списке лиц/большой список лиц сохраняется и не истечет.