Partilhar via

Person Group Operations - Get Person Group Persons

  • Referência
Serviço:
Azure AI Services
Versão da API:
v1.2-preview.1

Liste todas as informações de pessoas no Grupo de Pessoas especificado, incluindo personId, nome, userData e FaceIds persistentes de rostos de pessoas registradas.
As pessoas são armazenadas em ordem alfabética de personId criado em "Create Person Group Person".

    • O parâmetro "start" (string, opcional) especifica um valor de ID a partir 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 o personId da última entrada retornada na chamada atual.

Dica

  • Por exemplo, há um total de 5 itens com seus 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}/persongroups/{personGroupId}/persons
Com parâmetros opcionais: 
GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/persons?start={start}&top={top}

Parâmetros do URI

Name Em Necessário Tipo Description
apiVersion
 path True

string

Versão da API
endpoint
 path True

string

uri

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

string

ID do contentor.

Padrão Regex: ^[a-z0-9-_]+$
start
 query

string

Listar recursos maiores que o "início". Não contém mais de 64 caracteres. O padrão está vazio.
top
 query

integer

int32

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

Respostas

Name Tipo Description
200 OK

PersonGroupPerson[]

Uma chamada bem-sucedida retorna uma matriz de informações de pessoa que pertencem ao Grupo de Pessoas.
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 do Azure AI Face.

Tipo: apiKey
Em: header

AADToken

O fluxo OAuth2 do Azure Ative Directory

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

Âmbitos

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

Exemplos

Get Persons from PersonGroup

Pedido de amostra

GET {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id/persons?start=00000000-0000-0000-0000-000000000000&top=20

Resposta da amostra

Código de estado:
200 
[
  {
    "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
    "name": "your_person_group_person_name",
    "userData": "your_user_data",
    "persistedFaceIds": [
      "43897a75-8d6f-42cf-885e-74832febb055"
    ]
  }
]

Definições

Name Description
FaceError

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

Uma resposta contendo detalhes do erro.
PersonGroupPerson

A pessoa em um grupo de pessoas especificado. Para adicionar rosto a essa pessoa, ligue para "Adicionar rosto de pessoa de grupo de pessoa grande".

FaceError

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

Name Tipo Description
code

string

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

string

Uma representação legível por humanos do erro.

FaceErrorResponse

Uma resposta contendo detalhes do erro.

Name Tipo Description
error

FaceError

O objeto de erro.

PersonGroupPerson

A pessoa em um grupo de pessoas especificado. Para adicionar rosto a essa pessoa, ligue para "Adicionar rosto de pessoa de grupo de pessoa grande".

Name Tipo Description
name

string

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

string[]

Identificações faciais de rostos registados na pessoa.
personId

string

ID da pessoa.
userData

string

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