Snapshot - Apply

Serviço:

Azure AI Services

Versão da API:

1.0-preview

Envie uma operação para aplicar um instantâneo à assinatura atual. Para cada instantâneo, somente as assinaturas incluídas no applyScope of Snapshot – Take podem aplicá-lo.
As interfaces instantâneo são para os usuários fazer backup e restaurar seus dados faciais de uma assinatura facial para outra, dentro da mesma região ou entre regiões. O fluxo de trabalho contém duas fases, o usuário primeiro chama Snapshot – Take para criar uma cópia do objeto de origem e armazená-lo como um instantâneo e, em seguida, chama Snapshot – Aplicar para colar o instantâneo à assinatura de destino. Os instantâneos são armazenados em um local centralizado (por instância do Azure), para que possam ser aplicados entre contas e regiões.
Aplicar instantâneo é uma operação assíncrona. Uma ID de operação pode ser obtida do campo "Operation-Location" no cabeçalho de resposta, a ser usado em OperationStatus – Get para acompanhar o progresso da aplicação do instantâneo. A ID do objeto de destino será incluída no campo "resourceLocation" em OperationStatus – Obter resposta quando a operação status for "bem-sucedida".
O tempo de aplicação de instantâneo depende do número de entradas de pessoa e rosto no objeto instantâneo. Pode ser em segundos, ou até 1 hora para 1.000.000 pessoas com várias faces.
Os instantâneos expirarão e serão limpos automaticamente em 48 horas depois de serem criados pelo Snapshot – Take. Portanto, a assinatura de destino é necessária para aplicar o instantâneo em 48 horas desde sua criação.
A aplicação de um instantâneo não bloqueará nenhuma outra operação em relação ao objeto de destino, no entanto, não é recomendável porque a correção não pode ser garantida durante instantâneo aplicação. Depois que instantâneo a aplicação for concluída, todas as operações para o objeto de destino poderão funcionar normalmente. O instantâneo também inclui os resultados de treinamento do objeto de origem, o que significa que a assinatura de destino à qual o instantâneo aplicado não precisa treinar novamente o objeto de destino antes de chamar Identifi/FindSimilar.
Um instantâneo pode ser aplicado várias vezes em paralelo, enquanto atualmente há suporte apenas para CreateNew modo de aplicação, o que significa que a operação de aplicação falhará se a assinatura de destino já contiver um objeto do mesmo tipo e usando a mesma objectId. Os usuários podem especificar a "objectId" no corpo da solicitação para evitar esses conflitos.

• Cota de assinatura de camada gratuita: 100 operações de aplicação por mês.
• Cota de assinatura de nível S0: 100 operações de aplicação por dia.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus.api.cognitive.microsoft.com).
snapshotId	path	True	string uuid	ID que faz referência a uma instantâneo específica.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
objectId	True	string	ID de objeto de destino especificada pelo usuário a ser criada a partir do instantâneo.
mode		SnapshotApplyMode	Modo de aplicação de instantâneo. Atualmente, há suporte apenas para CreateNew, o que significa que a operação de aplicação falhará se a assinatura de destino já contiver um objeto do mesmo tipo e usando a mesma objectId. Os usuários podem especificar a "objectId" no corpo da solicitação para evitar esses conflitos.

Respostas

Nome	Tipo	Description
202 Accepted		O instantâneo tarefa de aplicação foi enfileirado com êxito. Cabeçalhos Operation-Location: string
Other Status Codes	APIError	Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Apply snapshot example

Solicitação de exemplo

HTTP

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


{
  "objectId": "target-face-list-id",
  "mode": "CreateNew"
}

Resposta de exemplo

Código de status:

202

Definições

Nome	Description
APIError	Informações de erro retornadas pela API
ApplySnapshotRequest	Corpo da solicitação para aplicar instantâneo operação.
Error	Corpo do erro.
SnapshotApplyMode	Modo de aplicação de instantâneo. Atualmente, há suporte apenas para CreateNew, o que significa que a operação de aplicação falhará se a assinatura de destino já contiver um objeto do mesmo tipo e usando a mesma objectId. Os usuários podem especificar a "objectId" no corpo da solicitação para evitar esses conflitos.

APIError

Informações de erro retornadas pela API

Nome	Tipo	Description
error	Error	Corpo do erro.

ApplySnapshotRequest

Corpo da solicitação para aplicar instantâneo operação.

Nome	Tipo	Valor padrão	Description
mode	SnapshotApplyMode	CreateNew	Modo de aplicação de instantâneo. Atualmente, há suporte apenas para CreateNew, o que significa que a operação de aplicação falhará se a assinatura de destino já contiver um objeto do mesmo tipo e usando a mesma objectId. Os usuários podem especificar a "objectId" no corpo da solicitação para evitar esses conflitos.
objectId	string		ID de objeto de destino especificada pelo usuário a ser criada a partir do instantâneo.

Error

Corpo do erro.

Nome	Tipo	Description
code	string
message	string

SnapshotApplyMode

Modo de aplicação de instantâneo. Atualmente, há suporte apenas para CreateNew, o que significa que a operação de aplicação falhará se a assinatura de destino já contiver um objeto do mesmo tipo e usando a mesma objectId. Os usuários podem especificar a "objectId" no corpo da solicitação para evitar esses conflitos.

Nome	Tipo	Description
CreateNew	string