Snapshot - Update

Ссылка

Служба:: Azure AI Services

Версия API:: 1.0-preview

Обновление сведений о snapshot. Обновить snapshot может только исходная подписка, которая приняла snapshot.

PATCH {Endpoint}/face/v1.0-preview/snapshots/{snapshotId}

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например). https://westus.api.cognitive.microsoft.com
snapshotId	path	True	string uuid	Идентификатор, ссылающийся на конкретный snapshot.

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

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string

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

Имя	Тип	Описание
applyScope	string[]	Массив идентификаторов целевой подписки распознавания лиц для snapshot, указанный пользователем, создавшим snapshot при вызове Snapshot — Take. Для каждой snapshot могут применяться только подписки, включенные в applyScope of Snapshot — Take.
userData	string	Указанные пользователем данные о snapshot для любой цели. Длина не должна превышать 16 КБ.

Ответы

Имя	Тип	Описание
200 OK		Успешный вызов возвращает пустой текст ответа.
Other Status Codes	APIError	Ответ об ошибке.

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

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

Update snapshot example

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

HTTP

PATCH {Endpoint}/face/v1.0-preview/snapshots/e58b3f08-1e8b-4165-81df-aa9858f233dc


{
  "applyScope": [
    "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB"
  ],
  "userData": "User-provided data attached to the snapshot."
}

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

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

Определения

Имя	Описание
APIError	Сведения об ошибке, возвращаемые API
Error	Текст ошибки.
UpdateSnapshotRequest	Текст запроса на обновление snapshot с сочетанием определяемых пользователем область применения и данных, указанных пользователем.

APIError

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

Имя	Тип	Описание
error	Error	Текст ошибки.

Error

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

Имя	Тип	Описание
code	string
message	string

UpdateSnapshotRequest

Текст запроса на обновление snapshot с сочетанием определяемых пользователем область применения и данных, указанных пользователем.

Имя	Тип	Описание
applyScope	string[]	Массив идентификаторов целевой подписки распознавания лиц для snapshot, указанный пользователем, создавшим snapshot при вызове Snapshot — Take. Для каждой snapshot могут применяться только подписки, включенные в applyScope of Snapshot — Take.
userData	string	Указанные пользователем данные о snapshot для любой цели. Длина не должна превышать 16 КБ.

Поделиться через