Snapshot - Take

Servicio:

Azure AI Services

Versión de la API:

1.0

Envíe una operación para tomar una instantánea de la lista de caras, la lista de caras grandes, el grupo de personas o el grupo de personas grandes, con el tipo de instantánea especificado por el usuario, el identificador de objeto de origen, aplicar el ámbito y los datos de usuario opcionales.
Las interfaces de instantáneas son para que los usuarios realicen copias de seguridad y restauren sus datos faciales de una suscripción de cara a otra, dentro de la misma región o entre regiones. El flujo de trabajo contiene dos fases, el usuario llama primero a Snapshot - Take para crear una copia del objeto de origen y almacenarlo como una instantánea y, a continuación, llama a Snapshot - Apply para pegar la instantánea en la suscripción de destino. Las instantáneas se almacenan en una ubicación centralizada (por instancia de Azure), para que se puedan aplicar entre cuentas y regiones.
Tomar instantánea es una operación asincrónica. Se puede obtener un identificador de operación del campo "Operation-Location" en el encabezado de respuesta, que se usará en OperationStatus - Get para realizar el seguimiento del progreso de la creación de la instantánea. El identificador de instantánea se incluirá en el campo "resourceLocation" de OperationStatus - Get response when the operation status is "succeeded".
El tiempo de toma de instantáneas depende del número de entradas de persona y cara en el objeto de origen. Podría estar en segundos o hasta varias horas para 1.000.000 personas con varias caras.
Las instantáneas expirarán y se limpiarán automáticamente en 48 horas después de que se cree mediante Snapshot - Take. El usuario puede eliminar la instantánea mediante Snapshot - Delete por sí mismo en cualquier momento antes de la expiración.
Tomar instantáneas para un determinado objeto no bloqueará ninguna otra operación en el objeto . Todas las operaciones de solo lectura (Get/List e Identify/FindSimilar/Verify) se pueden realizar como de costumbre. Para todas las operaciones grabables, incluidas Add/Update/Delete el objeto de origen o sus personas/caras y Train, no se bloquean, pero no se recomiendan porque es posible que las actualizaciones grabables no se reflejen en la instantánea durante su toma. Una vez completada la toma de instantáneas, todas las operaciones legibles y grabables pueden funcionar de la forma normal. La instantánea también incluirá los resultados de entrenamiento del objeto de origen, lo que significa que la suscripción de destino a la que se aplica la instantánea no necesita volver a entrenar el objeto de destino antes de llamar a Identify/FindSimilar.

• Cuota de suscripción de nivel gratuito: 100 realizan operaciones al mes.
• Cuota de suscripción de nivel S0: 100 realizan operaciones al día.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://westus.api.cognitive.microsoft.com).

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
applyScope	True	string[]	Matriz especificada por el usuario de identificadores de suscripción de Face de destino para la instantánea. Para cada instantánea, solo las suscripciones incluidas en applyScope of Snapshot - Take pueden aplicarla.
objectId	True	string	Identificador de objeto de origen especificado por el usuario para tomar instantáneas.
type	True	SnapshotObjectType	Tipo especificado por el usuario del objeto de origen del que se va a tomar la instantánea. Actualmente se admiten FaceList, PersonGroup, LargeFaceList y LargePersonGroup.
userData		string	Los datos especificados por el usuario sobre la instantánea para cualquier propósito. La longitud no debe superar los 16 KB.

Respuestas

Nombre	Tipo	Description
202 Accepted		La tarea de toma de instantáneas se puso en cola correctamente. Encabezados Operation-Location: string
Other Status Codes	APIError	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

Take a snapshot example

Solicitud de ejemplo

HTTP

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


{
  "type": "FaceList",
  "objectId": "source-face-list-id",
  "applyScope": [
    "35230F59-AA9C-45E0-AB5E-C859BF1A5429",
    "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB"
  ],
  "userData": "User-provided data attached to the snapshot."
}

Respuesta de muestra

status code:

202

Definiciones

Nombre	Description
APIError	Información de error devuelta por la API
Error	Cuerpo del error.
SnapshotObjectType	Tipo del objeto de origen en la instantánea, especificado por el suscriptor que creó la instantánea al llamar a Snapshot - Take. Actualmente se admiten FaceList, PersonGroup, LargeFaceList y LargePersonGroup.
TakeSnapshotRequest	Cuerpo de la solicitud para realizar la operación de instantánea.

APIError

Información de error devuelta por la API

Nombre	Tipo	Description
error	Error	Cuerpo del error.

Error

Cuerpo del error.

Nombre	Tipo	Description
code	string
message	string

SnapshotObjectType

Tipo del objeto de origen en la instantánea, especificado por el suscriptor que creó la instantánea al llamar a Snapshot - Take. Actualmente se admiten FaceList, PersonGroup, LargeFaceList y LargePersonGroup.

Nombre	Tipo	Description
FaceList	string
LargeFaceList	string
LargePersonGroup	string
PersonGroup	string

TakeSnapshotRequest

Cuerpo de la solicitud para realizar la operación de instantánea.

Nombre	Tipo	Description
applyScope	string[]	Matriz especificada por el usuario de identificadores de suscripción de Face de destino para la instantánea. Para cada instantánea, solo las suscripciones incluidas en applyScope of Snapshot - Take pueden aplicarla.
objectId	string	Identificador de objeto de origen especificado por el usuario para tomar instantáneas.
type	SnapshotObjectType	Tipo especificado por el usuario del objeto de origen del que se va a tomar la instantánea. Actualmente se admiten FaceList, PersonGroup, LargeFaceList y LargePersonGroup.
userData	string	Los datos especificados por el usuario sobre la instantánea para cualquier propósito. La longitud no debe superar los 16 KB.