Snapshot - Take

Serviço:

Azure AI Services

Versão da API:

1.0-preview

Envie uma operação para obter uma instantâneo de lista de rostos, lista de rostos grandes, grupo de pessoas ou grupo de pessoas grandes, com tipo de instantâneo especificado pelo usuário, ID do objeto de origem, escopo de aplicação e dados de usuário opcionais.
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 Instantâneo – 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.
Tomar 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 criação do instantâneo. A ID do instantâneo será incluída no campo "resourceLocation" em OperationStatus – Obter resposta quando a operação status for "bem-sucedida".
A tomada de tempo do instantâneo depende do número de entradas de pessoa e rosto no objeto de origem. Pode ser em segundos, ou até várias horas para 1.000.000 pessoas com múltiplas faces.
Os instantâneos expirarão e serão limpos automaticamente em 48 horas após serem criados pelo Snapshot – Take. O usuário pode excluir a instantâneo usando Instantâneo – Excluir por conta própria a qualquer momento antes da expiração.
Tomar instantâneo para um determinado objeto não bloqueará nenhuma outra operação em relação ao objeto . Todas as operações somente leitura (Obter/Listar e Identificar/LocalizarSimilar/Verificar) podem ser realizadas normalmente. Para todas as operações graváveis, incluindo Adicionar/Atualizar/Excluir o objeto de origem ou suas pessoas/rostos e Treinar, elas não são bloqueadas, mas não recomendadas porque atualizações graváveis podem não ser refletidas no instantâneo durante sua tomada. Depois que instantâneo tomada for concluída, todas as operações legíveis e graváveis poderão funcionar normalmente. O instantâneo também incluirá 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.

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

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

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

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
applyScope	True	string[]	Matriz especificada pelo usuário de IDs de assinatura de detecção facial de destino para o instantâneo. Para cada instantâneo, somente as assinaturas incluídas no applyScope de Snapshot – Take podem aplicá-lo.
objectId	True	string	ID de objeto de origem especificada pelo usuário para tirar instantâneo.
type	True	SnapshotObjectType	Tipo especificado pelo usuário para o objeto de origem do qual tirar instantâneo. Atualmente, há suporte para FaceList, PersonGroup, LargeFaceList e LargePersonGroup.
userData		string	O usuário especificou dados sobre o instantâneo para qualquer finalidade. O comprimento não deve exceder 16 KB.

Respostas

Nome	Tipo	Description
202 Accepted		O instantâneo tarefa de tomada 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

Take a snapshot example

Solicitação de exemplo

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 de exemplo

Código de status:

202

Definições

Nome	Description
APIError	Informações de erro retornadas pela API
Error	Corpo do erro.
SnapshotObjectType	Tipo do objeto de origem no instantâneo, especificado pelo assinante que criou o instantâneo ao chamar Snapshot – Take. Atualmente, há suporte para FaceList, PersonGroup, LargeFaceList e LargePersonGroup.
TakeSnapshotRequest	Corpo da solicitação para executar instantâneo operação.

APIError

Informações de erro retornadas pela API

Nome	Tipo	Description
error	Error	Corpo do erro.

Error

Corpo do erro.

Nome	Tipo	Description
code	string
message	string

SnapshotObjectType

Tipo do objeto de origem no instantâneo, especificado pelo assinante que criou o instantâneo ao chamar Snapshot – Take. Atualmente, há suporte para FaceList, PersonGroup, LargeFaceList e LargePersonGroup.

Nome	Tipo	Description
FaceList	string
LargeFaceList	string
LargePersonGroup	string
PersonGroup	string

TakeSnapshotRequest

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

Nome	Tipo	Description
applyScope	string[]	Matriz especificada pelo usuário de IDs de assinatura de detecção facial de destino para o instantâneo. Para cada instantâneo, somente as assinaturas incluídas no applyScope de Snapshot – Take podem aplicá-lo.
objectId	string	ID de objeto de origem especificada pelo usuário para tirar instantâneo.
type	SnapshotObjectType	Tipo especificado pelo usuário para o objeto de origem do qual tirar instantâneo. Atualmente, há suporte para FaceList, PersonGroup, LargeFaceList e LargePersonGroup.
userData	string	O usuário especificou dados sobre o instantâneo para qualquer finalidade. O comprimento não deve exceder 16 KB.