@aws-sdk/client-rekognition 3.208.0 → 3.209.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -13
- package/dist-cjs/endpoint/ruleset.js +6 -6
- package/dist-cjs/models/models_0.js +63 -6
- package/dist-cjs/protocols/Aws_json1_1.js +138 -0
- package/dist-cjs/runtimeConfig.shared.js +2 -1
- package/dist-es/endpoint/ruleset.js +6 -6
- package/dist-es/models/models_0.js +47 -0
- package/dist-es/protocols/Aws_json1_1.js +138 -0
- package/dist-es/runtimeConfig.shared.js +2 -1
- package/dist-types/Rekognition.d.ts +226 -229
- package/dist-types/RekognitionClient.d.ts +4 -17
- package/dist-types/commands/CompareFacesCommand.d.ts +30 -41
- package/dist-types/commands/CreateCollectionCommand.d.ts +5 -3
- package/dist-types/commands/DeleteCollectionCommand.d.ts +3 -3
- package/dist-types/commands/DetectFacesCommand.d.ts +6 -10
- package/dist-types/commands/DetectLabelsCommand.d.ts +83 -38
- package/dist-types/commands/DetectModerationLabelsCommand.d.ts +8 -8
- package/dist-types/commands/DetectTextCommand.d.ts +4 -2
- package/dist-types/commands/GetCelebrityInfoCommand.d.ts +2 -2
- package/dist-types/commands/IndexFacesCommand.d.ts +22 -28
- package/dist-types/commands/ListCollectionsCommand.d.ts +7 -5
- package/dist-types/commands/ListFacesCommand.d.ts +6 -8
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -4
- package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +7 -10
- package/dist-types/commands/SearchFacesByImageCommand.d.ts +20 -29
- package/dist-types/commands/SearchFacesCommand.d.ts +7 -11
- package/dist-types/commands/TagResourceCommand.d.ts +5 -5
- package/dist-types/commands/UntagResourceCommand.d.ts +3 -4
- package/dist-types/models/models_0.d.ts +564 -320
- package/dist-types/runtimeConfig.shared.d.ts +2 -3
- package/dist-types/ts3.4/models/models_0.d.ts +96 -10
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -3
- package/package.json +11 -13
|
@@ -186,19 +186,13 @@ declare type RekognitionClientResolvedConfigType = __SmithyResolvedConfiguration
|
|
|
186
186
|
export interface RekognitionClientResolvedConfig extends RekognitionClientResolvedConfigType {
|
|
187
187
|
}
|
|
188
188
|
/**
|
|
189
|
-
* <p>This is the API Reference for <a href="https://docs.aws.amazon.com/rekognition/latest/dg/images.html">Amazon Rekognition Image</a>,
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
*
|
|
193
|
-
* It provides descriptions of actions, data types, common parameters,
|
|
194
|
-
* and common errors.</p>
|
|
195
|
-
*
|
|
189
|
+
* <p>This is the API Reference for <a href="https://docs.aws.amazon.com/rekognition/latest/dg/images.html">Amazon Rekognition Image</a>, <a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/what-is.html">Amazon Rekognition Custom Labels</a>,
|
|
190
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/video.html">Amazon Rekognition Stored
|
|
191
|
+
* Video</a>, <a href="https://docs.aws.amazon.com/rekognition/latest/dg/streaming-video.html">Amazon Rekognition Streaming Video</a>. It provides descriptions of actions, data types, common
|
|
192
|
+
* parameters, and common errors.</p>
|
|
196
193
|
* <p>
|
|
197
194
|
* <b>Amazon Rekognition Image</b>
|
|
198
195
|
* </p>
|
|
199
|
-
*
|
|
200
|
-
*
|
|
201
|
-
*
|
|
202
196
|
* <ul>
|
|
203
197
|
* <li>
|
|
204
198
|
* <p>
|
|
@@ -286,8 +280,6 @@ export interface RekognitionClientResolvedConfig extends RekognitionClientResolv
|
|
|
286
280
|
* </p>
|
|
287
281
|
* </li>
|
|
288
282
|
* </ul>
|
|
289
|
-
*
|
|
290
|
-
*
|
|
291
283
|
* <p>
|
|
292
284
|
* <b>Amazon Rekognition Custom Labels</b>
|
|
293
285
|
* </p>
|
|
@@ -393,12 +385,9 @@ export interface RekognitionClientResolvedConfig extends RekognitionClientResolv
|
|
|
393
385
|
* </p>
|
|
394
386
|
* </li>
|
|
395
387
|
* </ul>
|
|
396
|
-
*
|
|
397
|
-
*
|
|
398
388
|
* <p>
|
|
399
389
|
* <b>Amazon Rekognition Video Stored Video</b>
|
|
400
390
|
* </p>
|
|
401
|
-
*
|
|
402
391
|
* <ul>
|
|
403
392
|
* <li>
|
|
404
393
|
* <p>
|
|
@@ -481,11 +470,9 @@ export interface RekognitionClientResolvedConfig extends RekognitionClientResolv
|
|
|
481
470
|
* </p>
|
|
482
471
|
* </li>
|
|
483
472
|
* </ul>
|
|
484
|
-
*
|
|
485
473
|
* <p>
|
|
486
474
|
* <b>Amazon Rekognition Video Streaming Video</b>
|
|
487
475
|
* </p>
|
|
488
|
-
*
|
|
489
476
|
* <ul>
|
|
490
477
|
* <li>
|
|
491
478
|
* <p>
|
|
@@ -8,26 +8,19 @@ export interface CompareFacesCommandInput extends CompareFacesRequest {
|
|
|
8
8
|
export interface CompareFacesCommandOutput extends CompareFacesResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Compares a face in the <i>source</i> input image with
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* <p> If the source image contains multiple faces, the service detects the largest face
|
|
16
|
-
* and compares it with each face detected in the target image. </p>
|
|
17
|
-
*
|
|
18
|
-
*
|
|
11
|
+
* <p>Compares a face in the <i>source</i> input image with each of the 100
|
|
12
|
+
* largest faces detected in the <i>target</i> input image. </p>
|
|
13
|
+
* <p> If the source image contains multiple faces, the service detects the largest face and
|
|
14
|
+
* compares it with each face detected in the target image. </p>
|
|
19
15
|
* <note>
|
|
20
|
-
* <p>CompareFaces uses machine learning algorithms, which are probabilistic.
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
* validation before taking action.</p>
|
|
16
|
+
* <p>CompareFaces uses machine learning algorithms, which are probabilistic. A false negative
|
|
17
|
+
* is an incorrect prediction that a face in the target image has a low similarity confidence
|
|
18
|
+
* score when compared to the face in the source image. To reduce the probability of false
|
|
19
|
+
* negatives, we recommend that you compare the target image against multiple source images. If
|
|
20
|
+
* you plan to use <code>CompareFaces</code> to make a decision that impacts an individual's
|
|
21
|
+
* rights, privacy, or access to services, we recommend that you pass the result to a human for
|
|
22
|
+
* review and further validation before taking action.</p>
|
|
28
23
|
* </note>
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
24
|
* <p>You pass the input and target images either as base64-encoded image bytes or as
|
|
32
25
|
* references to images in an Amazon S3 bucket. If you use the
|
|
33
26
|
* AWS
|
|
@@ -38,39 +31,35 @@ export interface CompareFacesCommandOutput extends CompareFacesResponse, __Metad
|
|
|
38
31
|
* facial landmarks, pose details (pitch, roll, and yaw), quality (brightness and sharpness), and
|
|
39
32
|
* confidence value (indicating the level of confidence that the bounding box contains a face).
|
|
40
33
|
* The response also provides a similarity score, which indicates how closely the faces match. </p>
|
|
41
|
-
*
|
|
42
34
|
* <note>
|
|
43
35
|
* <p>By default, only faces with a similarity score of greater than or equal to 80% are
|
|
44
36
|
* returned in the response. You can change this value by specifying the
|
|
45
37
|
* <code>SimilarityThreshold</code> parameter.</p>
|
|
46
38
|
* </note>
|
|
47
|
-
*
|
|
48
39
|
* <p>
|
|
49
|
-
* <code>CompareFaces</code> also returns an array of faces that don't match the source
|
|
50
|
-
* For each face, it returns a bounding box, confidence value, landmarks, pose details,
|
|
51
|
-
*
|
|
52
|
-
* of the face and confidence value.</p>
|
|
53
|
-
*
|
|
40
|
+
* <code>CompareFaces</code> also returns an array of faces that don't match the source
|
|
41
|
+
* image. For each face, it returns a bounding box, confidence value, landmarks, pose details,
|
|
42
|
+
* and quality. The response also returns information about the face in the source image,
|
|
43
|
+
* including the bounding box of the face and confidence value.</p>
|
|
54
44
|
* <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces
|
|
55
|
-
* that don’t meet a required quality bar. The quality bar is based on a
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
* <p>If no faces are detected in the source or target images, <code>CompareFaces</code>
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
*
|
|
45
|
+
* that don’t meet a required quality bar. The quality bar is based on a variety of common use
|
|
46
|
+
* cases. Use <code>QualityFilter</code> to set the quality bar by specifying <code>LOW</code>,
|
|
47
|
+
* <code>MEDIUM</code>, or <code>HIGH</code>. If you do not want to filter detected faces,
|
|
48
|
+
* specify <code>NONE</code>. The default value is <code>NONE</code>. </p>
|
|
49
|
+
* <p>If the image doesn't contain Exif metadata, <code>CompareFaces</code> returns
|
|
50
|
+
* orientation information for the source and target images. Use these values to display the
|
|
51
|
+
* images with the correct image orientation.</p>
|
|
52
|
+
* <p>If no faces are detected in the source or target images, <code>CompareFaces</code>
|
|
53
|
+
* returns an <code>InvalidParameterException</code> error. </p>
|
|
66
54
|
* <note>
|
|
67
|
-
* <p> This is a stateless API operation. That is, data returned by this operation doesn't
|
|
55
|
+
* <p> This is a stateless API operation. That is, data returned by this operation doesn't
|
|
56
|
+
* persist.</p>
|
|
68
57
|
* </note>
|
|
69
58
|
*
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
* <p>This operation requires permissions to perform the
|
|
73
|
-
*
|
|
59
|
+
* <p>For an example, see Comparing Faces in Images in the Amazon Rekognition Developer
|
|
60
|
+
* Guide.</p>
|
|
61
|
+
* <p>This operation requires permissions to perform the
|
|
62
|
+
* <code>rekognition:CompareFaces</code> action.</p>
|
|
74
63
|
* @example
|
|
75
64
|
* Use a bare-bones client and the command you need to make an API call.
|
|
76
65
|
* ```javascript
|
|
@@ -14,13 +14,15 @@ export interface CreateCollectionCommandOutput extends CreateCollectionResponse,
|
|
|
14
14
|
* user can then index faces using the <code>IndexFaces</code> operation and persist results in a
|
|
15
15
|
* specific collection. Then, a user can search the collection for faces in the user-specific
|
|
16
16
|
* container. </p>
|
|
17
|
-
* <p>When you create a collection, it is associated with the latest version of the face model
|
|
17
|
+
* <p>When you create a collection, it is associated with the latest version of the face model
|
|
18
|
+
* version.</p>
|
|
18
19
|
* <note>
|
|
19
20
|
* <p>Collection names are case-sensitive.</p>
|
|
20
21
|
* </note>
|
|
21
|
-
*
|
|
22
22
|
* <p>This operation requires permissions to perform the
|
|
23
|
-
*
|
|
23
|
+
* <code>rekognition:CreateCollection</code> action. If you want to tag your collection, you
|
|
24
|
+
* also require permission to perform the <code>rekognition:TagResource</code>
|
|
25
|
+
* operation.</p>
|
|
24
26
|
* @example
|
|
25
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
28
|
* ```javascript
|
|
@@ -8,9 +8,9 @@ export interface DeleteCollectionCommandInput extends DeleteCollectionRequest {
|
|
|
8
8
|
export interface DeleteCollectionCommandOutput extends DeleteCollectionResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Deletes the specified collection. Note that this operation
|
|
12
|
-
*
|
|
13
|
-
*
|
|
11
|
+
* <p>Deletes the specified collection. Note that this operation removes all faces in the
|
|
12
|
+
* collection. For an example, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/delete-collection-procedure.html">Deleting a
|
|
13
|
+
* collection</a>.</p>
|
|
14
14
|
* <p>This operation requires permissions to perform the
|
|
15
15
|
* <code>rekognition:DeleteCollection</code> action.</p>
|
|
16
16
|
* @example
|
|
@@ -9,28 +9,24 @@ export interface DetectFacesCommandOutput extends DetectFacesResponse, __Metadat
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Detects faces within an image that is provided as input.</p>
|
|
12
|
-
*
|
|
13
12
|
* <p>
|
|
14
13
|
* <code>DetectFaces</code> detects the 100 largest faces in the image. For each face
|
|
15
14
|
* detected, the operation returns face details. These details include a bounding box of the
|
|
16
15
|
* face, a confidence value (that the bounding box contains a face), and a fixed set of
|
|
17
|
-
* attributes such as facial landmarks (for example, coordinates of eye and mouth),
|
|
18
|
-
*
|
|
16
|
+
* attributes such as facial landmarks (for example, coordinates of eye and mouth), presence of
|
|
17
|
+
* beard, sunglasses, and so on. </p>
|
|
19
18
|
* <p>The face-detection algorithm is most effective on frontal faces. For non-frontal or
|
|
20
19
|
* obscured faces, the algorithm might not detect the faces or might detect faces with lower
|
|
21
20
|
* confidence. </p>
|
|
22
21
|
* <p>You pass the input image either as base64-encoded image bytes or as a reference to an
|
|
23
|
-
* image in an Amazon S3 bucket. If you use the AWS CLI
|
|
24
|
-
*
|
|
25
|
-
* supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
26
|
-
*
|
|
22
|
+
* image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,
|
|
23
|
+
* passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
27
24
|
* <note>
|
|
28
25
|
* <p>This is a stateless API operation. That is, the operation does not persist any
|
|
29
26
|
* data.</p>
|
|
30
27
|
* </note>
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* <code>rekognition:DetectFaces</code> action. </p>
|
|
28
|
+
* <p>This operation requires permissions to perform the <code>rekognition:DetectFaces</code>
|
|
29
|
+
* action. </p>
|
|
34
30
|
* @example
|
|
35
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
32
|
* ```javascript
|
|
@@ -8,28 +8,93 @@ export interface DetectLabelsCommandInput extends DetectLabelsRequest {
|
|
|
8
8
|
export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Detects instances of real-world entities within an image (JPEG or PNG)
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* </p>
|
|
11
|
+
* <p>Detects instances of real-world entities within an image (JPEG or PNG) provided as
|
|
12
|
+
* input. This includes objects like flower, tree, and table; events like wedding, graduation,
|
|
13
|
+
* and birthday party; and concepts like landscape, evening, and nature. </p>
|
|
15
14
|
*
|
|
16
|
-
* <p>For an example, see Analyzing images stored in an Amazon S3 bucket in the
|
|
17
|
-
*
|
|
18
|
-
* <p>
|
|
19
|
-
* <code>DetectLabels</code> does not support the detection of activities. However, activity detection
|
|
20
|
-
* is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.</p>
|
|
21
|
-
* </note>
|
|
15
|
+
* <p>For an example, see Analyzing images stored in an Amazon S3 bucket in the
|
|
16
|
+
* Amazon Rekognition Developer Guide.</p>
|
|
22
17
|
*
|
|
23
18
|
* <p>You pass the input image as base64-encoded image bytes or as a reference to an image in
|
|
24
19
|
* an Amazon S3 bucket. If you use the
|
|
25
20
|
* AWS
|
|
26
21
|
* CLI to call Amazon Rekognition operations, passing image bytes is not
|
|
27
22
|
* supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
28
|
-
* <p>
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
23
|
+
* <p>
|
|
24
|
+
* <b>Optional Parameters</b>
|
|
25
|
+
* </p>
|
|
26
|
+
* <p>You can specify one or both of the <code>GENERAL_LABELS</code> and
|
|
27
|
+
* <code>IMAGE_PROPERTIES</code> feature types when calling the DetectLabels API. Including
|
|
28
|
+
* <code>GENERAL_LABELS</code> will ensure the response includes the labels detected in the
|
|
29
|
+
* input image, while including <code>IMAGE_PROPERTIES </code>will ensure the response includes
|
|
30
|
+
* information about the image quality and color.</p>
|
|
31
|
+
* <p>When using <code>GENERAL_LABELS</code> and/or <code>IMAGE_PROPERTIES</code> you can
|
|
32
|
+
* provide filtering criteria to the Settings parameter. You can filter with sets of individual
|
|
33
|
+
* labels or with label categories. You can specify inclusive filters, exclusive filters, or a
|
|
34
|
+
* combination of inclusive and exclusive filters. For more information on filtering see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/labels-detect-labels-image.html">Detecting
|
|
35
|
+
* Labels in an Image</a>.</p>
|
|
36
|
+
* <p>You can specify <code>MinConfidence</code> to control the confidence threshold for the
|
|
37
|
+
* labels returned. The default is 55%. You can also add the <code>MaxLabels</code> parameter to
|
|
38
|
+
* limit the number of labels returned. The default and upper limit is 1000 labels.</p>
|
|
39
|
+
* <p>
|
|
40
|
+
* <b>Response Elements</b>
|
|
41
|
+
* </p>
|
|
42
|
+
* <p> For each object, scene, and concept the API returns one or more labels. The API
|
|
43
|
+
* returns the following types of information regarding labels:</p>
|
|
44
|
+
* <ul>
|
|
45
|
+
* <li>
|
|
46
|
+
* <p> Name - The name of the detected label. </p>
|
|
47
|
+
* </li>
|
|
48
|
+
* <li>
|
|
49
|
+
* <p> Confidence - The level of confidence in the label assigned to a detected object.
|
|
50
|
+
* </p>
|
|
51
|
+
* </li>
|
|
52
|
+
* <li>
|
|
53
|
+
* <p> Parents - The ancestor labels for a detected label. DetectLabels returns a
|
|
54
|
+
* hierarchical taxonomy of detected labels. For example, a detected car might be assigned
|
|
55
|
+
* the label car. The label car has two parent labels: Vehicle (its parent) and
|
|
56
|
+
* Transportation (its grandparent). The response includes the all ancestors for a label,
|
|
57
|
+
* where every ancestor is a unique label. In the previous example, Car, Vehicle, and
|
|
58
|
+
* Transportation are returned as unique labels in the response. </p>
|
|
59
|
+
* </li>
|
|
60
|
+
* <li>
|
|
61
|
+
* <p> Aliases - Possible Aliases for the label. </p>
|
|
62
|
+
* </li>
|
|
63
|
+
* <li>
|
|
64
|
+
* <p> Categories - The label categories that the detected label belongs to. A given label
|
|
65
|
+
* can belong to more than one category. </p>
|
|
66
|
+
* </li>
|
|
67
|
+
* <li>
|
|
68
|
+
* <p> BoundingBox — Bounding boxes are described for all instances of detected common
|
|
69
|
+
* object labels, returned in an array of Instance objects. An Instance object contains a
|
|
70
|
+
* BoundingBox object, describing the location of the label on the input image. It also
|
|
71
|
+
* includes the confidence for the accuracy of the detected bounding box. </p>
|
|
72
|
+
* </li>
|
|
73
|
+
* </ul>
|
|
74
|
+
* <p> The API returns the following information regarding the image, as part of the
|
|
75
|
+
* ImageProperties structure:</p>
|
|
76
|
+
* <ul>
|
|
77
|
+
* <li>
|
|
78
|
+
* <p>Quality - Information about the Sharpness, Brightness, and Contrast of the input
|
|
79
|
+
* image, scored between 0 to 100. Image quality is returned for the entire image, as well as
|
|
80
|
+
* the background and the foreground. </p>
|
|
81
|
+
* </li>
|
|
82
|
+
* <li>
|
|
83
|
+
* <p>Dominant Color - An array of the dominant colors in the image. </p>
|
|
84
|
+
* </li>
|
|
85
|
+
* <li>
|
|
86
|
+
* <p>Foreground - Information about the Sharpness and Brightness of the input image’s
|
|
87
|
+
* foreground. </p>
|
|
88
|
+
* </li>
|
|
89
|
+
* <li>
|
|
90
|
+
* <p>Background - Information about the Sharpness and Brightness of the input image’s
|
|
91
|
+
* background.</p>
|
|
92
|
+
* </li>
|
|
93
|
+
* </ul>
|
|
94
|
+
* <p>The list of returned labels will include at least one label for every detected object,
|
|
95
|
+
* along with information about that label. In the following example, suppose the input image has
|
|
96
|
+
* a lighthouse, the sea, and a rock. The response includes all three labels, one for each
|
|
97
|
+
* object, as well as the confidence in the label:</p>
|
|
33
98
|
* <p>
|
|
34
99
|
* <code>{Name: lighthouse, Confidence: 98.4629}</code>
|
|
35
100
|
* </p>
|
|
@@ -39,10 +104,9 @@ export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __Metad
|
|
|
39
104
|
* <p>
|
|
40
105
|
* <code> {Name: sea,Confidence: 75.061}</code>
|
|
41
106
|
* </p>
|
|
42
|
-
* <p>
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
* the following three labels. </p>
|
|
107
|
+
* <p>The list of labels can include multiple labels for the same object. For example, if the
|
|
108
|
+
* input image shows a flower (for example, a tulip), the operation might return the following
|
|
109
|
+
* three labels. </p>
|
|
46
110
|
* <p>
|
|
47
111
|
* <code>{Name: flower,Confidence: 99.0562}</code>
|
|
48
112
|
* </p>
|
|
@@ -52,31 +116,12 @@ export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __Metad
|
|
|
52
116
|
* <p>
|
|
53
117
|
* <code>{Name: tulip,Confidence: 99.0562}</code>
|
|
54
118
|
* </p>
|
|
55
|
-
*
|
|
56
119
|
* <p>In this example, the detection algorithm more precisely identifies the flower as a
|
|
57
120
|
* tulip.</p>
|
|
58
|
-
* <p>In response, the API returns an array of labels. In addition, the response also
|
|
59
|
-
* includes the orientation correction. Optionally, you can specify <code>MinConfidence</code> to
|
|
60
|
-
* control the confidence threshold for the labels returned. The default is 55%. You can also add
|
|
61
|
-
* the <code>MaxLabels</code> parameter to limit the number of labels returned. </p>
|
|
62
121
|
* <note>
|
|
63
122
|
* <p>If the object detected is a person, the operation doesn't provide the same facial
|
|
64
123
|
* details that the <a>DetectFaces</a> operation provides.</p>
|
|
65
124
|
* </note>
|
|
66
|
-
* <p>
|
|
67
|
-
* <code>DetectLabels</code> returns bounding boxes for instances of common object labels in an array of
|
|
68
|
-
* <a>Instance</a> objects. An <code>Instance</code> object contains a
|
|
69
|
-
* <a>BoundingBox</a> object, for the location of the label on the image. It also includes
|
|
70
|
-
* the confidence by which the bounding box was detected.</p>
|
|
71
|
-
* <p>
|
|
72
|
-
* <code>DetectLabels</code> also returns a hierarchical taxonomy of detected labels. For example,
|
|
73
|
-
* a detected car might be assigned the label <i>car</i>. The label <i>car</i>
|
|
74
|
-
* has two parent labels: <i>Vehicle</i> (its parent) and <i>Transportation</i> (its
|
|
75
|
-
* grandparent).
|
|
76
|
-
* The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response.
|
|
77
|
-
* In the previous example, <i>Car</i>, <i>Vehicle</i>, and <i>Transportation</i>
|
|
78
|
-
* are returned as unique labels in the response.
|
|
79
|
-
* </p>
|
|
80
125
|
* <p>This is a stateless API operation. That is, the operation does not persist any
|
|
81
126
|
* data.</p>
|
|
82
127
|
* <p>This operation requires permissions to perform the
|
|
@@ -8,15 +8,15 @@ export interface DetectModerationLabelsCommandInput extends DetectModerationLabe
|
|
|
8
8
|
export interface DetectModerationLabelsCommandOutput extends DetectModerationLabelsResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Detects unsafe content in a specified JPEG or PNG format image.
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* <p>To filter images, use the labels returned by <code>DetectModerationLabels</code>
|
|
16
|
-
*
|
|
11
|
+
* <p>Detects unsafe content in a specified JPEG or PNG format image. Use
|
|
12
|
+
* <code>DetectModerationLabels</code> to moderate images depending on your requirements. For
|
|
13
|
+
* example, you might want to filter images that contain nudity, but not images containing
|
|
14
|
+
* suggestive content.</p>
|
|
15
|
+
* <p>To filter images, use the labels returned by <code>DetectModerationLabels</code> to
|
|
16
|
+
* determine which types of content are appropriate.</p>
|
|
17
17
|
*
|
|
18
|
-
* <p>For information about moderation labels,
|
|
19
|
-
*
|
|
18
|
+
* <p>For information about moderation labels, see Detecting Unsafe Content in the
|
|
19
|
+
* Amazon Rekognition Developer Guide.</p>
|
|
20
20
|
* <p>You pass the input image either as base64-encoded image bytes or as a reference to an
|
|
21
21
|
* image in an Amazon S3 bucket. If you use the
|
|
22
22
|
* AWS
|
|
@@ -27,9 +27,11 @@ export interface DetectTextCommandOutput extends DetectTextResponse, __MetadataB
|
|
|
27
27
|
* returns multiple lines.</p>
|
|
28
28
|
* <p>To determine whether a <code>TextDetection</code> element is a line of text or a word,
|
|
29
29
|
* use the <code>TextDetection</code> object <code>Type</code> field. </p>
|
|
30
|
-
* <p>To be detected, text must be within +/- 90 degrees orientation of the horizontal
|
|
30
|
+
* <p>To be detected, text must be within +/- 90 degrees orientation of the horizontal
|
|
31
|
+
* axis.</p>
|
|
31
32
|
*
|
|
32
|
-
* <p>For more information, see Detecting text in the Amazon Rekognition Developer
|
|
33
|
+
* <p>For more information, see Detecting text in the Amazon Rekognition Developer
|
|
34
|
+
* Guide.</p>
|
|
33
35
|
* @example
|
|
34
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
37
|
* ```javascript
|
|
@@ -12,8 +12,8 @@ export interface GetCelebrityInfoCommandOutput extends GetCelebrityInfoResponse,
|
|
|
12
12
|
* The additional information is returned as an array of URLs. If there is no additional
|
|
13
13
|
* information about the celebrity, this list is empty.</p>
|
|
14
14
|
*
|
|
15
|
-
* <p>For more information, see Getting information about a celebrity in
|
|
16
|
-
*
|
|
15
|
+
* <p>For more information, see Getting information about a celebrity in the
|
|
16
|
+
* Amazon Rekognition Developer Guide.</p>
|
|
17
17
|
* <p>This operation requires permissions to perform the
|
|
18
18
|
* <code>rekognition:GetCelebrityInfo</code> action. </p>
|
|
19
19
|
* @example
|
|
@@ -13,21 +13,19 @@ export interface IndexFacesCommandOutput extends IndexFacesResponse, __MetadataB
|
|
|
13
13
|
* detection algorithm first detects the faces in the input image. For each face, the algorithm
|
|
14
14
|
* extracts facial features into a feature vector, and stores it in the backend database.
|
|
15
15
|
* Amazon Rekognition uses feature vectors when it performs face match and search operations using the
|
|
16
|
-
* <a>SearchFaces</a> and <a>SearchFacesByImage</a>
|
|
17
|
-
* operations.</p>
|
|
16
|
+
* <a>SearchFaces</a> and <a>SearchFacesByImage</a> operations.</p>
|
|
18
17
|
*
|
|
19
18
|
* <p>For more information, see Adding faces to a collection in the Amazon Rekognition
|
|
20
19
|
* Developer Guide.</p>
|
|
21
20
|
* <p>To get the number of faces in a collection, call <a>DescribeCollection</a>. </p>
|
|
22
|
-
*
|
|
23
21
|
* <p>If you're using version 1.0 of the face detection model, <code>IndexFaces</code>
|
|
24
22
|
* indexes the 15 largest faces in the input image. Later versions of the face detection model
|
|
25
23
|
* index the 100 largest faces in the input image. </p>
|
|
26
|
-
* <p>If you're using version 4 or later of the face model, image orientation information
|
|
27
|
-
*
|
|
28
|
-
* <p>To determine which version of the model you're using, call <a>DescribeCollection</a>
|
|
29
|
-
*
|
|
30
|
-
*
|
|
24
|
+
* <p>If you're using version 4 or later of the face model, image orientation information is not
|
|
25
|
+
* returned in the <code>OrientationCorrection</code> field. </p>
|
|
26
|
+
* <p>To determine which version of the model you're using, call <a>DescribeCollection</a> and supply the collection ID. You can also get the model
|
|
27
|
+
* version from the value of <code>FaceModelVersion</code> in the response from
|
|
28
|
+
* <code>IndexFaces</code>
|
|
31
29
|
* </p>
|
|
32
30
|
*
|
|
33
31
|
* <p>For more information, see Model Versioning in the Amazon Rekognition Developer
|
|
@@ -37,23 +35,22 @@ export interface IndexFacesCommandOutput extends IndexFacesResponse, __MetadataB
|
|
|
37
35
|
* external image ID to create a client-side index to associate the faces with each image. You
|
|
38
36
|
* can then use the index to find all faces in an image.</p>
|
|
39
37
|
* <p>You can specify the maximum number of faces to index with the <code>MaxFaces</code> input
|
|
40
|
-
* parameter. This is useful when you want to index the largest faces in an image and don't want
|
|
41
|
-
* smaller faces, such as those belonging to people standing in the background.</p>
|
|
38
|
+
* parameter. This is useful when you want to index the largest faces in an image and don't want
|
|
39
|
+
* to index smaller faces, such as those belonging to people standing in the background.</p>
|
|
42
40
|
* <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces
|
|
43
|
-
* that don’t meet a required quality bar. The quality bar is based on a
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
* the quality bar
|
|
47
|
-
*
|
|
48
|
-
* If you do not want to filter detected faces, specify <code>NONE</code>. </p>
|
|
41
|
+
* that don’t meet a required quality bar. The quality bar is based on a variety of common use
|
|
42
|
+
* cases. By default, <code>IndexFaces</code> chooses the quality bar that's used to filter
|
|
43
|
+
* faces. You can also explicitly choose the quality bar. Use <code>QualityFilter</code>, to set
|
|
44
|
+
* the quality bar by specifying <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>. If
|
|
45
|
+
* you do not want to filter detected faces, specify <code>NONE</code>. </p>
|
|
49
46
|
* <note>
|
|
50
|
-
* <p>To use quality filtering, you need a collection associated with version 3 of the
|
|
51
|
-
*
|
|
52
|
-
*
|
|
47
|
+
* <p>To use quality filtering, you need a collection associated with version 3 of the face
|
|
48
|
+
* model or higher. To get the version of the face model associated with a collection, call
|
|
49
|
+
* <a>DescribeCollection</a>. </p>
|
|
53
50
|
* </note>
|
|
54
51
|
* <p>Information about faces detected in an image, but not indexed, is returned in an array of
|
|
55
|
-
*
|
|
56
|
-
*
|
|
52
|
+
* <a>UnindexedFace</a> objects, <code>UnindexedFaces</code>. Faces aren't indexed
|
|
53
|
+
* for reasons such as:</p>
|
|
57
54
|
* <ul>
|
|
58
55
|
* <li>
|
|
59
56
|
* <p>The number of faces detected exceeds the value of the <code>MaxFaces</code> request
|
|
@@ -75,8 +72,8 @@ export interface IndexFacesCommandOutput extends IndexFacesResponse, __MetadataB
|
|
|
75
72
|
* <p>The face doesn’t have enough detail to be suitable for face search.</p>
|
|
76
73
|
* </li>
|
|
77
74
|
* </ul>
|
|
78
|
-
* <p>In response, the <code>IndexFaces</code> operation returns an array of metadata for
|
|
79
|
-
*
|
|
75
|
+
* <p>In response, the <code>IndexFaces</code> operation returns an array of metadata for all
|
|
76
|
+
* detected faces, <code>FaceRecords</code>. This includes: </p>
|
|
80
77
|
* <ul>
|
|
81
78
|
* <li>
|
|
82
79
|
* <p>The bounding box, <code>BoundingBox</code>, of the detected face. </p>
|
|
@@ -95,14 +92,11 @@ export interface IndexFacesCommandOutput extends IndexFacesResponse, __MetadataB
|
|
|
95
92
|
* </ul>
|
|
96
93
|
* <p>If you request all facial attributes (by using the <code>detectionAttributes</code>
|
|
97
94
|
* parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for
|
|
98
|
-
* example, location of eye and mouth) and other facial attributes. If you provide
|
|
99
|
-
*
|
|
95
|
+
* example, location of eye and mouth) and other facial attributes. If you provide the same
|
|
96
|
+
* image, specify the same collection, and use the same external ID in the
|
|
100
97
|
* <code>IndexFaces</code> operation, Amazon Rekognition doesn't save duplicate face metadata.</p>
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
98
|
* <p></p>
|
|
104
99
|
*
|
|
105
|
-
*
|
|
106
100
|
* <p>The input image is passed either as base64-encoded image bytes, or as a reference to an
|
|
107
101
|
* image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,
|
|
108
102
|
* passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. </p>
|
|
@@ -8,12 +8,14 @@ export interface ListCollectionsCommandInput extends ListCollectionsRequest {
|
|
|
8
8
|
export interface ListCollectionsCommandOutput extends ListCollectionsResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Returns list of collection IDs in your account.
|
|
12
|
-
*
|
|
13
|
-
*
|
|
11
|
+
* <p>Returns list of collection IDs in your account. If the result is truncated, the
|
|
12
|
+
* response also provides a <code>NextToken</code> that you can use in the subsequent request to
|
|
13
|
+
* fetch the next set of collection IDs.</p>
|
|
14
14
|
*
|
|
15
|
-
* <p>For an example, see Listing collections in the Amazon Rekognition Developer
|
|
16
|
-
*
|
|
15
|
+
* <p>For an example, see Listing collections in the Amazon Rekognition Developer
|
|
16
|
+
* Guide.</p>
|
|
17
|
+
* <p>This operation requires permissions to perform the
|
|
18
|
+
* <code>rekognition:ListCollections</code> action.</p>
|
|
17
19
|
* @example
|
|
18
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
19
21
|
* ```javascript
|
|
@@ -8,14 +8,12 @@ export interface ListFacesCommandInput extends ListFacesRequest {
|
|
|
8
8
|
export interface ListFacesCommandOutput extends ListFacesResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Returns metadata for faces in the specified collection.
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
* <p>This operation requires permissions to perform the
|
|
18
|
-
* <code>rekognition:ListFaces</code> action.</p>
|
|
11
|
+
* <p>Returns metadata for faces in the specified collection. This metadata
|
|
12
|
+
* includes information such as the bounding box coordinates, the confidence (that the bounding
|
|
13
|
+
* box contains a face), and face ID. For an example, see Listing Faces in a Collection in the
|
|
14
|
+
* Amazon Rekognition Developer Guide.</p>
|
|
15
|
+
* <p>This operation requires permissions to perform the <code>rekognition:ListFaces</code>
|
|
16
|
+
* action.</p>
|
|
19
17
|
* @example
|
|
20
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
19
|
* ```javascript
|
|
@@ -8,11 +8,10 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ
|
|
|
8
8
|
export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>
|
|
12
|
-
*
|
|
13
|
-
* </p>
|
|
11
|
+
* <p> Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels
|
|
12
|
+
* model. </p>
|
|
14
13
|
* <p>This operation requires permissions to perform the
|
|
15
|
-
*
|
|
14
|
+
* <code>rekognition:ListTagsForResource</code> action. </p>
|
|
16
15
|
* @example
|
|
17
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
17
|
* ```javascript
|