Snapshot - List

Referens

Tjänst:: Azure AI Services

API-version:: 1.0-preview

Lista alla tillgängliga ögonblicksbilder med relaterad information, inklusive ögonblicksbilder som har tagits av användaren eller ögonblicksbilder som ska tillämpas på användaren (prenumerations-ID ingick i applyScope i Snapshot - Take).

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus.api.cognitive.microsoft.com).
applyScope	query		string[]	Användardefinierade ögonblicksbilder använder omfång som ett sökfilter. ApplyScope är en matris med mål-ID:t för Azure-prenumerationen för ögonblicksbilden, som anges av den användare som skapade ögonblicksbilden av Snapshot – Take.
type	query		SnapshotObjectType	Användarens angivna objekttyp som ett sökfilter.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Svar

Name	Typ	Description
200 OK	Snapshot[]	Ett lyckat anrop returnerar en matris med ögonblicksbilder med information om ögonblicksbilder.
Other Status Codes	APIError	Felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

Exempel

List snapshots example

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 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"
  }
]

Definitioner

Name	Description
APIError	Felinformation som returneras av API:et
Error	Feltext.
Snapshot	Ögonblicksbildsobjekt. Api:et för ögonblicksbilder flyttar dina data utanför den geo du väljer för din resurs till USA, västra, Europa, västra och Sydostasien.
SnapshotObjectType	Typ av källobjekt i ögonblicksbilden, som anges av prenumeranten som skapade ögonblicksbilden när ögonblicksbilden anropades – Ta. För närvarande stöds FaceList, PersonGroup, LargeFaceList och LargePersonGroup.

APIError

Felinformation som returneras av API:et

Name	Typ	Description
error	Error	Feltext.

Error

Feltext.

Name	Typ	Description
code	string
message	string

Snapshot

Ögonblicksbildsobjekt. Api:et för ögonblicksbilder flyttar dina data utanför den geo du väljer för din resurs till USA, västra, Europa, västra och Sydostasien.

Name	Typ	Description
account	string	Ansiktskonto-ID för Azure Cognitive Service för prenumeranten som skapade ögonblicksbilden av Snapshot – Take.
applyScope	string[]	Matris med målprenumerations-ID:t för ögonblicksbilden, som anges av den användare som skapade ögonblicksbilden när han eller hon anropade Snapshot – Take. För varje ögonblicksbild kan endast prenumerationer som ingår i applyScope of Snapshot – Take tillämpa den.
createdTime	string	En kombinerad DATUM- och tidssträng för UTC som beskriver den skapade tiden för ögonblicksbilden. T.ex. 2018-12-25T11:41:02.2331413Z.
id	string	Ögonblicksbilds-ID.
lastUpdateTime	string	En kombinerad DATUM- och tidssträng för UTC som beskriver den senaste gången ögonblicksbilden skapades eller uppdaterades av Snapshot – Update. T.ex. 2018-12-25T11:51:27.8705696Z.
type	SnapshotObjectType	Typ av källobjekt i ögonblicksbilden, som anges av prenumeranten som skapade ögonblicksbilden när ögonblicksbilden anropades – Ta. För närvarande stöds FaceList, PersonGroup, LargeFaceList och LargePersonGroup.
userData	string	Användardefinierade data om ögonblicksbilden för valfritt ändamål. Längden får inte överstiga 16 kB.

SnapshotObjectType

Typ av källobjekt i ögonblicksbilden, som anges av prenumeranten som skapade ögonblicksbilden när ögonblicksbilden anropades – Ta. För närvarande stöds FaceList, PersonGroup, LargeFaceList och LargePersonGroup.

Name	Typ	Description
FaceList	string
LargeFaceList	string
LargePersonGroup	string
PersonGroup	string

Dela via