Update identify entity removed bounding box info #1484
Conversation
* Removing bound box info. If this info is worthy, we should have it in an appendix so it applies to all sections. * I was unable to test the portion around "match entities from a pre-created "Amazon Recognition Collection" -- does anyone have an example I can use? The documentation that we link to isn't very helpful in this context.
| ## Working with the API | ||
| In order to match entities from a pre-created [Amazon Rekognition Collection](https://docs.aws.amazon.com/rekognition/latest/dg/collections.html), make sure there is a `collectionId` set in your `amplifyconfiguration.json` file. If there is no `collectionId` set in the `amplifyconfiguration.json` file, then this call will just detect entities in general with facial features, landmarks, etc. Bounding boxes for entities are returned as ratios so make sure if you would like to place the bounding box of your entity on an image that you multiple the x by the width of the image, the y by the width of the image, and both height and width ratios by the image's respective height and width. | ||
| In order to match entities from a pre-created [Amazon Rekognition Collection](https://docs.aws.amazon.com/rekognition/latest/dg/collections.html), make sure there is a `collectionId` set in your `amplifyconfiguration.json` file. If there is no `collectionId` set in the `amplifyconfiguration.json` file, then this call will just detect entities in general with facial features, landmarks, etc. |
There was a problem hiding this comment.
This part was totally confusing --anyone have any example i can use, and then i can work on rewriting it?
There was a problem hiding this comment.
After about 1-2 hours of troubleshooting and reading through docs, I was unable to get this portion to work.
I went through instructions of creating a collection, adding a face to a collection, creating a s3 bucket, creating a user with the right permissions specifying the configuration in my amplifyconfiguration.json, but in all cases, I can not get this to work.
In all cases, the calls to identify resolved to a IdentifyEntitiesResult rather than the expected IdentifyEntityMatchesResult.
Couple options:
-
Just change the example to only return "IdentifyEntitiesResult", and don't take users through the
IdentifyEntityMatchesResultas this has a more involved setup. -
Have the original devs look into this and update documentation appropriately.
-
Something else?
There was a problem hiding this comment.
I vote #1 for now. We should create a bug in the backlog for the IdentifyEntityMatchesResult path and add documentation somewhere later in the document. That documentation should be far clearer about how to set this up (i.e., show me how to set a collectionId rather than telling me it should be set. Set where?)
There was a problem hiding this comment.
@jpignata -- sorry for the delay, Sounds good, i'll update the document! To make sure this gets addressed, i created a ticket in pivotal tracker.
| ## Working with the API | ||
| In order to match entities from a pre-created [Amazon Rekognition Collection](https://docs.aws.amazon.com/rekognition/latest/dg/collections.html), make sure there is a `collectionId` set in your `amplifyconfiguration.json` file. If there is no `collectionId` set in the `amplifyconfiguration.json` file, then this call will just detect entities in general with facial features, landmarks, etc. Bounding boxes for entities are returned as ratios so make sure if you would like to place the bounding box of your entity on an image that you multiple the x by the width of the image, the y by the width of the image, and both height and width ratios by the image's respective height and width. | ||
| In order to match entities from a pre-created [Amazon Rekognition Collection](https://docs.aws.amazon.com/rekognition/latest/dg/collections.html), make sure there is a `collectionId` set in your `amplifyconfiguration.json` file. If there is no `collectionId` set in the `amplifyconfiguration.json` file, then this call will just detect entities in general with facial features, landmarks, etc. |
There was a problem hiding this comment.
I vote #1 for now. We should create a bug in the backlog for the IdentifyEntityMatchesResult path and add documentation somewhere later in the document. That documentation should be far clearer about how to set this up (i.e., show me how to set a collectionId rather than telling me it should be set. Set where?)
4 participants
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.