Snapshot - Apply
Envíe una operación para aplicar una instantánea a la suscripción actual. Para cada instantánea, solo las suscripciones incluidas en applyScope of Snapshot - Take pueden aplicarla.
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.
La aplicación de instantáneas 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 aplicación de la instantánea. El identificador de objeto de destino se incluirá en el campo "resourceLocation" de OperationStatus : obtener respuesta cuando el estado de la operación sea "correcto".
El tiempo de aplicación de instantánea depende del número de entradas de persona y cara en el objeto de instantánea. Podría estar en segundos o hasta 1 hora 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. Por lo tanto, la suscripción de destino es necesaria para aplicar la instantánea en 48 horas desde su creación.
La aplicación de una instantánea no bloqueará ninguna otra operación en el objeto de destino, pero no se recomienda porque no se puede garantizar la corrección durante la aplicación de instantáneas. Una vez completada la aplicación de instantáneas, todas las operaciones hacia el objeto de destino pueden funcionar de la forma normal. La instantánea también incluye 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.
Se puede aplicar una instantánea varias veces en paralelo, mientras que actualmente solo se admite el modo CreateNew apply, lo que significa que se producirá un error en la operación de aplicación si la suscripción de destino ya contiene un objeto de mismo tipo y usa el mismo objectId. Los usuarios pueden especificar el "objectId" en el cuerpo de la solicitud para evitar estos conflictos.
- Cuota de suscripción de nivel gratuito: 100 aplican operaciones al mes.
- Cuota de suscripción de nivel S0: 100 aplican operaciones al día.
POST {Endpoint}/face/v1.0/snapshots/{snapshotId}/apply
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). |
snapshot
|
path | True |
string uuid |
Identificador que hace referencia a una instantánea determinada. |
Encabezado de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Cuerpo de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
objectId | True |
string |
Identificador de objeto de destino especificado por el usuario que se va a crear a partir de la instantánea. |
mode |
Modo de aplicación de instantáneas. Actualmente solo se admite CreateNew, lo que significa que se producirá un error en la operación de aplicación si la suscripción de destino ya contiene un objeto de mismo tipo y usa el mismo objectId. Los usuarios pueden especificar el "objectId" en el cuerpo de la solicitud para evitar estos conflictos. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
202 Accepted |
La tarea de aplicación de instantáneas se puso en cola correctamente. Encabezados Operation-Location: string |
|
Other Status Codes |
Respuesta de error. |
Seguridad
Ocp-Apim-Subscription-Key
Tipo:
apiKey
En:
header
Ejemplos
Apply snapshot example
Solicitud de ejemplo
POST {Endpoint}/face/v1.0/snapshots/e58b3f08-1e8b-4165-81df-aa9858f233dc/apply
{
"objectId": "target-face-list-id",
"mode": "CreateNew"
}
Respuesta de muestra
Definiciones
Nombre | Description |
---|---|
APIError |
Información de error devuelta por la API |
Apply |
Cuerpo de la solicitud para aplicar la operación de instantánea. |
Error |
Cuerpo del error. |
Snapshot |
Modo de aplicación de instantáneas. Actualmente solo se admite CreateNew, lo que significa que se producirá un error en la operación de aplicación si la suscripción de destino ya contiene un objeto de mismo tipo y usa el mismo objectId. Los usuarios pueden especificar el "objectId" en el cuerpo de la solicitud para evitar estos conflictos. |
APIError
Información de error devuelta por la API
Nombre | Tipo | Description |
---|---|---|
error |
Cuerpo del error. |
ApplySnapshotRequest
Cuerpo de la solicitud para aplicar la operación de instantánea.
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
mode | CreateNew |
Modo de aplicación de instantáneas. Actualmente solo se admite CreateNew, lo que significa que se producirá un error en la operación de aplicación si la suscripción de destino ya contiene un objeto de mismo tipo y usa el mismo objectId. Los usuarios pueden especificar el "objectId" en el cuerpo de la solicitud para evitar estos conflictos. |
|
objectId |
string |
Identificador de objeto de destino especificado por el usuario que se va a crear a partir de la instantánea. |
Error
Cuerpo del error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
|
message |
string |
SnapshotApplyMode
Modo de aplicación de instantáneas. Actualmente solo se admite CreateNew, lo que significa que se producirá un error en la operación de aplicación si la suscripción de destino ya contiene un objeto de mismo tipo y usa el mismo objectId. Los usuarios pueden especificar el "objectId" en el cuerpo de la solicitud para evitar estos conflictos.
Nombre | Tipo | Description |
---|---|---|
CreateNew |
string |