Compartilhar via


Person Group Operations - Get Large Person Groups

Liste todos os largePersonGroupId, nome, userData e recognitionModel de pessoas grandes existentes do Grupos.
As Grupos pessoa grandes são armazenadas em ordem alfabética de largePersonGroupId.

    • O parâmetro "start" (cadeia de caracteres, opcional) especifica um valor de ID do qual as entradas retornadas terão IDs maiores com base na comparação de cadeia de caracteres. Definir "start" como um valor vazio indica que as entradas devem ser retornadas a partir do primeiro item.
    • O parâmetro "top" (int, opcional) determina o número máximo de entradas a serem retornadas, com um limite de até 1000 entradas por chamada. Para recuperar entradas adicionais além desse limite, especifique "start" com a personId da última entrada retornada na chamada atual.

Dica

  • Por exemplo, há no total cinco itens com suas IDs: "itemId1", ..., "itemId5".
    • "start=&top=" retornará todos os 5 itens.
    • "start=&top=2" retornará "itemId1", "itemId2".
    • "start=itemId2&top=3" retornará "itemId3", "itemId4", "itemId5".
GET {endpoint}/face/{apiVersion}/largepersongroups
GET {endpoint}/face/{apiVersion}/largepersongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
apiVersion
path True

string

Versão da API

endpoint
path True

string

uri

Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://{resource-name}.cognitiveservices.azure.com).

returnRecognitionModel
query

boolean

Retornar 'recognitionModel' ou não. O valor padrão é false.

start
query

string

Listar recursos maiores que o "iniciar". Ele contém no máximo 64 caracteres. O padrão é vazio.

top
query

integer

int32

O número de itens a serem listados, variando em [1,1000]. O padrão é 1000.

Respostas

Nome Tipo Description
200 OK

LargePersonGroup[]

Uma chamada bem-sucedida retorna uma matriz de Grupos de Pessoa Grande e suas informações (largePersonGroupId, name e userData).

Other Status Codes

FaceErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

A chave secreta para sua assinatura de Detecção Facial de IA do Azure.

Tipo: apiKey
Em: header

AADToken

O fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://api.example.com/oauth2/authorize
URL do Token: https://api.example.com/oauth2/token

Escopos

Nome Description
https://cognitiveservices.azure.com/.default

Exemplos

Get LargePersonGroups

Solicitação de exemplo

GET {endpoint}/face/v1.1-preview.1/largepersongroups?start=00000000-0000-0000-0000-000000000000&top=20&returnRecognitionModel=True

Resposta de exemplo

[
  {
    "name": "your_large_person_group_name",
    "userData": "your_user_data",
    "recognitionModel": "recognition_01",
    "largePersonGroupId": "your_large_person_group_id"
  }
]

Definições

Nome Description
FaceError

O objeto de erro. Para obter detalhes abrangentes sobre códigos de erro e mensagens retornadas pelo Serviço de Detecção Facial, consulte o seguinte link: https://aka.ms/face-error-codes-and-messages.

FaceErrorResponse

Uma resposta que contém detalhes do erro.

LargePersonGroup

O contêiner dos dados da pessoa carregada, incluindo o recurso de reconhecimento facial, e até 1.000.000 pessoas.

RecognitionModel

O modelo de reconhecimento para o rosto.

FaceError

O objeto de erro. Para obter detalhes abrangentes sobre códigos de erro e mensagens retornadas pelo Serviço de Detecção Facial, consulte o seguinte link: https://aka.ms/face-error-codes-and-messages.

Nome Tipo Description
code

string

Um de um conjunto definido pelo servidor de códigos de erro.

message

string

Uma representação legível do erro.

FaceErrorResponse

Uma resposta que contém detalhes do erro.

Nome Tipo Description
error

FaceError

O objeto de erro.

LargePersonGroup

O contêiner dos dados da pessoa carregada, incluindo o recurso de reconhecimento facial, e até 1.000.000 pessoas.

Nome Tipo Description
largePersonGroupId

string

ID do contêiner.

name

string

Nome definido pelo usuário, o comprimento máximo é 128.

recognitionModel

RecognitionModel

Nome do modelo de reconhecimento. O modelo de reconhecimento é usado quando os recursos de detecção facial são extraídos e associados a faceIds detectadas.

userData

string

Dados opcionais definidos pelo usuário. O comprimento não deve exceder 16K.

RecognitionModel

O modelo de reconhecimento para o rosto.

Nome Tipo Description
recognition_01

string

O modelo de reconhecimento padrão para "Detectar". Todas essas faceIds criadas antes de março de 2019 são vinculadas a esse modelo de reconhecimento.

recognition_02

string

Modelo de reconhecimento lançado em março de 2019.

recognition_03

string

Modelo de reconhecimento lançado em maio de 2020.

recognition_04

string

Modelo de reconhecimento lançado em fevereiro de 2021. É recomendável usar esse modelo de reconhecimento para obter uma melhor precisão de reconhecimento.