Snapshot - Take

Serviço:

Azure AI Services

Versão da API:

1.0-preview

Submeta uma operação para tirar um instantâneo da lista de rostos, lista de rostos grandes, grupo de pessoas ou grupo de pessoas grandes, com o tipo de instantâneo especificado pelo utilizador, id do objeto de origem, aplicar âmbito e dados de utilizador opcionais.
As interfaces de instantâneo destinam-se a que os utilizadores criem cópias de segurança e restaurem os 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.
Tirar instantâneos é 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 criação do instantâneo. O ID do instantâneo será incluído no campo "resourceLocation" em OperationStatus – Obter resposta quando o estado da operação for "com êxito".
O instantâneo que demora tempo depende do número de entradas pessoais e faciais no objeto de origem. Pode ser em segundos ou até várias horas 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 Snapshot - Take. O utilizador pode eliminar o instantâneo com o Instantâneo – Eliminar sozinho a qualquer momento antes da expiração.
A criação de instantâneos para um determinado objeto não bloqueará quaisquer outras operações no objeto. Todas as operações só de leitura (Get/List e Identify/FindSimilar/Verify) podem ser realizadas como habitualmente. Para todas as operações graváveis, incluindo Adicionar/Atualizar/Eliminar o objeto de origem ou as respetivas pessoas/rostos e Preparar, não são bloqueadas, mas não são recomendadas porque as atualizações graváveis podem não ser refletidas no instantâneo durante a sua tomada. Após a conclusão da captura de instantâneos, todas as operações legíveis e graváveis podem funcionar normalmente. O instantâneo também incluirá 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 Identify/FindSimilar.

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

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

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).

Cabeçalho do Pedido

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

Corpo do Pedido

Name	Necessário	Tipo	Description
applyScope	True	string[]	O utilizador especificou a matriz de IDs de subscrição face de destino para o instantâneo. Para cada instantâneo, apenas as subscrições incluídas no applyScope of Snapshot - Take podem aplicá-lo.
objectId	True	string	O utilizador especificou o ID do objeto de origem a partir do qual tirar um instantâneo.
type	True	SnapshotObjectType	Tipo especificado pelo utilizador para o objeto de origem tirar instantâneo. Atualmente, são suportados FaceList, PersonGroup, LargeFaceList e LargePersonGroup.
userData		string	O utilizador especificou dados sobre o instantâneo para qualquer finalidade. O comprimento não deve exceder os 16 KB.

Respostas

Name	Tipo	Description
202 Accepted		A tarefa de criação de instantâneos foi colocada 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

Take a snapshot example

Pedido de amostra

HTTP

POST {Endpoint}/face/v1.0-preview/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."
}

Resposta da amostra

Código de estado:

202

Definições

Name	Description
APIError	Informações de erro devolvidas pela API
Error	Corpo do erro.
SnapshotObjectType	Tipo do objeto de origem no instantâneo, especificado pelo subscritor que criou o instantâneo ao chamar Snapshot - Take. Atualmente, são suportados FaceList, PersonGroup, LargeFaceList e LargePersonGroup.
TakeSnapshotRequest	Corpo do pedido para a operação de criação de instantâneos.

APIError

Informações de erro devolvidas pela API

Name	Tipo	Description
error	Error	Corpo do erro.

Error

Corpo do erro.

Name	Tipo	Description
code	string
message	string

SnapshotObjectType

Tipo do objeto de origem no instantâneo, especificado pelo subscritor que criou o instantâneo ao chamar Snapshot - Take. Atualmente, são suportados FaceList, PersonGroup, LargeFaceList e LargePersonGroup.

Name	Tipo	Description
FaceList	string
LargeFaceList	string
LargePersonGroup	string
PersonGroup	string

TakeSnapshotRequest

Corpo do pedido para a operação de criação de instantâneos.

Name	Tipo	Description
applyScope	string[]	O utilizador especificou a matriz de IDs de subscrição face de destino para o instantâneo. Para cada instantâneo, apenas as subscrições incluídas no applyScope of Snapshot - Take podem aplicá-lo.
objectId	string	O utilizador especificou o ID do objeto de origem a partir do qual tirar um instantâneo.
type	SnapshotObjectType	Tipo especificado pelo utilizador para o objeto de origem tirar instantâneo. Atualmente, são suportados FaceList, PersonGroup, LargeFaceList e LargePersonGroup.
userData	string	O utilizador especificou dados sobre o instantâneo para qualquer finalidade. O comprimento não deve exceder os 16 KB.