Large Person Group - List

Usługa:

Azure AI Services

Wersja interfejsu API:

1.0

Wyświetl listę wszystkich istniejących dużych grup osób largePersonGroupId, name, userData i recognitionModel.

• Duże grupy osób są przechowywane w kolejności alfabetycznej largePersonGroupId.
• Parametr "start" (ciąg, opcjonalny) to podana przez użytkownika wartość largePersonGroupId, która zwracane wpisy mają większe identyfikatory według porównania ciągów. Wartość "start" ustawiona na wartość pustą, aby wskazać powrót z pierwszego elementu.
• Parametr "top" (int, optional) określa liczbę wpisów do zwrócenia. Maksymalnie 1000 wpisów można zwrócić w jednym wywołaniu. Aby pobrać więcej, możesz określić wartość "start" z identyfikatorem ostatniego zwróconego wpisu bieżącego wywołania.
  Na przykład łącznie 5 dużych grup osób: "group1", ..., "group5".
  Wyrażenie "start=&top=" zwróci wszystkie 5 grup.
  Wyrażenie "start=&top=2" zwróci wartość "group1", "group2".
  Wyrażenie "start=group2&top=3" zwróci wartość "group3", "group4", "group5".

GET {Endpoint}/face/v1.0/largepersongroups

Z parametrami opcjonalnymi:

GET {Endpoint}/face/v1.0/largepersongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus.api.cognitive.microsoft.com).
returnRecognitionModel	query		boolean	Wartość wskazująca, czy operacja powinna zwrócić element "recognitionModel" w odpowiedzi.
start	query		string maxLength: 64	Wyświetl listę dużych grup osób z najmniejszej liczby dużychPersonGroupId większej niż "start".
top	query		integer minimum: 1 maximum: 1000	Liczba grup osób do wyświetlenia.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string

Odpowiedzi

Nazwa	Typ	Opis
200 OK	LargePersonGroup[]	Pomyślne wywołanie zwraca tablicę dużych grup osób i ich informacji.
Other Status Codes	APIError	Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

Przykłady

List large person groups example

Przykładowe żądanie

HTTP

GET {Endpoint}/face/v1.0/largepersongroups?start=sample_group&top=2&returnRecognitionModel=True

Przykładowa odpowiedź

Kod stanu:

200

[
  {
    "largePersonGroupId": "f92f6f1b-3258-4444-8fa2-c2df505cc7ac",
    "name": "large-person-group-name1",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  },
  {
    "largePersonGroupId": "c76f7f13-0ed3-4d00-8a3e-2ad3d78f6c37",
    "name": "large-person-group-name2",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  }
]

Definicje

Nazwa	Opis
APIError	Informacje o błędzie zwrócone przez interfejs API
Error	Treść błędu.
LargePersonGroup	Obiekt grupy dużej osoby.
RecognitionModel	Nazwa modelu rozpoznawania. Model rozpoznawania jest używany, gdy funkcje twarzy są wyodrębniane i skojarzone z wykrytymi identyfikatorami faceId, (Large)FaceList lub (Large)PersonGroup. Podczas wykonywania funkcji Face - Detect lub (Large)FaceList — Create lub (Large)PersonGroup — Create lub (Large)PersonGroup — Create (Duża)PersonGroup — Utwórz. Wartość domyślna to "recognition_01", jeśli wymagany jest najnowszy model, jawnie określ potrzebny model.

APIError

Objekt

Informacje o błędzie zwrócone przez interfejs API

Nazwa	Typ	Opis
error	Error	Treść błędu.

Error

Objekt

Treść błędu.

Nazwa	Typ	Opis
code	string
message	string

LargePersonGroup

Objekt

Obiekt grupy dużej osoby.

Nazwa	Typ	Domyślna wartość	Opis
largePersonGroupId	string maxLength: 64 pattern: ^[a-z0-9-_]+$		LargePersonGroupId docelowych grup dużych osób
name	string minLength: 1 maxLength: 128		Nazwa zdefiniowana przez użytkownika, maksymalna długość to 128.
recognitionModel	RecognitionModel	recognition_01	Nazwa modelu rozpoznawania. Model rozpoznawania jest używany, gdy funkcje twarzy są wyodrębniane i skojarzone z wykrytymi identyfikatorami faceId, (Large)FaceList lub (Large)PersonGroup. Podczas wykonywania funkcji Face - Detect lub (Large)FaceList — Create lub (Large)PersonGroup — Create lub (Large)PersonGroup — Create (Duża)PersonGroup — Utwórz. Wartość domyślna to "recognition_01", jeśli wymagany jest najnowszy model, jawnie określ potrzebny model.
userData	string maxLength: 16384		Dane określone przez użytkownika. Długość nie powinna przekraczać 16 KB.

RecognitionModel

Wyliczanie

Nazwa modelu rozpoznawania. Model rozpoznawania jest używany, gdy funkcje twarzy są wyodrębniane i skojarzone z wykrytymi identyfikatorami faceId, (Large)FaceList lub (Large)PersonGroup. Podczas wykonywania funkcji Face - Detect lub (Large)FaceList — Create lub (Large)PersonGroup — Create lub (Large)PersonGroup — Create (Duża)PersonGroup — Utwórz. Wartość domyślna to "recognition_01", jeśli wymagany jest najnowszy model, jawnie określ potrzebny model.

Wartość	Opis
recognition_01
recognition_02
recognition_03
recognition_04