Person Group Operations - Get Large Person Groups

Servicio:

Azure AI Services

Versión de la API:

v1.2-preview.1

Enumere todos los valores largePersonGroupId, name, userData y recognitionModel existentes de los grupos de personas grandes.
Los grupos de personas grandes se almacenan en orden alfabético de largePersonGroupId.

• • El parámetro "start" (cadena, opcional) especifica un valor de identificador del que las entradas devueltas tendrán identificadores mayores en función de la comparación de cadenas. Si se establece "start" en un valor vacío se indica que las entradas deben devolverse a partir del primer elemento.
  • El parámetro "top" (int, opcional) determina el número máximo de entradas que se van a devolver, con un límite de hasta 1000 entradas por llamada. Para recuperar entradas adicionales más allá de este límite, especifique "start" con el personId de la última entrada devuelta en la llamada actual.

Propina

• Por ejemplo, hay un total de 5 elementos con sus identificadores: "itemId1", ..., "itemId5".
  • "start=&top=" devolverá los 5 elementos.
  • "start=&top=2" devolverá "itemId1", "itemId2".
  • "start=itemId2&top=3" devolverá "itemId3", "itemId4", "itemId5".

GET {endpoint}/face/{apiVersion}/largepersongroups

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
apiVersion	path	True	string	Versión de API
endpoint	path	True	string uri	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://{resource-name}.cognitiveservices.azure.com).
returnRecognitionModel	query		boolean	Devuelve 'recognitionModel' o no. El valor predeterminado es false.
start	query		string	Enumera los recursos mayores que el "inicio". No contiene más de 64 caracteres. El valor predeterminado está vacío.
top	query		integer int32	Número de elementos que se van a enumerar, comprendidos en [1, 1000]. El valor predeterminado es 1000.

Respuestas

Nombre	Tipo	Description
200 OK	LargePersonGroup[]	Una llamada correcta devuelve una matriz de grupos de personas grandes y su información (largePersonGroupId, name y userData).
Other Status Codes	FaceErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Clave secreta de la suscripción de Azure AI Face.

Tipo: apiKey
En: header

AADToken

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://api.example.com/oauth2/authorize
Dirección URL del token: https://api.example.com/oauth2/token

Ámbitos

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

Ejemplos

Get LargePersonGroups

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
FaceError	Objeto de error. Para obtener detalles completos sobre los códigos de error y los mensajes devueltos por face Service, consulte el vínculo siguiente: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Respuesta que contiene los detalles del error.
LargePersonGroup	El contenedor de los datos de persona cargados, incluida la característica de reconocimiento facial, y hasta 1000 000 personas.
RecognitionModel	Modelo de reconocimiento para la cara.

FaceError

Objeto de error. Para obtener detalles completos sobre los códigos de error y los mensajes devueltos por face Service, consulte el vínculo siguiente: https://aka.ms/face-error-codes-and-messages.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
message	string	Representación legible del error.

FaceErrorResponse

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	FaceError	Objeto de error.

LargePersonGroup

El contenedor de los datos de persona cargados, incluida la característica de reconocimiento facial, y hasta 1000 000 personas.

Nombre	Tipo	Description
largePersonGroupId	string	Identificador del contenedor.
name	string	Nombre definido por el usuario, la longitud máxima es 128.
recognitionModel	RecognitionModel	Nombre del modelo de reconocimiento. El modelo de reconocimiento se usa cuando se extraen las características faciales y se asocian a faceIds detectados.
userData	string	Datos opcionales definidos por el usuario. La longitud no debe superar los 16 000.

RecognitionModel

Modelo de reconocimiento para la cara.

Nombre	Tipo	Description
recognition_01	string	Modelo de reconocimiento predeterminado para "Detectar". Todos esos faceId creados antes de marzo de 2019 se unen con este modelo de reconocimiento.
recognition_02	string	Modelo de reconocimiento publicado en marzo de 2019.
recognition_03	string	Modelo de reconocimiento publicado en mayo de 2020.
recognition_04	string	Modelo de reconocimiento publicado en febrero de 2021. Se recomienda usar este modelo de reconocimiento para mejorar la precisión del reconocimiento.