Compartilhar via

Large Person Group - List

  • Referência
Serviço:
Azure AI Services
Versão da API:
1.0

Listar todos os grupos de pessoas grandes existentes de largePersonGroupId, nome, userData e recognitionModel.

  • Grupos de pessoas grandes são armazenados em ordem alfabética de largePersonGroupId.
  • O parâmetro "start" (cadeia de caracteres, opcional) é um valor largePersonGroupId fornecido pelo usuário que as entradas retornadas têm IDs maiores por comparação de cadeia de caracteres. "start" definido como vazio para indicar o retorno do primeiro item.
  • O parâmetro "top" (int, opcional) especifica o número de entradas a serem retornadas. Uma máxima de 1000 entradas pode ser retornada em uma chamada. Para buscar mais, você pode especificar "iniciar" com a ID da última entrada retornada da chamada atual.
    Por exemplo, total de 5 grupos de pessoas grandes: "group1", ..., "group5".
    "start=&top=" retornará todos os cinco grupos.
    "start=&top=2" retornará "group1", "group2".
    "start=group2&top=3" retornará "group3", "group4", "group5".
GET {Endpoint}/face/v1.0/largepersongroups
Com parâmetros opcionais: 
GET {Endpoint}/face/v1.0/largepersongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
Endpoint
 path True

string

Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus.api.cognitive.microsoft.com).
returnRecognitionModel
 query

boolean

Um valor que indica se a operação deve retornar 'recognitionModel' em resposta.
start
 query

string

maxLength: 64

Liste grupos de pessoas grandes do menos largePersonGroupId maior que o "start".
top
 query

integer

minimum: 1
maximum: 1000

O número de grupos de pessoas grandes a serem listados.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Ocp-Apim-Subscription-Key True

string

Respostas

Nome Tipo Description
200 OK

LargePersonGroup[]

Uma chamada bem-sucedida retorna uma matriz de grupos de pessoas grandes e suas informações.
Other Status Codes

APIError

Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

List large person groups example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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"
  }
]

Definições

Nome Description
APIError

Informações de erro retornadas pela API
Error

Corpo do erro.
LargePersonGroup

Objeto de grupo de pessoas grandes.
RecognitionModel

Nome do modelo de reconhecimento. O modelo de reconhecimento é usado quando os recursos de rosto são extraídos e associados a faceIds detectadas, (Large)FaceList ou (Large)PersonGroup. Um nome de modelo de reconhecimento pode ser fornecido ao executar Face - Detect ou (Large)FaceList - Create or (Large)PersonGroup - Create. O valor padrão é 'recognition_01', se o modelo mais recente for necessário, especifique explicitamente o modelo necessário.

APIError

Objeto

Informações de erro retornadas pela API

Nome Tipo Description
error

Error

Corpo do erro.

Error

Objeto

Corpo do erro.

Nome Tipo Description
code

string

message

string

LargePersonGroup

Objeto

Objeto de grupo de pessoas grandes.

Nome Tipo Valor padrão Description
largePersonGroupId

string

maxLength: 64
pattern: ^[a-z0-9-_]+$

LargePersonGroupId dos grupos de pessoas grandes de destino
name

string

minLength: 1
maxLength: 128

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

RecognitionModel

recognition_01

Nome do modelo de reconhecimento. O modelo de reconhecimento é usado quando os recursos de rosto são extraídos e associados a faceIds detectadas, (Large)FaceList ou (Large)PersonGroup. Um nome de modelo de reconhecimento pode ser fornecido ao executar Face - Detect ou (Large)FaceList - Create or (Large)PersonGroup - Create. O valor padrão é 'recognition_01', se o modelo mais recente for necessário, especifique explicitamente o modelo necessário.
userData

string

maxLength: 16384

Dados especificados pelo usuário. O comprimento não deve exceder 16 KB.

RecognitionModel

Enumeração

Nome do modelo de reconhecimento. O modelo de reconhecimento é usado quando os recursos de rosto são extraídos e associados a faceIds detectadas, (Large)FaceList ou (Large)PersonGroup. Um nome de modelo de reconhecimento pode ser fornecido ao executar Face - Detect ou (Large)FaceList - Create or (Large)PersonGroup - Create. O valor padrão é 'recognition_01', se o modelo mais recente for necessário, especifique explicitamente o modelo necessário.

Valor Description
recognition_01
recognition_02
recognition_03
recognition_04