Compartilhar via


Person Group Operations - Get Person Group Training Status

Para verificar o status de treinamento do Grupo de Pessoas concluído ou ainda em andamento. O treinamento do Grupo de Pessoas é uma operação assíncrona disparada pela API "Treinar Grupo de Pessoas".

GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/training

Parâmetros de URI

Nome Em Obrigatório Tipo Description
apiVersion
path True

string

Versão da API

endpoint
path True

string

uri

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

personGroupId
path True

string

ID do contêiner.

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

Respostas

Nome Tipo Description
200 OK

TrainingResult

Uma chamada bem-sucedida retorna o status de treinamento do 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 Active Directory

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

Escopos

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

Exemplos

Get Training Status of PersonGroup

Solicitação de exemplo

GET {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id/training

Resposta de exemplo

{
  "status": "notStarted",
  "createdDateTime": "2024-03-05T11:07:58.371Z",
  "lastActionDateTime": "2024-03-05T11:07:58.371Z",
  "lastSuccessfulTrainingDateTime": "2024-03-05T11:07:58.371Z",
  "message": null
}

Definições

Nome Description
FaceError

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

FaceErrorResponse

Uma resposta que contém detalhes do erro.

OperationStatus

O status da operação de execução prolongada.

TrainingResult

Resultado do treinamento de um contêiner

FaceError

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

Nome Tipo Description
code

string

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

message

string

Uma representação legível pelo ser humano do erro.

FaceErrorResponse

Uma resposta que contém detalhes do erro.

Nome Tipo Description
error

FaceError

O objeto de erro.

OperationStatus

O status da operação de execução prolongada.

Nome Tipo Description
failed

string

Falha na operação.

notStarted

string

A operação não foi iniciada.

running

string

A operação ainda está em execução.

succeeded

string

A operação foi bem-sucedida.

TrainingResult

Resultado do treinamento de um contêiner

Nome Tipo Description
createdDateTime

string

Uma cadeia de caracteres de data e hora UTC combinada que descreve a hora criada do grupo de pessoas, grupo de pessoas grandes ou grande lista de rostos.

lastActionDateTime

string

Uma cadeia de caracteres de data e hora UTC combinada que descreve a hora da última modificação do grupo de pessoas, grupo de pessoas grandes ou grande lista de rostos, pode ser valor nulo quando o grupo não é treinado com êxito.

lastSuccessfulTrainingDateTime

string

Uma cadeia de caracteres de data e hora UTC combinada que descreve a última hora de treinamento bem-sucedida do grupo de pessoas, grupo de pessoas grandes ou grande lista de rostos.

message

string

Mostrar mensagem de falha quando o treinamento falhou (omitido quando o treinamento foi bem-sucedido).

status

OperationStatus

Status de treinamento do contêiner.