Snapshot - Apply

Serviço:

Azure AI Services

Versão da API:

1.0-preview

Submeta uma operação para aplicar um instantâneo à subscrição atual. Para cada instantâneo, apenas as subscrições incluídas no applyScope of Snapshot - Take podem aplicá-lo.
As interfaces de instantâneo destinam-se a que os utilizadores criem cópias de segurança e restaurem os respetivos dados faciais de uma subscrição face para outra, dentro da mesma região ou entre regiões. O fluxo de trabalho contém duas fases, o utilizador chama primeiro Snapshot - Take para criar uma cópia do objeto de origem e armazená-lo como um instantâneo e, em seguida, chama Instantâneo - Aplicar para colar o instantâneo na subscrição de destino. Os instantâneos são armazenados numa localização centralizada (por instância do Azure), para que possam ser aplicados entre contas e regiões.
A aplicação de instantâneo é uma operação assíncrona. Um ID de operação pode ser obtido a partir do campo "Operation-Location" no cabeçalho de resposta, a ser utilizado em OperationStatus – Obter para controlar o progresso da aplicação do instantâneo. O ID do objeto de destino será incluído no campo "resourceLocation" em OperationStatus – Obter resposta quando o estado da operação for "bem-sucedido".
O instantâneo que aplica o tempo depende do número de entradas de pessoa e rosto no objeto de instantâneo. Pode ser em segundos, ou até 1 hora para 1.000.000 pessoas com múltiplos rostos.
Os instantâneos serão automaticamente expirados e limpos 48 horas depois de serem criados pelo Instantâneo – Take. Assim, a subscrição de destino é necessária para aplicar o instantâneo em 48 horas desde a sua criação.
A aplicação de um instantâneo não bloqueará quaisquer outras operações no objeto de destino. No entanto, não é recomendado porque não é possível garantir a correção durante a aplicação do instantâneo. Após a conclusão da aplicação de instantâneos, todas as operações para o objeto de destino podem funcionar normalmente. O instantâneo também inclui os resultados de preparação do objeto de origem, o que significa que a subscrição de destino à qual o instantâneo aplicado não precisa de voltar a preparar o objeto de destino antes de chamar Identifi/FindSimilar.
Um instantâneo pode ser aplicado várias vezes em paralelo, enquanto atualmente só é suportado CriarNovo modo de aplicação, o que significa que a operação aplicar falhará se a subscrição de destino já contiver um objeto do mesmo tipo e utilizar o mesmo objectId. Os utilizadores podem especificar o "objectId" no corpo do pedido para evitar tais conflitos.

• Quota de subscrição de escalão gratuito: 100 aplicam operações por mês.
• Quota de subscrição de escalão S0: 100 aplicam operações por dia.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://westus.api.cognitive.microsoft.com).
snapshotId	path	True	string uuid	ID referente a um instantâneo específico.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo do Pedido

Name	Necessário	Tipo	Description
objectId	True	string	O utilizador especificou o ID do objeto de destino a criar a partir do instantâneo.
mode		SnapshotApplyMode	Modo de aplicação de instantâneos. Atualmente, apenas a opção CreateNew é suportada, o que significa que a operação aplicar falhará se a subscrição de destino já contiver um objeto do mesmo tipo e utilizar o mesmo objectId. Os utilizadores podem especificar o "objectId" no corpo do pedido para evitar tais conflitos.

Respostas

Name	Tipo	Description
202 Accepted		O instantâneo que aplica a tarefa foi em fila 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

Pedido de amostra

HTTP

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


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

Resposta da amostra

Código de estado:

202

Definições

Name	Description
APIError	Informações de erro devolvidas pela API
ApplySnapshotRequest	Corpo do pedido para aplicar a operação de instantâneo.
Error	Corpo do erro.
SnapshotApplyMode	Modo de aplicação de instantâneos. Atualmente, apenas a opção CreateNew é suportada, o que significa que a operação aplicar falhará se a subscrição de destino já contiver um objeto do mesmo tipo e utilizar o mesmo objectId. Os utilizadores podem especificar o "objectId" no corpo do pedido para evitar tais conflitos.

APIError

Informações de erro devolvidas pela API

Name	Tipo	Description
error	Error	Corpo do erro.

ApplySnapshotRequest

Corpo do pedido para aplicar a operação de instantâneo.

Name	Tipo	Default value	Description
mode	SnapshotApplyMode	CreateNew	Modo de aplicação de instantâneos. Atualmente, apenas a opção CreateNew é suportada, o que significa que a operação aplicar falhará se a subscrição de destino já contiver um objeto do mesmo tipo e utilizar o mesmo objectId. Os utilizadores podem especificar o "objectId" no corpo do pedido para evitar tais conflitos.
objectId	string		O utilizador especificou o ID do objeto de destino a criar a partir do instantâneo.

Error

Corpo do erro.

Name	Tipo	Description
code	string
message	string

SnapshotApplyMode

Modo de aplicação de instantâneos. Atualmente, apenas a opção CreateNew é suportada, o que significa que a operação aplicar falhará se a subscrição de destino já contiver um objeto do mesmo tipo e utilizar o mesmo objectId. Os utilizadores podem especificar o "objectId" no corpo do pedido para evitar tais conflitos.

Name	Tipo	Description
CreateNew	string