Snapshot - List

Reference

Služba:: Azure AI Services

Verze rozhraní API:: 1.0-preview

Vypište všechny přístupné snímky se souvisejícími informacemi, včetně snímků pořízených uživatelem nebo snímků, které se mají na uživatele použít (ID předplatného bylo zahrnuto v applyScope ve snímku – Take).

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus.api.cognitive.microsoft.com).
applyScope	query		string[]	Snímek zadaný uživatelem použije obory jako filtr hledání. ApplyScope je pole cílových ID předplatného Azure pro snímek zadané uživatelem, který vytvořil snímek pomocí funkce Snímek – Pořízení.
type	query		SnapshotObjectType	Uživatel zadal typ objektu jako vyhledávací filtr.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Odpovědi

Name	Typ	Description
200 OK	Snapshot[]	Úspěšné volání vrátí pole snímků s informacemi o snímku.
Other Status Codes	APIError	Odpověď na chybu.

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

Příklady

List snapshots example

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
  }
]

Definice

Name	Description
APIError	Informace o chybě vrácené rozhraním API
Error	Text chyby.
Snapshot	Snímek objektu. Rozhraní Snapshot API přesune data mimo geografickou oblast, kterou vyberete pro svůj prostředek, do oblasti USA – západ, Západní Evropa a Jihovýchodní Asie.
SnapshotObjectType	Typ zdrojového objektu ve snímku zadaný odběratelem, který snímek vytvořil při volání snímku – Pořízení. V současné době se podporují FaceList, PersonGroup, LargeFaceList a LargePersonGroup.

APIError

Informace o chybě vrácené rozhraním API

Name	Typ	Description
error	Error	Text chyby.

Error

Text chyby.

Name	Typ	Description
code	string
message	string

Snapshot

Snímek objektu. Rozhraní Snapshot API přesune data mimo geografickou oblast, kterou vyberete pro svůj prostředek, do oblasti USA – západ, Západní Evropa a Jihovýchodní Asie.

Name	Typ	Description
account	string	ID účtu rozpoznávání tváře služby Azure Cognitive Service odběratele, který vytvořil snímek podle snímku – Pořízení.
applyScope	string[]	Pole ID předplatného cílové tváře pro snímek zadané uživatelem, který snímek vytvořil při volání snímku – Pořízení. Pro každý snímek ho můžou použít jenom předplatná zahrnutá v applyScope of Snapshot – Take.
createdTime	string	Kombinovaný řetězec data a času UTC, který popisuje čas vytvoření snímku. Například 2018-12-25T11:41:02.2331413Z.
id	string	ID snímku.
lastUpdateTime	string	Kombinovaný řetězec data a času UTC, který popisuje čas posledního vytvoření nebo aktualizace snímku pomocí funkce Snímek – Aktualizace. Například 2018-12-25T11:51:27.8705696Z.
type	SnapshotObjectType	Typ zdrojového objektu ve snímku zadaný odběratelem, který snímek vytvořil při volání snímku – Pořízení. V současné době se podporují FaceList, PersonGroup, LargeFaceList a LargePersonGroup.
userData	string	Uživatel zadal data o snímku pro jakýkoli účel. Délka by neměla překročit 16 kB.

SnapshotObjectType

Typ zdrojového objektu ve snímku zadaný odběratelem, který snímek vytvořil při volání snímku – Pořízení. V současné době se podporují FaceList, PersonGroup, LargeFaceList a LargePersonGroup.

Name	Typ	Description
FaceList	string
LargeFaceList	string
LargePersonGroup	string
PersonGroup	string

Sdílet prostřednictvím