Person Directory - Update Dynamic Person Group

Serviço:

Azure AI Services

Versão da API:

1.0-preview

Atualiza um grupo dinâmico de pessoas existente com dynamicPersonGroupId, nome e userData fornecidos pelo usuário.

PATCH {Endpoint}/face/v1.0-preview/dynamicpersongroups/{dynamicPersonGroupId}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
dynamicPersonGroupId	path	True	string	Id do grupo dinâmico de pessoas fornecido pelo usuário.
Endpoint	path	True	string	Pontos de extremidade de Serviços Cognitivos suportados (protocolo e nome do host, por exemplo: https://westus.api.cognitive.microsoft.com).

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo do Pedido

Name	Tipo	Description
addPersonIds	string[] (uuid)	IDs de pessoa para adicionar ao grupo dinâmico de pessoas.
name	string	Nome definido pelo usuário, comprimento máximo é 128.
removePersonIds	string[]	IDs de pessoa a serem removidas do grupo dinâmico de pessoas.
userData	string	Dados especificados pelo usuário. O comprimento não deve exceder 16KB.

Respostas

Name	Tipo	Description
202 Accepted		Sucesso Cabeçalhos Operation-Location: string
Other Status Codes	Error	Entidade de resposta que acompanha respostas não bem-sucedidas contendo detalhes adicionais sobre o erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Update dynamic person group example

Pedido de amostra

HTTP

PATCH {Endpoint}/face/v1.0-preview/dynamicpersongroups/abc


{
  "name": "Display Name of Dynamic Person Group",
  "userData": "User-provided data attached to the dynamic person group.",
  "addPersonIds": [
    "25985303-c537-4467-b41d-bdb45cd95ca1",
    "4caa25ee-3bc6-4e88-adf8-12455ce7aab0"
  ],
  "removePersonIds": [
    "2ae4935b-9659-44c3-977f-61fac20d0538"
  ]
}

Resposta da amostra

Código de estado:

202

Definições

Name	Description
DynamicPersonGroupUpdateRequest
Error	Corpo do erro.

DynamicPersonGroupUpdateRequest

Object

Name	Tipo	Description
addPersonIds	string[] (uuid)	IDs de pessoa para adicionar ao grupo dinâmico de pessoas.
name	string	Nome definido pelo usuário, comprimento máximo é 128.
removePersonIds	string[]	IDs de pessoa a serem removidas do grupo dinâmico de pessoas.
userData	string	Dados especificados pelo usuário. O comprimento não deve exceder 16KB.

Error

Object

Corpo do erro.

Name	Tipo	Description
code	string
message	string