@aws-sdk/client-rekognition 3.204.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 +34 -36
|
@@ -8,14 +8,13 @@ export interface RecognizeCelebritiesCommandInput extends RecognizeCelebritiesRe
|
|
|
8
8
|
export interface RecognizeCelebritiesCommandOutput extends RecognizeCelebritiesResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Returns an array of celebrities recognized in the input image.
|
|
12
|
-
*
|
|
11
|
+
* <p>Returns an array of celebrities recognized in the input image. For more
|
|
12
|
+
* information, see Recognizing celebrities in the Amazon Rekognition Developer Guide. </p>
|
|
13
13
|
* <p>
|
|
14
|
-
* <code>RecognizeCelebrities</code> returns the 64 largest faces in the image. It lists
|
|
15
|
-
* recognized celebrities in the <code>CelebrityFaces</code> array and any unrecognized faces
|
|
16
|
-
* the <code>UnrecognizedFaces</code> array. <code>RecognizeCelebrities</code> doesn't return
|
|
14
|
+
* <code>RecognizeCelebrities</code> returns the 64 largest faces in the image. It lists
|
|
15
|
+
* the recognized celebrities in the <code>CelebrityFaces</code> array and any unrecognized faces
|
|
16
|
+
* in the <code>UnrecognizedFaces</code> array. <code>RecognizeCelebrities</code> doesn't return
|
|
17
17
|
* celebrities whose faces aren't among the largest 64 faces in the image.</p>
|
|
18
|
-
*
|
|
19
18
|
* <p>For each celebrity recognized, <code>RecognizeCelebrities</code> returns a
|
|
20
19
|
* <code>Celebrity</code> object. The <code>Celebrity</code> object contains the celebrity
|
|
21
20
|
* name, ID, URL links to additional information, match confidence, and a
|
|
@@ -33,10 +32,8 @@ export interface RecognizeCelebritiesCommandOutput extends RecognizeCelebritiesR
|
|
|
33
32
|
* CLI to call Amazon Rekognition operations, passing image bytes is not
|
|
34
33
|
* supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
35
34
|
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
* <p>For an example, see Recognizing celebrities in an image in the Amazon Rekognition Developer Guide.</p>
|
|
35
|
+
* <p>For an example, see Recognizing celebrities in an image in the Amazon Rekognition
|
|
36
|
+
* Developer Guide.</p>
|
|
40
37
|
* <p>This operation requires permissions to perform the
|
|
41
38
|
* <code>rekognition:RecognizeCelebrities</code> operation.</p>
|
|
42
39
|
* @example
|
|
@@ -12,49 +12,40 @@ export interface SearchFacesByImageCommandOutput extends SearchFacesByImageRespo
|
|
|
12
12
|
* the specified collection for matching faces. The operation compares the features of the input
|
|
13
13
|
* face with faces in the specified collection. </p>
|
|
14
14
|
* <note>
|
|
15
|
-
* <p>To search for all faces in an input image, you might first call the <a>IndexFaces</a> operation, and then use the face IDs returned in subsequent
|
|
16
|
-
*
|
|
15
|
+
* <p>To search for all faces in an input image, you might first call the <a>IndexFaces</a> operation, and then use the face IDs returned in subsequent calls
|
|
16
|
+
* to the <a>SearchFaces</a> operation. </p>
|
|
17
17
|
* <p> You can also call the <code>DetectFaces</code> operation and use the bounding boxes
|
|
18
18
|
* in the response to make face crops, which then you can pass in to the
|
|
19
19
|
* <code>SearchFacesByImage</code> operation. </p>
|
|
20
20
|
* </note>
|
|
21
|
-
*
|
|
22
21
|
* <p>You pass the input image either as base64-encoded image bytes or as a reference to an
|
|
23
22
|
* image in an Amazon S3 bucket. If you use the
|
|
24
23
|
* AWS
|
|
25
24
|
* CLI to call Amazon Rekognition operations, passing image bytes is not
|
|
26
25
|
* supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
27
|
-
* <p>
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
* In the response, the operation also returns the bounding
|
|
35
|
-
* box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition
|
|
36
|
-
* used for the input image.
|
|
37
|
-
* </p>
|
|
26
|
+
* <p> The response returns an array of faces that match, ordered by similarity score with
|
|
27
|
+
* the highest similarity first. More specifically, it is an array of metadata for each face
|
|
28
|
+
* match found. Along with the metadata, the response also includes a <code>similarity</code>
|
|
29
|
+
* indicating how similar the face is to the input face. In the response, the operation also
|
|
30
|
+
* returns the bounding box (and a confidence level that the bounding box contains a face) of the
|
|
31
|
+
* face that Amazon Rekognition used for the input image. </p>
|
|
38
32
|
* <p>If no faces are detected in the input image, <code>SearchFacesByImage</code> returns an
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
* <p>For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.</p>
|
|
33
|
+
* <code>InvalidParameterException</code> error. </p>
|
|
42
34
|
*
|
|
35
|
+
* <p>For an example, Searching for a Face Using an Image in the Amazon Rekognition
|
|
36
|
+
* Developer Guide.</p>
|
|
43
37
|
* <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces
|
|
44
|
-
* that don’t meet a required quality bar. The quality bar is based on a
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
* If you do not want to filter detected faces, specify <code>NONE</code>. The default
|
|
49
|
-
* value is <code>NONE</code>.</p>
|
|
38
|
+
* that don’t meet a required quality bar. The quality bar is based on a variety of common use
|
|
39
|
+
* cases. Use <code>QualityFilter</code> to set the quality bar for filtering by specifying
|
|
40
|
+
* <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>. If you do not want to filter
|
|
41
|
+
* detected faces, specify <code>NONE</code>. The default value is <code>NONE</code>.</p>
|
|
50
42
|
* <note>
|
|
51
|
-
* <p>To use quality filtering, you need a collection associated with version 3 of the
|
|
52
|
-
*
|
|
53
|
-
*
|
|
43
|
+
* <p>To use quality filtering, you need a collection associated with version 3 of the face
|
|
44
|
+
* model or higher. To get the version of the face model associated with a collection, call
|
|
45
|
+
* <a>DescribeCollection</a>. </p>
|
|
54
46
|
* </note>
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
* action.</p>
|
|
47
|
+
* <p>This operation requires permissions to perform the
|
|
48
|
+
* <code>rekognition:SearchFacesByImage</code> action.</p>
|
|
58
49
|
* @example
|
|
59
50
|
* Use a bare-bones client and the command you need to make an API call.
|
|
60
51
|
* ```javascript
|
|
@@ -15,18 +15,14 @@ export interface SearchFacesCommandOutput extends SearchFacesResponse, __Metadat
|
|
|
15
15
|
* <p>You can also search faces without indexing faces by using the
|
|
16
16
|
* <code>SearchFacesByImage</code> operation.</p>
|
|
17
17
|
* </note>
|
|
18
|
+
* <p> The operation response returns an array of faces that match, ordered by similarity
|
|
19
|
+
* score with the highest similarity first. More specifically, it is an array of metadata for
|
|
20
|
+
* each face match that is found. Along with the metadata, the response also includes a
|
|
21
|
+
* <code>confidence</code> value for each face match, indicating the confidence that the
|
|
22
|
+
* specific face matches the input face. </p>
|
|
18
23
|
*
|
|
19
|
-
* <p>
|
|
20
|
-
*
|
|
21
|
-
* an array of faces that match, ordered by similarity score with the highest
|
|
22
|
-
* similarity first. More specifically, it is an
|
|
23
|
-
* array of metadata for each face match that is found. Along with the metadata, the response also
|
|
24
|
-
* includes a <code>confidence</code> value for each face match, indicating the confidence
|
|
25
|
-
* that the specific face matches the input face.
|
|
26
|
-
* </p>
|
|
27
|
-
*
|
|
28
|
-
* <p>For an example, see Searching for a face using its face ID in the Amazon Rekognition Developer Guide.</p>
|
|
29
|
-
*
|
|
24
|
+
* <p>For an example, see Searching for a face using its face ID in the Amazon Rekognition
|
|
25
|
+
* Developer Guide.</p>
|
|
30
26
|
* <p>This operation requires permissions to perform the <code>rekognition:SearchFaces</code>
|
|
31
27
|
* action.</p>
|
|
32
28
|
* @example
|
|
@@ -8,11 +8,11 @@ export interface TagResourceCommandInput extends TagResourceRequest {
|
|
|
8
8
|
export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* <p>This operation requires permissions to perform the
|
|
15
|
-
*
|
|
11
|
+
* <p> Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom
|
|
12
|
+
* Labels model. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
13
|
+
* Resources</a>. </p>
|
|
14
|
+
* <p>This operation requires permissions to perform the <code>rekognition:TagResource</code>
|
|
15
|
+
* action. </p>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
18
|
* ```javascript
|
|
@@ -8,11 +8,10 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {
|
|
|
8
8
|
export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>
|
|
12
|
-
*
|
|
13
|
-
* </p>
|
|
11
|
+
* <p> Removes one or more tags from 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:UntagResource</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
|