PersonGroups Interface

Pacote:

com.microsoft.azure.cognitiveservices.vision.faceapi

public interface PersonGroups

Uma instância dessa classe fornece acesso a todas as operações definidas em PersonGroups.

Resumo do método

Modificador e tipo	Método e descrição
PersonGroupsCreateDefinitionStages.WithPersonGroupId	create() Crie um novo grupo de pessoas com personGroupId, nome e userData fornecidos pelo usuário especificados.
void	create(String personGroupId, CreatePersonGroupsOptionalParameter createOptionalParameter) Crie um novo grupo de pessoas com personGroupId, nome e userData fornecidos pelo usuário especificados.
Observable<Void>	createAsync(String personGroupId, CreatePersonGroupsOptionalParameter createOptionalParameter) Crie um novo grupo de pessoas com personGroupId, nome e userData fornecidos pelo usuário especificados.
void	delete(String personGroupId) Exclua um grupo de pessoas existente. As imagens faciais persistentes de todas as pessoas no grupo de pessoas também serão excluídas.
Observable<Void>	deleteAsync(String personGroupId) Exclua um grupo de pessoas existente. As imagens faciais persistentes de todas as pessoas no grupo de pessoas também serão excluídas.
PersonGroup	get(String personGroupId) Recupere as informações de um grupo de pessoas, incluindo seu nome e userData.
Observable<PersonGroup>	getAsync(String personGroupId) Recupere as informações de um grupo de pessoas, incluindo seu nome e userData.
TrainingStatus	getTrainingStatus(String personGroupId) Recupere o status de treinamento de um grupo de pessoas (concluído ou em andamento).
Observable<TrainingStatus>	getTrainingStatusAsync(String personGroupId) Recupere o status de treinamento de um grupo de pessoas (concluído ou em andamento).
PersonGroupsListDefinitionStages.WithExecute	list() Listar grupos de pessoas e suas informações.
List<PersonGroup>	list(ListPersonGroupsOptionalParameter listOptionalParameter) Listar grupos de pessoas e suas informações.
Observable<List<PersonGroup>>	listAsync(ListPersonGroupsOptionalParameter listOptionalParameter) Listar grupos de pessoas e suas informações.
void	train(String personGroupId) Enfileirar uma tarefa de treinamento de grupo de pessoas, a tarefa de treinamento pode não ser iniciada imediatamente.
Observable<Void>	trainAsync(String personGroupId) Enfileirar uma tarefa de treinamento de grupo de pessoas, a tarefa de treinamento pode não ser iniciada imediatamente.
PersonGroupsUpdateDefinitionStages.WithPersonGroupId	update() Atualize o nome de exibição e o userData de um grupo de pessoas existentes. As propriedades que não aparecem no corpo da solicitação não serão atualizadas.
void	update(String personGroupId, UpdatePersonGroupsOptionalParameter updateOptionalParameter) Atualize o nome de exibição e o userData de um grupo de pessoas existentes. As propriedades que não aparecem no corpo da solicitação não serão atualizadas.
Observable<Void>	updateAsync(String personGroupId, UpdatePersonGroupsOptionalParameter updateOptionalParameter) Atualize o nome de exibição e o userData de um grupo de pessoas existentes. As propriedades que não aparecem no corpo da solicitação não serão atualizadas.

Detalhes do método

create

public PersonGroupsCreateDefinitionStages.WithPersonGroupId create()

Crie um novo grupo de pessoas com personGroupId, nome e userData fornecidos pelo usuário especificados.

Returns:

o primeiro estágio da chamada de criação

create

public void create(String personGroupId, CreatePersonGroupsOptionalParameter createOptionalParameter)

Crie um novo grupo de pessoas com personGroupId, nome e userData fornecidos pelo usuário especificados.

Parameters:

personGroupId - ID que faz referência a um grupo de pessoas específico.

createOptionalParameter - o objeto que representa os parâmetros opcionais a serem definidos antes de chamar essa API

Throws:

IllegalArgumentException - gerado se os parâmetros falharem na validação

APIErrorException - gerado se a solicitação for rejeitada pelo servidor

RuntimeException - todas as outras exceções verificadas encapsuladas se a solicitação não for enviada

createAsync

public Observable createAsync(String personGroupId, CreatePersonGroupsOptionalParameter createOptionalParameter)

Crie um novo grupo de pessoas com personGroupId, nome e userData fornecidos pelo usuário especificados.

Parameters:

personGroupId - ID que faz referência a um grupo de pessoas específico.

createOptionalParameter - o objeto que representa os parâmetros opcionais a serem definidos antes de chamar essa API

Returns:

uma representação da computação adiada dessa chamada, se bem-sucedida.

Throws:

IllegalArgumentException - gerado se os parâmetros falharem na validação

delete

public void delete(String personGroupId)

Exclua um grupo de pessoas existente. As imagens faciais persistentes de todas as pessoas no grupo de pessoas também serão excluídas.

Parameters:

personGroupId - ID que faz referência a um grupo de pessoas específico.

Throws:

IllegalArgumentException - gerado se os parâmetros falharem na validação

APIErrorException - gerado se a solicitação for rejeitada pelo servidor

RuntimeException - todas as outras exceções verificadas encapsuladas se a solicitação não for enviada

deleteAsync

public Observable deleteAsync(String personGroupId)

Exclua um grupo de pessoas existente. As imagens faciais persistentes de todas as pessoas no grupo de pessoas também serão excluídas.

Parameters:

personGroupId - ID que faz referência a um grupo de pessoas específico.

Returns:

uma representação da computação adiada dessa chamada, se bem-sucedida.

Throws:

IllegalArgumentException - gerado se os parâmetros falharem na validação

get

public PersonGroup get(String personGroupId)

Recupere as informações de um grupo de pessoas, incluindo seu nome e userData.

Parameters:

personGroupId - ID que faz referência a um grupo de pessoas específico.

Returns:

o objeto PersonGroup se tiver êxito.

Throws:

IllegalArgumentException - gerado se os parâmetros falharem na validação

APIErrorException - gerado se a solicitação for rejeitada pelo servidor

RuntimeException - todas as outras exceções verificadas encapsuladas se a solicitação não for enviada

getAsync

public Observable getAsync(String personGroupId)

Recupere as informações de um grupo de pessoas, incluindo seu nome e userData.

Parameters:

personGroupId - ID que faz referência a um grupo de pessoas específico.

Returns:

o observável para o objeto PersonGroup

Throws:

IllegalArgumentException - gerado se os parâmetros falharem na validação

getTrainingStatus

public TrainingStatus getTrainingStatus(String personGroupId)

Recupere o status de treinamento de um grupo de pessoas (concluído ou em andamento).

Parameters:

personGroupId - ID que faz referência a um grupo de pessoas específico.

Returns:

o objeto TrainingStatus se tiver êxito.

Throws:

IllegalArgumentException - gerado se os parâmetros falharem na validação

APIErrorException - gerado se a solicitação for rejeitada pelo servidor

RuntimeException - todas as outras exceções verificadas encapsuladas se a solicitação não for enviada

getTrainingStatusAsync

public Observable getTrainingStatusAsync(String personGroupId)

Recupere o status de treinamento de um grupo de pessoas (concluído ou em andamento).

Parameters:

personGroupId - ID que faz referência a um grupo de pessoas específico.

Returns:

o observável para o objeto TrainingStatus

Throws:

IllegalArgumentException - gerado se os parâmetros falharem na validação

list

public PersonGroupsListDefinitionStages.WithExecute list()

Listar grupos de pessoas e suas informações.

Returns:

o primeiro estágio da chamada de lista

list

public List list(ListPersonGroupsOptionalParameter listOptionalParameter)

Listar grupos de pessoas e suas informações.

Parameters:

listOptionalParameter - o objeto que representa os parâmetros opcionais a serem definidos antes de chamar essa API

Returns:

o objeto List<PersonGroup> se tiver êxito.

Throws:

IllegalArgumentException - gerado se os parâmetros falharem na validação

APIErrorException - gerado se a solicitação for rejeitada pelo servidor

RuntimeException - todas as outras exceções verificadas encapsuladas se a solicitação não for enviada

listAsync

public Observable> listAsync(ListPersonGroupsOptionalParameter listOptionalParameter)

Listar grupos de pessoas e suas informações.

Parameters:

listOptionalParameter - o objeto que representa os parâmetros opcionais a serem definidos antes de chamar essa API

Returns:

o observável para o objeto List<PersonGroup>

Throws:

IllegalArgumentException - gerado se os parâmetros falharem na validação

train

public void train(String personGroupId)

Enfileirar uma tarefa de treinamento de grupo de pessoas, a tarefa de treinamento pode não ser iniciada imediatamente.

Parameters:

personGroupId - ID que faz referência a um grupo de pessoas específico.

Throws:

IllegalArgumentException - gerado se os parâmetros falharem na validação

APIErrorException - gerado se a solicitação for rejeitada pelo servidor

RuntimeException - todas as outras exceções verificadas encapsuladas se a solicitação não for enviada

trainAsync

public Observable trainAsync(String personGroupId)

Enfileirar uma tarefa de treinamento de grupo de pessoas, a tarefa de treinamento pode não ser iniciada imediatamente.

Parameters:

personGroupId - ID que faz referência a um grupo de pessoas específico.

Returns:

uma representação da computação adiada dessa chamada, se bem-sucedida.

Throws:

IllegalArgumentException - gerado se os parâmetros falharem na validação

update

public PersonGroupsUpdateDefinitionStages.WithPersonGroupId update()

Atualize o nome de exibição e o userData de um grupo de pessoas existentes. As propriedades que não aparecem no corpo da solicitação não serão atualizadas.

Returns:

o primeiro estágio da chamada de atualização

update

public void update(String personGroupId, UpdatePersonGroupsOptionalParameter updateOptionalParameter)

Atualize o nome de exibição e o userData de um grupo de pessoas existentes. As propriedades que não aparecem no corpo da solicitação não serão atualizadas.

Parameters:

personGroupId - ID que faz referência a um grupo de pessoas específico.

updateOptionalParameter - o objeto que representa os parâmetros opcionais a serem definidos antes de chamar essa API

Throws:

IllegalArgumentException - gerado se os parâmetros falharem na validação

APIErrorException - gerado se a solicitação for rejeitada pelo servidor

RuntimeException - todas as outras exceções verificadas encapsuladas se a solicitação não for enviada

updateAsync

public Observable updateAsync(String personGroupId, UpdatePersonGroupsOptionalParameter updateOptionalParameter)

Atualize o nome de exibição e o userData de um grupo de pessoas existentes. As propriedades que não aparecem no corpo da solicitação não serão atualizadas.

Parameters:

personGroupId - ID que faz referência a um grupo de pessoas específico.

updateOptionalParameter - o objeto que representa os parâmetros opcionais a serem definidos antes de chamar essa API

Returns:

uma representação da computação adiada dessa chamada, se bem-sucedida.

Throws:

IllegalArgumentException - gerado se os parâmetros falharem na validação