Person Group Operations - Get Person Groups

Serviço:

Azure AI Services

Versão da API:

v1.2-preview.1

Listar personGroupId dos Grupos de Pessoas, nome, userData e recognitionModel.
Os Grupos de Pessoas são armazenados em ordem alfabética de personGroupId.

• • 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

Com parâmetros opcionais:

GET {endpoint}/face/{apiVersion}/persongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

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).
returnRecognitionModel	query		boolean	Retornar 'recognitionModel' ou não. O valor padrão é false.
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	PersonGroup[]	Uma chamada bem-sucedida retorna uma matriz de Grupos de Pessoas e suas informações (personGroupId, 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 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 PersonGroups

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

200

[
  {
    "name": "your_person_group_name",
    "userData": "your_user_data",
    "recognitionModel": "recognition_01",
    "personGroupId": "your_person_group_id"
  }
]

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.
PersonGroup	O contêiner dos dados da pessoa carregada, incluindo o recurso de reconhecimento facial, e até 10.000 pessoas. Para lidar com problemas de identificação facial em maior escala, considere o uso do Grupo de Pessoas Grandes.
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 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.

PersonGroup

O contêiner dos dados da pessoa carregada, incluindo o recurso de reconhecimento facial, e até 10.000 pessoas. Para lidar com problemas de identificação facial em maior escala, considere o uso do Grupo de Pessoas Grandes.

Name	Tipo	Description
name	string	Nome definido pelo usuário, comprimento máximo é 128.
personGroupId	string	ID do contentor.
recognitionModel	RecognitionModel	Nome do modelo de reconhecimento. O modelo de reconhecimento é usado quando as características do rosto são extraídas e associadas aos faceIds detetados.
userData	string	Dados opcionais definidos pelo usuário. O comprimento não deve exceder 16K.

RecognitionModel

O modelo de reconhecimento para o rosto.

Name	Tipo	Description
recognition_01	string	O modelo de reconhecimento padrão para "Detetar". Todos os faceIds criados antes de março de 2019 estão ligados a este 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. Recomenda-se usar este modelo de reconhecimento para uma melhor precisão de reconhecimento.