Person Directory Operations - Update Dynamic Person Group With Person Changes

Serviço:

Azure AI Services

Versão da API:

v1.2-preview.1

Atualize o nome ou userData de um Grupo de Pessoas Dinâmicas existente e gerencie seus membros adicionando ou removendo pessoas.
As propriedades permanecerão inalteradas se não estiverem no corpo da solicitação.

PATCH {endpoint}/face/{apiVersion}/dynamicpersongroups/{dynamicPersonGroupId}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
apiVersion	path	True	string	Versão da API
dynamicPersonGroupId	path	True	string	ID do grupo de pessoas dinâmicas. Padrão Regex: ^[a-z0-9-_]+$
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).

Corpo da solicitação

Nome	Tipo	Description
addPersonIds	string[]	Matriz de personIds criadas pelo Diretório de Pessoas "Criar Pessoa" a ser adicionada.
name	string	Nome definido pelo usuário, o comprimento máximo é 128.
removePersonIds	string[]	Matriz de personIds criadas pelo Diretório de Pessoas "Criar Pessoa" a ser removida.
userData	string	Dados definidos pelo usuário opcionais. O comprimento não deve exceder 16 K.

Respostas

Nome	Tipo	Description
202 Accepted		Uma chamada bem-sucedida retorna um corpo de resposta vazio. O serviço aceitou a solicitação e começará a processar em breve. O cliente pode consultar o status da operação e resultar usando a URL especificada no cabeçalho de resposta 'Operation-Location'. A URL expira em 48 horas. A URL fornece o status de quando o Diretório de Pessoas "Obter Referências de Grupo de Pessoas Dinâmicas" retornará as alterações feitas nesta solicitação. Cabeçalhos operation-Location: string
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

Update DynamicPersonGroup

Solicitação de exemplo

HTTP

PATCH {endpoint}/face/v1.2-preview.1/dynamicpersongroups/your_dynamic_person_group_id

{
  "name": "your_dynamic_person_group_name",
  "userData": "your_user_data",
  "addPersonIds": [
    "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5"
  ],
  "removePersonIds": [
    "67f7e96d-823a-4318-9bf6-e9a2a2608899"
  ]
}

Resposta de exemplo

Código de status:

202

operation-Location: https://contoso.com/operationstatus

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.

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.