Face List - Get

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

Получение faceListId списка лиц, имени, userData, recognitionModel и лиц в списке лиц.

GET {Endpoint}/face/v1.0/facelists/{faceListId}
With optional parameters: 
GET {Endpoint}/face/v1.0/facelists/{faceListId}?returnRecognitionModel={returnRecognitionModel}

Параметры URI

Name In Required Type Description
Endpoint
 path True
  • string

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

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

Regex pattern: ^[a-z0-9-_]+$
returnRecognitionModel
 query
  • boolean

Значение, указывающее, должна ли операция возвращать "recognitionModel" в ответ.

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

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

Ответы

Name Type Description
200 OK

Успешный вызов возвращает сведения о списке лиц.
Other Status Codes

Ответ на ошибку.

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

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Примеры

Get Face list example

Sample Request

GET {Endpoint}/face/v1.0/facelists/sample_face_list?returnRecognitionModel=True

Sample Response

Status code:
200 
{
  "faceListId": "sample_list",
  "name": "list1",
  "userData": "User-provided data attached to the face list.",
  "recognitionModel": "recognition_01",
  "persistedFaces": [
    {
      "persistedFaceId": "B8D802CF-DD8F-4E61-B15C-9E6C5844CCBD",
      "userData": "User-provided data attached to the face."
    }
  ]
}

Определения

APIError

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

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

Объект списка лиц.
PersistedFace

Объект PersonFace.
RecognitionModel

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

APIError

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

Name Type Description
error

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

Error

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

Name Type Description
code
  • string
message
  • string

FaceList

Объект списка лиц.

Name Type Default Value Description
faceListId
  • string

FaceListId целевого списка лиц.
name
  • string

Определяемое пользователем имя, максимальная длина — 128.
persistedFaces

Сохраненные лица в списке лиц.
recognitionModel recognition_01

Имя модели распознавания. Модель распознавания используется, когда признаки лица извлекаются и связаны с обнаруженными идентификаторами faceId, (Large)FaceList или (Large)PersonGroup. Имя модели распознавания можно указать при выполнении face — Detect или (Large)FaceList — Create или (Large)PersonGroup — Create. Значение по умолчанию — "recognition_01", если требуется последняя модель, укажите нужную модель явным образом.
userData
  • string

Указанные пользователем данные. Длина не должна превышать 16 КБ.

PersistedFace

Объект PersonFace.

Name Type Description
persistedFaceId
  • string

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

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

RecognitionModel

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

Name Type Description
recognition_01
  • string
recognition_02
  • string
recognition_03
  • string
recognition_04
  • string