Large Face List - Get Face

Service:

Cognitive Services - Face

API Version:

1.0

Получение сведений о сохраняемом лице (указывается с помощью persistedFaceId и его принадлежности largeFaceListId).

GET {Endpoint}/face/v1.0/largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}

Параметры 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-_]+$
persistedFaceId	path	True	string uuid	Идентификатор, ссылающийся на конкретный сохраненныйFaceId существующего лица.

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

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

Ответы

Name	Type	Description
200 OK	PersistedFace	Успешный вызов возвращает сведения о сохраняемом лице целевого объекта (persistedFaceId и userData).
Other Status Codes	APIError	Ответ об ошибке.

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

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Примеры

Get persisted face example

Sample Request

HTTP

GET {Endpoint}/face/v1.0/largefacelists/abc/persistedfaces/015839fb-fbd9-4f79-ace9-7675fc2f1dd9

Sample Response

Status code:

200

{
  "persistedFaceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9",
  "userData": "User-provided data attached to the face."
}

Определения

APIError	Сведения об ошибке, возвращаемые API
Error	Текст ошибки.
PersistedFace	Объект PersonFace.

APIError

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

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

Error

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

Name	Type	Description
code	string
message	string

PersistedFace

Объект PersonFace.

Name	Type	Description
persistedFaceId	string	СохраненныйFaceId целевого лица, который сохраняется и не истекает. Отличается от faceId, созданного лицом — обнаружение и истечение срока действия истекает во время, указанное faceIdTimeToLive после вызова обнаружения.
userData	string	Предоставленные пользователем данные, подключенные к лицу. Максимальный размер составляет 1 КБ.