Face - Find Similar

Ссылка

Service:: Cognitive Services - Face

API Version:: 1.0

FaceId лица заданного запроса, поиск похожих лиц из массива faceId, списка лиц или большого списка лиц. Массив faceId содержит лица, созданные лицом — Detect With Url или Face — Detect With Stream, который истекает во время, указанное faceIdTimeToLive после создания. FaceListId создается с помощью FaceList — создание , содержащее сохраненныеfaceIds, срок действия которых не истекает. Кроме того, параметр largeFaceListId создается с помощью LargeFaceList — создание сохраняемых идентификаторовFaceId, срок действия которых также не истекает. В зависимости от входных данных возвращаемый список похожих лиц содержит faceId или persistedFaceIds, ранжированные по подобию.
Найдите похожие два режима работы: matchPerson и matchFace. MatchPerson — это режим по умолчанию, в котором он пытается найти лица одного и того же человека, используя внутренние пороговые значения одного и того же человека. Полезно найти другие фотографии известного человека. Обратите внимание, что пустой список будет возвращен, если лица не проходят внутренние пороговые значения. Режим matchFace игнорирует пороговые значения одного и того же человека и возвращает ранжированные похожие лица в любом случае, даже сходства низкая. Его можно использовать в таких случаях, как поиск знаменитостей глядя лица.
Идентификатор распознавания лица, связанный с faceId запроса, должен совпадать с идентификатором распознавания, используемым целевым массивом faceId, списком лиц или большим списком лиц.

POST {Endpoint}/face/v1.0/findsimilars

Параметры URI

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

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

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

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

Name	Required	Type	Description
faceId	True	string	FaceId лица запроса. Пользователю необходимо вызвать face — сначала определить, чтобы получить допустимый faceId. Обратите внимание, что этот faceId не сохраняется и истекает в момент, указанного faceIdTimeToLive после вызова обнаружения.
faceIds		string[]	Массив потенциальных идентификаторов лиц. Все они создаются с помощью face - Detect и faceIds истекает в то время, указанное faceIdTimeToLive после вызова обнаружения. Количество faceId ограничено 1000. Параметр faceListId, largeFaceListId и faceIds не должны предоставляться одновременно.
faceListId		string	Существующий список уникальных лиц, указанный пользователем, созданный в списке лиц — создание списка лиц. Список лиц содержит набор сохраненных интерфейсовFaceId, которые сохраняются и никогда не истекают. Параметр faceListId, largeFaceListId и faceIds не должны предоставляться одновременно.
largeFaceListId		string	Существующий пользовательский уникальный список лиц большого размера, созданный в LargeFaceList — create. Большой список лиц содержит набор сохраненныхfaceIds, которые сохраняются и никогда не истекают. Параметр faceListId, largeFaceListId и faceIds не должны предоставляться одновременно.
maxNumOfCandidatesReturned		integer	Число возвращенных первых похожих лиц. Допустимый диапазон — [1, 1000].
mode		FindSimilarMatchMode	Аналогичный режим поиска лиц. Это может быть matchPerson или matchFace.

Ответы

Name	Type	Description
200 OK	SimilarFace[]	Успешный вызов возвращает массив наиболее похожих лиц, представленных в faceId, если входной параметр является faceIds или persistedFaceId, если входной параметр является faceListId.
Other Status Codes	APIError	Ответ об ошибке.

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

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Примеры

Find similar results example

Sample Request

HTTP

POST {Endpoint}/face/v1.0/findsimilars


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

Sample Response

Status code:: 200

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

Определения

APIError	Сведения об ошибке, возвращаемые API
Error	Текст ошибки.
FindSimilarMatchMode	Аналогичный режим поиска лиц. Это может быть matchPerson или matchFace.
FindSimilarRequest	Текст запроса для поиска аналогичной операции.
SimilarFace	Текст ответа для поиска аналогичной операции распознавания лиц.

APIError

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

Name	Type	Description
error	Error	Текст ошибки.

Error

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

Name	Type	Description
code	string
message	string

FindSimilarMatchMode

Аналогичный режим поиска лиц. Это может быть matchPerson или matchFace.

Name	Type	Description
matchFace	string
matchPerson	string

FindSimilarRequest

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

Name	Type	Default Value	Description
faceId	string		FaceId лица запроса. Пользователю необходимо вызвать face — сначала определить, чтобы получить допустимый faceId. Обратите внимание, что этот faceId не сохраняется и истекает в момент, указанного faceIdTimeToLive после вызова обнаружения.
faceIds	string[]		Массив потенциальных идентификаторов лиц. Все они создаются с помощью face - Detect и faceIds истекает в то время, указанное faceIdTimeToLive после вызова обнаружения. Количество faceId ограничено 1000. Параметр faceListId, largeFaceListId и faceIds не должны предоставляться одновременно.
faceListId	string		Существующий список уникальных лиц, указанный пользователем, созданный в списке лиц — создание списка лиц. Список лиц содержит набор сохраненных интерфейсовFaceId, которые сохраняются и никогда не истекают. Параметр faceListId, largeFaceListId и faceIds не должны предоставляться одновременно.
largeFaceListId	string		Существующий пользовательский уникальный список лиц большого размера, созданный в LargeFaceList — create. Большой список лиц содержит набор сохраненныхfaceIds, которые сохраняются и никогда не истекают. Параметр faceListId, largeFaceListId и faceIds не должны предоставляться одновременно.
maxNumOfCandidatesReturned	integer	20	Число возвращенных первых похожих лиц. Допустимый диапазон — [1, 1000].
mode	FindSimilarMatchMode	matchPerson	Аналогичный режим поиска лиц. Это может быть matchPerson или matchFace.

SimilarFace

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

Name	Type	Description
confidence	number	Достоверность подобия лица кандидата. Чем выше достоверность, тем более похожа. Диапазон между [0,1].
faceId	string	FaceId лица кандидата при поиске по faceIds. faceId создается лицом — обнаружение и истечение срока действия, указанного faceIdTimeToLive после вызова обнаружения
persistedFaceId	string	PersistedFaceId лица кандидата при поиске по faceListId. persistedFaceId в списке лиц сохраняется и не истекает. Как показано в приведенном ниже ответе