Snapshot - List

Referência

Serviço:: Azure AI Services

Versão da API:: 1.0-preview

Liste todos os instantâneos acessíveis com informações relacionadas, incluindo instantâneos que foram tirados pelo utilizador ou instantâneos a serem aplicados ao utilizador (o ID da subscrição foi incluído no applyScope no Instantâneo - Take).

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

Com parâmetros opcionais:

GET {Endpoint}/face/v1.0-preview/snapshots?type={type}&applyScope={applyScope}

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).
applyScope	query		string[]	O instantâneo especificado pelo utilizador aplica âmbitos como um filtro de pesquisa. ApplyScope é uma matriz dos IDs de subscrição do Azure de destino para o instantâneo, especificado pelo utilizador que criou o instantâneo por Snapshot - Take.
type	query		SnapshotObjectType	O utilizador especificou o tipo de objeto como um filtro de pesquisa.

Cabeçalho do Pedido

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

Respostas

Name	Tipo	Description
200 OK	Snapshot[]	Uma chamada bem-sucedida devolve uma matriz de instantâneos com informações de instantâneo.
Other Status Codes	APIError	Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

List snapshots example

Pedido de amostra

HTTP

GET {Endpoint}/face/v1.0-preview/snapshots?type=FaceList&applyScope=64084E07-9B7F-4A98-BEA4-9986D3A1EDEB

Resposta da amostra

Código de estado:: 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 snapshot1.",
    "createdTime": "2018-12-25T11:41:02.2331413Z",
    "lastUpdateTime": "2018-12-25T11:51:27.8705696Z"
  },
  {
    "id": "a61e61e4-c3d1-4d33-8ae8-676e6104757d",
    "account": "/subscriptions/6622996e-0149-4b22-9703-4216dc948d52/resourceGroups/TestRG/providers/Microsoft.CognitiveServices/accounts/FaceTest01",
    "type": "FaceList",
    "applyScope": [
      "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB"
    ],
    "userData": "User-provided data attached to the snapshot2.",
    "createdTime": "2018-12-29T17:09:32.3298483Z",
    "lastUpdateTime": "2018-12-29T17:14:34.5645877Z"
  }
]

Definições

Name	Description
APIError	Informações de erro devolvidas pela API
Error	Corpo do erro.
Snapshot	Objeto instantâneo. A API de Instantâneo irá mover os seus dados para fora da geo que selecionar para o recurso para E.U.A. Oeste, Europa Ocidental e Ásia Sudeste.
SnapshotObjectType	Tipo do objeto de origem no instantâneo, especificado pelo subscritor que criou o instantâneo ao chamar Instantâneo - Take. Atualmente, são suportados FaceList, PersonGroup, LargeFaceList e LargePersonGroup.

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

Snapshot

Objeto instantâneo. A API de Instantâneo irá mover os seus dados para fora da geo que selecionar para o recurso para E.U.A. Oeste, Europa Ocidental e Ásia Sudeste.

Name	Tipo	Description
account	string	ID da conta Face do Serviço Cognitivo do Azure do subscritor que criou o instantâneo por Instantâneo – Take.
applyScope	string[]	Matriz dos IDs da subscrição Face de destino para o instantâneo, especificado pelo utilizador que criou o instantâneo ao chamar Instantâneo - Take. Para cada instantâneo, apenas as subscrições incluídas no applyScope of Snapshot - Take podem aplicá-lo.
createdTime	string	Uma cadeia de data e hora UTC combinada que descreve a hora de criação do instantâneo. Por exemplo, 2018-12-25T11:41:02.2331413Z.
id	string	ID do instantâneo.
lastUpdateTime	string	Uma cadeia de data e hora UTC combinada que descreve a última vez que o instantâneo foi criado ou atualizado pelo Instantâneo – Atualização. Por exemplo, 2018-12-25T11:51:27.8705696Z.
type	SnapshotObjectType	Tipo do objeto de origem no instantâneo, especificado pelo subscritor que criou o instantâneo ao chamar Instantâneo - Take. 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.

SnapshotObjectType

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

Name	Tipo	Description
FaceList	string
LargeFaceList	string
LargePersonGroup	string
PersonGroup	string

Partilhar via