Large Person Group - List

Servicio:

Azure AI Services

Versión de la API:

1.0

Enumere todos los grupos de personas grandes existentes largePersonGroupId, name, userData y recognitionModel.

• Los grupos de personas grandes se almacenan en orden alfabético de largePersonGroupId.
• El parámetro "start" (cadena, opcional) es un valor largePersonGroupId proporcionado por el usuario que las entradas devueltas tienen identificadores mayores por comparación de cadenas. "start" establecido en vacío para indicar la devolución del primer elemento.
• El parámetro "top" (int, opcional) especifica el número de entradas que se van a devolver. Se puede devolver un máximo de 1000 entradas en una llamada. Para obtener más información, puede especificar "start" con el identificador de la última entrada devuelta de la llamada actual.
  Por ejemplo, el total de 5 grupos de personas grandes: "group1", ..., "group5".
  "start=&top=" devolverá los 5 grupos.
  "start=&top=2" devolverá "group1", "group2".
  "start=group2&top=3" devolverá "group3", "group4", "group5".

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://westus.api.cognitive.microsoft.com).
returnRecognitionModel	query		boolean	Valor que indica si la operación debe devolver "recognitionModel" en respuesta.
start	query		string maxLength: 64	Enumere grupos de personas grandes del valor de largePersonGroupId mayor que el "start".
top	query		integer minimum: 1 maximum: 1000	Número de grupos de personas grandes que se van a enumerar.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Respuestas

Nombre	Tipo	Description
200 OK	LargePersonGroup[]	Una llamada correcta devuelve una matriz de grupos de personas grandes y su información.
Other Status Codes	APIError	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

List large person groups example

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

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"
  }
]

Definiciones

Nombre	Description
APIError	Información de error devuelta por la API
Error	Cuerpo del error.
LargePersonGroup	Objeto de grupo de personas grandes.
RecognitionModel	Nombre del modelo de reconocimiento. El modelo de reconocimiento se usa cuando las características faciales se extraen y se asocian a faceIds detectados, (Large)FaceList o (Large)PersonGroup. Se puede proporcionar un nombre de modelo de reconocimiento al realizar Face - Detect o (Large)FaceList - Create o (Large)PersonGroup - Create. El valor predeterminado es "recognition_01", si es necesario el modelo más reciente, especifique explícitamente el modelo que necesita.

APIError

Object

Información de error devuelta por la API

Nombre	Tipo	Description
error	Error	Cuerpo del error.

Error

Object

Cuerpo del error.

Nombre	Tipo	Description
code	string
message	string

LargePersonGroup

Object

Objeto de grupo de personas grandes.

Nombre	Tipo	Valor predeterminado	Description
largePersonGroupId	string maxLength: 64 pattern: ^[a-z0-9-_]+$		LargePersonGroupId de los grupos de personas grandes de destino
name	string minLength: 1 maxLength: 128		Nombre definido por el usuario, la longitud máxima es 128.
recognitionModel	RecognitionModel	recognition_01	Nombre del modelo de reconocimiento. El modelo de reconocimiento se usa cuando las características faciales se extraen y se asocian a faceIds detectados, (Large)FaceList o (Large)PersonGroup. Se puede proporcionar un nombre de modelo de reconocimiento al realizar Face - Detect o (Large)FaceList - Create o (Large)PersonGroup - Create. El valor predeterminado es "recognition_01", si es necesario el modelo más reciente, especifique explícitamente el modelo que necesita.
userData	string maxLength: 16384		Datos especificados por el usuario. La longitud no debe superar los 16 KB.

RecognitionModel

Enumeración

Nombre del modelo de reconocimiento. El modelo de reconocimiento se usa cuando las características faciales se extraen y se asocian a faceIds detectados, (Large)FaceList o (Large)PersonGroup. Se puede proporcionar un nombre de modelo de reconocimiento al realizar Face - Detect o (Large)FaceList - Create o (Large)PersonGroup - Create. El valor predeterminado es "recognition_01", si es necesario el modelo más reciente, especifique explícitamente el modelo que necesita.

Valor	Description
recognition_01
recognition_02
recognition_03
recognition_04