Cogniac / cogniac-sdk-py

Python SDK for Cogniac Public API
Apache License 2.0
5 stars 6 forks source link

Add new `reviewers` field to application object in support of upcoming feedback revisions. #93

Closed ah-cog closed 3 years ago

ah-cog commented 3 years ago

This field is being added to support the addition of an application reviewer assignment feature, which allows an application manager to assign specific Cogniac users as a reviewer of an application, which is a user that can provide "feedback" (e.g., bounding boxes and labels in the case of the box detection application type).

Assigned application reviewers must be assigned one of the two currently-supported application reviewer roles: (1) "reviewer", or (2) "annotator".

Users can be assigned as application reviewers by adding them into the reviewers field (list) in the application object at application creation time or by updating the application. For example, to update an application to assign a reviewer with the "reviewer" role:

POST /1/applications/{application_id}

{
    "reviewers": [
        {
            "user_email": "tenant.user@domain.com",
            "role": "reviewer"
        }
    ]
}

Note, "reviewer" could be replaced with "annotator" in the above example to assign the application reviewer with the annotator role.

Notes: