Gerenciamento de Collection (1:N) no Oz API

Este artigo descreve como criar uma coleção via API, como adicionar pessoas e fotos a esta coleção e como excluí-las e à própria coleção se você não precisar mais dela. É possível fazer o mesmo no Web console, mas este artigo cobre apenas métodos da API.

Collection em Oz API é um banco de dados de fotos faciais que são usadas para comparar com o rosto da foto ou do vídeo capturado por meio da análise de COLLECTION

Person representa um ser humano na coleção. É possível enviar várias fotos para uma única pessoa.

Como Criar uma Coleção

A coleção deve ser criada dentro de uma empresa, então você precisa do ID da sua empresa company_id como pré-requisito.

Se você não souber seu ID, chame GET /api/companies/?search_text=test, substituindo "test" pelo nome da sua empresa ou parte dele. Salve o company_id que você recebeu.

Agora, crie uma coleção via POST /api/collections/. No corpo da requisição, especifique o alias da sua coleção e o company_id da sua empresa:

{
  "alias": "your_collection",
  "company_id": "your_company_id"
}

Na resposta, você receberá o identificador da sua nova coleção: collection_id.

Como Adicionar uma Pessoa ou uma Foto a uma Coleção

Para adicionar uma nova pessoa à sua coleção, chame POST /api/collections/{{collection_id}}/persons/, usando collection_id da coleção necessária. No corpo da requisição, adicione uma foto ou várias fotos. Marque-as com as tags nos dados enviados:

{
    "media:tags": {
        "image1": [
            "photo_selfie",
            "orientation_portrait"
        ]
    }
}

A resposta conterá o person_id que representa o identificador da pessoa dentro da sua coleção.

Se você quiser adicionar um nome da pessoa, no payload da requisição, adicione-o como meta_data:

    "person:meta_data": {
        "person_info": {
            "first_name": "John",
            "middle_name": "Jameson",
            "last_name": "Doe"
        }
    },

Para adicionar mais fotos da mesma pessoa, chame POST {{host}}/api/collections/{{collection_id}}/persons/{{person_id}}/images/ usando o apropriado person_id. O corpo da requisição deve ser preenchido como você fez antes com POST /api/collections/{{collection_id}}/persons/.

Para obter informações sobre todas as pessoas dentro de uma única coleção, chame GET /api/collections/{{collection_id}}/persons/.

Para obter uma lista de fotos de uma única pessoa, chame GET /api/collections/{{collection_id}}/persons/{{person_id}}/images/. Para cada foto, a resposta conteráperson_image_id. Você precisará deste ID, por exemplo, se quiser excluir a foto.

Como Remover uma Foto ou uma Pessoa de uma Coleção

Para excluir uma pessoa com todas as suas fotos, chame DELETE /api/collections/{{collection_id}}/persons/{{person_id}} com os identificadores apropriados de coleção e pessoa. Todas as fotos serão excluídas automaticamente. No entanto, não é possível excluir uma entidade pessoa se ela tiver alguma análise relacionada, o que significa que a análise de COLLECTION usou esta foto para comparação e encontrou uma correspondência. Para excluir essa pessoa, será necessário excluir essas análises usando DELETE /api/analyses/{{analysis_id}} com analysis_id da análise de COLLECTION (1:N).

Para excluir todas as análises relacionadas à coleção, obtenha uma lista de pastas nas quais a análise de COLLECTION foi usada: chame GET /api/folders/?analyse.type=COLLECTION. Para cada pasta desta lista (GET /api/folders/{{folder_id}}/), encontre o analysis_id da análise necessária e exclua a análise – DELETE /api/analyses/{{analysis_id}}.

Para excluir uma única foto de uma pessoa, chame DELETE collections/<collection_id>/persons/<person_id>/images/<media_id>/ com os identificadores de coleção, pessoa e imagem especificados.

Como Excluir uma Coleção

Exclua as informações de todas as pessoas desta coleção conforme descrito acima e, em seguida, chame DELETE /api/collections/{{collection_id}}/ para excluir os dados restantes da coleção.