Snapshot - Get

Referência

Serviço:: Azure AI Services

Versão da API:: 1.0-preview

Recuperar informações sobre um instantâneo. O instantâneo só pode ser acessado pela assinatura de origem que o pegou e as assinaturas de destino incluídas no applyScope em Snapshot – Take.

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

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

Respostas

Nome	Tipo	Description
200 OK	Snapshot	Uma chamada bem-sucedida retorna as informações do instantâneo.
Other Status Codes	APIError	Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Get snapshot example

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "id": "e58b3f08-1e8b-4165-81df-aa9858f233dc",
  "account": "/subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/TestRG/providers/Microsoft.CognitiveServices/accounts/FaceTest01",
  "type": "FaceList",
  "applyScope": [
    "35230F59-AA9C-45E0-AB5E-C859BF1A5429",
    "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB"
  ],
  "userData": "User-provided data attached to the snapshot.",
  "createdTime": "2018-12-25T11:41:02.2331413Z",
  "lastUpdateTime": "2018-12-25T11:51:27.8705696Z"
}

Definições

Nome	Description
APIError	Informações de erro retornadas pela API
Error	Corpo do erro.
Snapshot	Objeto snapshot. A API de Instantâneo moverá seus dados para fora da área geográfica selecionada para o recurso para Oeste dos EUA, Oeste da Europa e Sudeste Asiático.
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.

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

Snapshot

Objeto snapshot. A API de Instantâneo moverá seus dados para fora da área geográfica selecionada para o recurso para Oeste dos EUA, Oeste da Europa e Sudeste Asiático.

Nome	Tipo	Description
account	string	ID da conta de Detecção Facial do Serviço Cognitivo do Azure do assinante que criou o instantâneo por Instantâneo – Take.
applyScope	string[]	Matriz das IDs de assinatura de Detecção Facial de destino para a instantâneo, especificada pelo usuário que criou o instantâneo ao chamar Snapshot – Take. Para cada instantâneo, somente as assinaturas incluídas no applyScope of Snapshot – Take podem aplicá-lo.
createdTime	string	Uma cadeia de caracteres de data e hora UTC combinada que descreve a hora criada do instantâneo. Por exemplo, 2018-12-25T11:41:02.2331413Z.
id	string	ID do instantâneo.
lastUpdateTime	string	Uma cadeia de caracteres de data e hora UTC combinada que descreve a última vez em que o instantâneo foi criado ou atualizado pelo Snapshot – Update. Por exemplo, 2018-12-25T11:51:27.8705696Z.
type	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.
userData	string	Os dados especificados pelo usuário sobre o instantâneo para qualquer finalidade. O comprimento não deve exceder 16 KB.

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

Compartilhar via