@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
|
@@ -64,19 +64,13 @@ import { UpdateDatasetEntriesCommandInput, UpdateDatasetEntriesCommandOutput } f
|
|
|
64
64
|
import { UpdateStreamProcessorCommandInput, UpdateStreamProcessorCommandOutput } from "./commands/UpdateStreamProcessorCommand";
|
|
65
65
|
import { RekognitionClient } from "./RekognitionClient";
|
|
66
66
|
/**
|
|
67
|
-
* <p>This is the API Reference for <a href="https://docs.aws.amazon.com/rekognition/latest/dg/images.html">Amazon Rekognition Image</a>,
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
* It provides descriptions of actions, data types, common parameters,
|
|
72
|
-
* and common errors.</p>
|
|
73
|
-
*
|
|
67
|
+
* <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>,
|
|
68
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/video.html">Amazon Rekognition Stored
|
|
69
|
+
* 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
|
|
70
|
+
* parameters, and common errors.</p>
|
|
74
71
|
* <p>
|
|
75
72
|
* <b>Amazon Rekognition Image</b>
|
|
76
73
|
* </p>
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
74
|
* <ul>
|
|
81
75
|
* <li>
|
|
82
76
|
* <p>
|
|
@@ -164,8 +158,6 @@ import { RekognitionClient } from "./RekognitionClient";
|
|
|
164
158
|
* </p>
|
|
165
159
|
* </li>
|
|
166
160
|
* </ul>
|
|
167
|
-
*
|
|
168
|
-
*
|
|
169
161
|
* <p>
|
|
170
162
|
* <b>Amazon Rekognition Custom Labels</b>
|
|
171
163
|
* </p>
|
|
@@ -271,12 +263,9 @@ import { RekognitionClient } from "./RekognitionClient";
|
|
|
271
263
|
* </p>
|
|
272
264
|
* </li>
|
|
273
265
|
* </ul>
|
|
274
|
-
*
|
|
275
|
-
*
|
|
276
266
|
* <p>
|
|
277
267
|
* <b>Amazon Rekognition Video Stored Video</b>
|
|
278
268
|
* </p>
|
|
279
|
-
*
|
|
280
269
|
* <ul>
|
|
281
270
|
* <li>
|
|
282
271
|
* <p>
|
|
@@ -359,11 +348,9 @@ import { RekognitionClient } from "./RekognitionClient";
|
|
|
359
348
|
* </p>
|
|
360
349
|
* </li>
|
|
361
350
|
* </ul>
|
|
362
|
-
*
|
|
363
351
|
* <p>
|
|
364
352
|
* <b>Amazon Rekognition Video Streaming Video</b>
|
|
365
353
|
* </p>
|
|
366
|
-
*
|
|
367
354
|
* <ul>
|
|
368
355
|
* <li>
|
|
369
356
|
* <p>
|
|
@@ -404,26 +391,19 @@ import { RekognitionClient } from "./RekognitionClient";
|
|
|
404
391
|
*/
|
|
405
392
|
export declare class Rekognition extends RekognitionClient {
|
|
406
393
|
/**
|
|
407
|
-
* <p>Compares a face in the <i>source</i> input image with
|
|
408
|
-
*
|
|
409
|
-
*
|
|
410
|
-
*
|
|
411
|
-
* <p> If the source image contains multiple faces, the service detects the largest face
|
|
412
|
-
* and compares it with each face detected in the target image. </p>
|
|
413
|
-
*
|
|
414
|
-
*
|
|
394
|
+
* <p>Compares a face in the <i>source</i> input image with each of the 100
|
|
395
|
+
* largest faces detected in the <i>target</i> input image. </p>
|
|
396
|
+
* <p> If the source image contains multiple faces, the service detects the largest face and
|
|
397
|
+
* compares it with each face detected in the target image. </p>
|
|
415
398
|
* <note>
|
|
416
|
-
* <p>CompareFaces uses machine learning algorithms, which are probabilistic.
|
|
417
|
-
*
|
|
418
|
-
*
|
|
419
|
-
*
|
|
420
|
-
*
|
|
421
|
-
*
|
|
422
|
-
*
|
|
423
|
-
* validation before taking action.</p>
|
|
399
|
+
* <p>CompareFaces uses machine learning algorithms, which are probabilistic. A false negative
|
|
400
|
+
* is an incorrect prediction that a face in the target image has a low similarity confidence
|
|
401
|
+
* score when compared to the face in the source image. To reduce the probability of false
|
|
402
|
+
* negatives, we recommend that you compare the target image against multiple source images. If
|
|
403
|
+
* you plan to use <code>CompareFaces</code> to make a decision that impacts an individual's
|
|
404
|
+
* rights, privacy, or access to services, we recommend that you pass the result to a human for
|
|
405
|
+
* review and further validation before taking action.</p>
|
|
424
406
|
* </note>
|
|
425
|
-
*
|
|
426
|
-
*
|
|
427
407
|
* <p>You pass the input and target images either as base64-encoded image bytes or as
|
|
428
408
|
* references to images in an Amazon S3 bucket. If you use the
|
|
429
409
|
* AWS
|
|
@@ -434,39 +414,35 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
434
414
|
* facial landmarks, pose details (pitch, roll, and yaw), quality (brightness and sharpness), and
|
|
435
415
|
* confidence value (indicating the level of confidence that the bounding box contains a face).
|
|
436
416
|
* The response also provides a similarity score, which indicates how closely the faces match. </p>
|
|
437
|
-
*
|
|
438
417
|
* <note>
|
|
439
418
|
* <p>By default, only faces with a similarity score of greater than or equal to 80% are
|
|
440
419
|
* returned in the response. You can change this value by specifying the
|
|
441
420
|
* <code>SimilarityThreshold</code> parameter.</p>
|
|
442
421
|
* </note>
|
|
443
|
-
*
|
|
444
422
|
* <p>
|
|
445
|
-
* <code>CompareFaces</code> also returns an array of faces that don't match the source
|
|
446
|
-
* For each face, it returns a bounding box, confidence value, landmarks, pose details,
|
|
447
|
-
*
|
|
448
|
-
* of the face and confidence value.</p>
|
|
449
|
-
*
|
|
423
|
+
* <code>CompareFaces</code> also returns an array of faces that don't match the source
|
|
424
|
+
* image. For each face, it returns a bounding box, confidence value, landmarks, pose details,
|
|
425
|
+
* and quality. The response also returns information about the face in the source image,
|
|
426
|
+
* including the bounding box of the face and confidence value.</p>
|
|
450
427
|
* <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces
|
|
451
|
-
* that don’t meet a required quality bar. The quality bar is based on a
|
|
452
|
-
*
|
|
453
|
-
*
|
|
454
|
-
*
|
|
455
|
-
*
|
|
456
|
-
*
|
|
457
|
-
*
|
|
458
|
-
* <p>If no faces are detected in the source or target images, <code>CompareFaces</code>
|
|
459
|
-
*
|
|
460
|
-
*
|
|
461
|
-
*
|
|
428
|
+
* that don’t meet a required quality bar. The quality bar is based on a variety of common use
|
|
429
|
+
* cases. Use <code>QualityFilter</code> to set the quality bar by specifying <code>LOW</code>,
|
|
430
|
+
* <code>MEDIUM</code>, or <code>HIGH</code>. If you do not want to filter detected faces,
|
|
431
|
+
* specify <code>NONE</code>. The default value is <code>NONE</code>. </p>
|
|
432
|
+
* <p>If the image doesn't contain Exif metadata, <code>CompareFaces</code> returns
|
|
433
|
+
* orientation information for the source and target images. Use these values to display the
|
|
434
|
+
* images with the correct image orientation.</p>
|
|
435
|
+
* <p>If no faces are detected in the source or target images, <code>CompareFaces</code>
|
|
436
|
+
* returns an <code>InvalidParameterException</code> error. </p>
|
|
462
437
|
* <note>
|
|
463
|
-
* <p> This is a stateless API operation. That is, data returned by this operation doesn't
|
|
438
|
+
* <p> This is a stateless API operation. That is, data returned by this operation doesn't
|
|
439
|
+
* persist.</p>
|
|
464
440
|
* </note>
|
|
465
441
|
*
|
|
466
|
-
*
|
|
467
|
-
*
|
|
468
|
-
* <p>This operation requires permissions to perform the
|
|
469
|
-
*
|
|
442
|
+
* <p>For an example, see Comparing Faces in Images in the Amazon Rekognition Developer
|
|
443
|
+
* Guide.</p>
|
|
444
|
+
* <p>This operation requires permissions to perform the
|
|
445
|
+
* <code>rekognition:CompareFaces</code> action.</p>
|
|
470
446
|
*/
|
|
471
447
|
compareFaces(args: CompareFacesCommandInput, options?: __HttpHandlerOptions): Promise<CompareFacesCommandOutput>;
|
|
472
448
|
compareFaces(args: CompareFacesCommandInput, cb: (err: any, data?: CompareFacesCommandOutput) => void): void;
|
|
@@ -505,13 +481,15 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
505
481
|
* user can then index faces using the <code>IndexFaces</code> operation and persist results in a
|
|
506
482
|
* specific collection. Then, a user can search the collection for faces in the user-specific
|
|
507
483
|
* container. </p>
|
|
508
|
-
* <p>When you create a collection, it is associated with the latest version of the face model
|
|
484
|
+
* <p>When you create a collection, it is associated with the latest version of the face model
|
|
485
|
+
* version.</p>
|
|
509
486
|
* <note>
|
|
510
487
|
* <p>Collection names are case-sensitive.</p>
|
|
511
488
|
* </note>
|
|
512
|
-
*
|
|
513
489
|
* <p>This operation requires permissions to perform the
|
|
514
|
-
*
|
|
490
|
+
* <code>rekognition:CreateCollection</code> action. If you want to tag your collection, you
|
|
491
|
+
* also require permission to perform the <code>rekognition:TagResource</code>
|
|
492
|
+
* operation.</p>
|
|
515
493
|
*/
|
|
516
494
|
createCollection(args: CreateCollectionCommandInput, options?: __HttpHandlerOptions): Promise<CreateCollectionCommandOutput>;
|
|
517
495
|
createCollection(args: CreateCollectionCommandInput, cb: (err: any, data?: CreateCollectionCommandOutput) => void): void;
|
|
@@ -627,9 +605,9 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
627
605
|
createStreamProcessor(args: CreateStreamProcessorCommandInput, cb: (err: any, data?: CreateStreamProcessorCommandOutput) => void): void;
|
|
628
606
|
createStreamProcessor(args: CreateStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStreamProcessorCommandOutput) => void): void;
|
|
629
607
|
/**
|
|
630
|
-
* <p>Deletes the specified collection. Note that this operation
|
|
631
|
-
*
|
|
632
|
-
*
|
|
608
|
+
* <p>Deletes the specified collection. Note that this operation removes all faces in the
|
|
609
|
+
* collection. For an example, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/delete-collection-procedure.html">Deleting a
|
|
610
|
+
* collection</a>.</p>
|
|
633
611
|
* <p>This operation requires permissions to perform the
|
|
634
612
|
* <code>rekognition:DeleteCollection</code> action.</p>
|
|
635
613
|
*/
|
|
@@ -804,55 +782,116 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
804
782
|
detectCustomLabels(args: DetectCustomLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectCustomLabelsCommandOutput) => void): void;
|
|
805
783
|
/**
|
|
806
784
|
* <p>Detects faces within an image that is provided as input.</p>
|
|
807
|
-
*
|
|
808
785
|
* <p>
|
|
809
786
|
* <code>DetectFaces</code> detects the 100 largest faces in the image. For each face
|
|
810
787
|
* detected, the operation returns face details. These details include a bounding box of the
|
|
811
788
|
* face, a confidence value (that the bounding box contains a face), and a fixed set of
|
|
812
|
-
* attributes such as facial landmarks (for example, coordinates of eye and mouth),
|
|
813
|
-
*
|
|
789
|
+
* attributes such as facial landmarks (for example, coordinates of eye and mouth), presence of
|
|
790
|
+
* beard, sunglasses, and so on. </p>
|
|
814
791
|
* <p>The face-detection algorithm is most effective on frontal faces. For non-frontal or
|
|
815
792
|
* obscured faces, the algorithm might not detect the faces or might detect faces with lower
|
|
816
793
|
* confidence. </p>
|
|
817
794
|
* <p>You pass the input image either as base64-encoded image bytes or as a reference to an
|
|
818
|
-
* image in an Amazon S3 bucket. If you use the AWS CLI
|
|
819
|
-
*
|
|
820
|
-
* supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
821
|
-
*
|
|
795
|
+
* image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,
|
|
796
|
+
* passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
822
797
|
* <note>
|
|
823
798
|
* <p>This is a stateless API operation. That is, the operation does not persist any
|
|
824
799
|
* data.</p>
|
|
825
800
|
* </note>
|
|
826
|
-
*
|
|
827
|
-
*
|
|
828
|
-
* <code>rekognition:DetectFaces</code> action. </p>
|
|
801
|
+
* <p>This operation requires permissions to perform the <code>rekognition:DetectFaces</code>
|
|
802
|
+
* action. </p>
|
|
829
803
|
*/
|
|
830
804
|
detectFaces(args: DetectFacesCommandInput, options?: __HttpHandlerOptions): Promise<DetectFacesCommandOutput>;
|
|
831
805
|
detectFaces(args: DetectFacesCommandInput, cb: (err: any, data?: DetectFacesCommandOutput) => void): void;
|
|
832
806
|
detectFaces(args: DetectFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectFacesCommandOutput) => void): void;
|
|
833
807
|
/**
|
|
834
|
-
* <p>Detects instances of real-world entities within an image (JPEG or PNG)
|
|
835
|
-
*
|
|
836
|
-
*
|
|
837
|
-
* </p>
|
|
808
|
+
* <p>Detects instances of real-world entities within an image (JPEG or PNG) provided as
|
|
809
|
+
* input. This includes objects like flower, tree, and table; events like wedding, graduation,
|
|
810
|
+
* and birthday party; and concepts like landscape, evening, and nature. </p>
|
|
838
811
|
*
|
|
839
|
-
* <p>For an example, see Analyzing images stored in an Amazon S3 bucket in the
|
|
840
|
-
*
|
|
841
|
-
* <p>
|
|
842
|
-
* <code>DetectLabels</code> does not support the detection of activities. However, activity detection
|
|
843
|
-
* is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.</p>
|
|
844
|
-
* </note>
|
|
812
|
+
* <p>For an example, see Analyzing images stored in an Amazon S3 bucket in the
|
|
813
|
+
* Amazon Rekognition Developer Guide.</p>
|
|
845
814
|
*
|
|
846
815
|
* <p>You pass the input image as base64-encoded image bytes or as a reference to an image in
|
|
847
816
|
* an Amazon S3 bucket. If you use the
|
|
848
817
|
* AWS
|
|
849
818
|
* CLI to call Amazon Rekognition operations, passing image bytes is not
|
|
850
819
|
* supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
851
|
-
* <p>
|
|
852
|
-
*
|
|
853
|
-
*
|
|
854
|
-
*
|
|
855
|
-
*
|
|
820
|
+
* <p>
|
|
821
|
+
* <b>Optional Parameters</b>
|
|
822
|
+
* </p>
|
|
823
|
+
* <p>You can specify one or both of the <code>GENERAL_LABELS</code> and
|
|
824
|
+
* <code>IMAGE_PROPERTIES</code> feature types when calling the DetectLabels API. Including
|
|
825
|
+
* <code>GENERAL_LABELS</code> will ensure the response includes the labels detected in the
|
|
826
|
+
* input image, while including <code>IMAGE_PROPERTIES </code>will ensure the response includes
|
|
827
|
+
* information about the image quality and color.</p>
|
|
828
|
+
* <p>When using <code>GENERAL_LABELS</code> and/or <code>IMAGE_PROPERTIES</code> you can
|
|
829
|
+
* provide filtering criteria to the Settings parameter. You can filter with sets of individual
|
|
830
|
+
* labels or with label categories. You can specify inclusive filters, exclusive filters, or a
|
|
831
|
+
* 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
|
|
832
|
+
* Labels in an Image</a>.</p>
|
|
833
|
+
* <p>You can specify <code>MinConfidence</code> to control the confidence threshold for the
|
|
834
|
+
* labels returned. The default is 55%. You can also add the <code>MaxLabels</code> parameter to
|
|
835
|
+
* limit the number of labels returned. The default and upper limit is 1000 labels.</p>
|
|
836
|
+
* <p>
|
|
837
|
+
* <b>Response Elements</b>
|
|
838
|
+
* </p>
|
|
839
|
+
* <p> For each object, scene, and concept the API returns one or more labels. The API
|
|
840
|
+
* returns the following types of information regarding labels:</p>
|
|
841
|
+
* <ul>
|
|
842
|
+
* <li>
|
|
843
|
+
* <p> Name - The name of the detected label. </p>
|
|
844
|
+
* </li>
|
|
845
|
+
* <li>
|
|
846
|
+
* <p> Confidence - The level of confidence in the label assigned to a detected object.
|
|
847
|
+
* </p>
|
|
848
|
+
* </li>
|
|
849
|
+
* <li>
|
|
850
|
+
* <p> Parents - The ancestor labels for a detected label. DetectLabels returns a
|
|
851
|
+
* hierarchical taxonomy of detected labels. For example, a detected car might be assigned
|
|
852
|
+
* the label car. The label car has two parent labels: Vehicle (its parent) and
|
|
853
|
+
* Transportation (its grandparent). The response includes the all ancestors for a label,
|
|
854
|
+
* where every ancestor is a unique label. In the previous example, Car, Vehicle, and
|
|
855
|
+
* Transportation are returned as unique labels in the response. </p>
|
|
856
|
+
* </li>
|
|
857
|
+
* <li>
|
|
858
|
+
* <p> Aliases - Possible Aliases for the label. </p>
|
|
859
|
+
* </li>
|
|
860
|
+
* <li>
|
|
861
|
+
* <p> Categories - The label categories that the detected label belongs to. A given label
|
|
862
|
+
* can belong to more than one category. </p>
|
|
863
|
+
* </li>
|
|
864
|
+
* <li>
|
|
865
|
+
* <p> BoundingBox — Bounding boxes are described for all instances of detected common
|
|
866
|
+
* object labels, returned in an array of Instance objects. An Instance object contains a
|
|
867
|
+
* BoundingBox object, describing the location of the label on the input image. It also
|
|
868
|
+
* includes the confidence for the accuracy of the detected bounding box. </p>
|
|
869
|
+
* </li>
|
|
870
|
+
* </ul>
|
|
871
|
+
* <p> The API returns the following information regarding the image, as part of the
|
|
872
|
+
* ImageProperties structure:</p>
|
|
873
|
+
* <ul>
|
|
874
|
+
* <li>
|
|
875
|
+
* <p>Quality - Information about the Sharpness, Brightness, and Contrast of the input
|
|
876
|
+
* image, scored between 0 to 100. Image quality is returned for the entire image, as well as
|
|
877
|
+
* the background and the foreground. </p>
|
|
878
|
+
* </li>
|
|
879
|
+
* <li>
|
|
880
|
+
* <p>Dominant Color - An array of the dominant colors in the image. </p>
|
|
881
|
+
* </li>
|
|
882
|
+
* <li>
|
|
883
|
+
* <p>Foreground - Information about the Sharpness and Brightness of the input image’s
|
|
884
|
+
* foreground. </p>
|
|
885
|
+
* </li>
|
|
886
|
+
* <li>
|
|
887
|
+
* <p>Background - Information about the Sharpness and Brightness of the input image’s
|
|
888
|
+
* background.</p>
|
|
889
|
+
* </li>
|
|
890
|
+
* </ul>
|
|
891
|
+
* <p>The list of returned labels will include at least one label for every detected object,
|
|
892
|
+
* along with information about that label. In the following example, suppose the input image has
|
|
893
|
+
* a lighthouse, the sea, and a rock. The response includes all three labels, one for each
|
|
894
|
+
* object, as well as the confidence in the label:</p>
|
|
856
895
|
* <p>
|
|
857
896
|
* <code>{Name: lighthouse, Confidence: 98.4629}</code>
|
|
858
897
|
* </p>
|
|
@@ -862,10 +901,9 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
862
901
|
* <p>
|
|
863
902
|
* <code> {Name: sea,Confidence: 75.061}</code>
|
|
864
903
|
* </p>
|
|
865
|
-
* <p>
|
|
866
|
-
*
|
|
867
|
-
*
|
|
868
|
-
* the following three labels. </p>
|
|
904
|
+
* <p>The list of labels can include multiple labels for the same object. For example, if the
|
|
905
|
+
* input image shows a flower (for example, a tulip), the operation might return the following
|
|
906
|
+
* three labels. </p>
|
|
869
907
|
* <p>
|
|
870
908
|
* <code>{Name: flower,Confidence: 99.0562}</code>
|
|
871
909
|
* </p>
|
|
@@ -875,31 +913,12 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
875
913
|
* <p>
|
|
876
914
|
* <code>{Name: tulip,Confidence: 99.0562}</code>
|
|
877
915
|
* </p>
|
|
878
|
-
*
|
|
879
916
|
* <p>In this example, the detection algorithm more precisely identifies the flower as a
|
|
880
917
|
* tulip.</p>
|
|
881
|
-
* <p>In response, the API returns an array of labels. In addition, the response also
|
|
882
|
-
* includes the orientation correction. Optionally, you can specify <code>MinConfidence</code> to
|
|
883
|
-
* control the confidence threshold for the labels returned. The default is 55%. You can also add
|
|
884
|
-
* the <code>MaxLabels</code> parameter to limit the number of labels returned. </p>
|
|
885
918
|
* <note>
|
|
886
919
|
* <p>If the object detected is a person, the operation doesn't provide the same facial
|
|
887
920
|
* details that the <a>DetectFaces</a> operation provides.</p>
|
|
888
921
|
* </note>
|
|
889
|
-
* <p>
|
|
890
|
-
* <code>DetectLabels</code> returns bounding boxes for instances of common object labels in an array of
|
|
891
|
-
* <a>Instance</a> objects. An <code>Instance</code> object contains a
|
|
892
|
-
* <a>BoundingBox</a> object, for the location of the label on the image. It also includes
|
|
893
|
-
* the confidence by which the bounding box was detected.</p>
|
|
894
|
-
* <p>
|
|
895
|
-
* <code>DetectLabels</code> also returns a hierarchical taxonomy of detected labels. For example,
|
|
896
|
-
* a detected car might be assigned the label <i>car</i>. The label <i>car</i>
|
|
897
|
-
* has two parent labels: <i>Vehicle</i> (its parent) and <i>Transportation</i> (its
|
|
898
|
-
* grandparent).
|
|
899
|
-
* The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response.
|
|
900
|
-
* In the previous example, <i>Car</i>, <i>Vehicle</i>, and <i>Transportation</i>
|
|
901
|
-
* are returned as unique labels in the response.
|
|
902
|
-
* </p>
|
|
903
922
|
* <p>This is a stateless API operation. That is, the operation does not persist any
|
|
904
923
|
* data.</p>
|
|
905
924
|
* <p>This operation requires permissions to perform the
|
|
@@ -909,15 +928,15 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
909
928
|
detectLabels(args: DetectLabelsCommandInput, cb: (err: any, data?: DetectLabelsCommandOutput) => void): void;
|
|
910
929
|
detectLabels(args: DetectLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectLabelsCommandOutput) => void): void;
|
|
911
930
|
/**
|
|
912
|
-
* <p>Detects unsafe content in a specified JPEG or PNG format image.
|
|
913
|
-
*
|
|
914
|
-
*
|
|
915
|
-
*
|
|
916
|
-
* <p>To filter images, use the labels returned by <code>DetectModerationLabels</code>
|
|
917
|
-
*
|
|
918
|
-
*
|
|
919
|
-
* <p>For information about moderation labels,
|
|
920
|
-
*
|
|
931
|
+
* <p>Detects unsafe content in a specified JPEG or PNG format image. Use
|
|
932
|
+
* <code>DetectModerationLabels</code> to moderate images depending on your requirements. For
|
|
933
|
+
* example, you might want to filter images that contain nudity, but not images containing
|
|
934
|
+
* suggestive content.</p>
|
|
935
|
+
* <p>To filter images, use the labels returned by <code>DetectModerationLabels</code> to
|
|
936
|
+
* determine which types of content are appropriate.</p>
|
|
937
|
+
*
|
|
938
|
+
* <p>For information about moderation labels, see Detecting Unsafe Content in the
|
|
939
|
+
* Amazon Rekognition Developer Guide.</p>
|
|
921
940
|
* <p>You pass the input image either as base64-encoded image bytes or as a reference to an
|
|
922
941
|
* image in an Amazon S3 bucket. If you use the
|
|
923
942
|
* AWS
|
|
@@ -992,9 +1011,11 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
992
1011
|
* returns multiple lines.</p>
|
|
993
1012
|
* <p>To determine whether a <code>TextDetection</code> element is a line of text or a word,
|
|
994
1013
|
* use the <code>TextDetection</code> object <code>Type</code> field. </p>
|
|
995
|
-
* <p>To be detected, text must be within +/- 90 degrees orientation of the horizontal
|
|
1014
|
+
* <p>To be detected, text must be within +/- 90 degrees orientation of the horizontal
|
|
1015
|
+
* axis.</p>
|
|
996
1016
|
*
|
|
997
|
-
* <p>For more information, see Detecting text in the Amazon Rekognition Developer
|
|
1017
|
+
* <p>For more information, see Detecting text in the Amazon Rekognition Developer
|
|
1018
|
+
* Guide.</p>
|
|
998
1019
|
*/
|
|
999
1020
|
detectText(args: DetectTextCommandInput, options?: __HttpHandlerOptions): Promise<DetectTextCommandOutput>;
|
|
1000
1021
|
detectText(args: DetectTextCommandInput, cb: (err: any, data?: DetectTextCommandOutput) => void): void;
|
|
@@ -1021,8 +1042,8 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1021
1042
|
* The additional information is returned as an array of URLs. If there is no additional
|
|
1022
1043
|
* information about the celebrity, this list is empty.</p>
|
|
1023
1044
|
*
|
|
1024
|
-
* <p>For more information, see Getting information about a celebrity in
|
|
1025
|
-
*
|
|
1045
|
+
* <p>For more information, see Getting information about a celebrity in the
|
|
1046
|
+
* Amazon Rekognition Developer Guide.</p>
|
|
1026
1047
|
* <p>This operation requires permissions to perform the
|
|
1027
1048
|
* <code>rekognition:GetCelebrityInfo</code> action. </p>
|
|
1028
1049
|
*/
|
|
@@ -1282,21 +1303,19 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1282
1303
|
* detection algorithm first detects the faces in the input image. For each face, the algorithm
|
|
1283
1304
|
* extracts facial features into a feature vector, and stores it in the backend database.
|
|
1284
1305
|
* Amazon Rekognition uses feature vectors when it performs face match and search operations using the
|
|
1285
|
-
* <a>SearchFaces</a> and <a>SearchFacesByImage</a>
|
|
1286
|
-
* operations.</p>
|
|
1306
|
+
* <a>SearchFaces</a> and <a>SearchFacesByImage</a> operations.</p>
|
|
1287
1307
|
*
|
|
1288
1308
|
* <p>For more information, see Adding faces to a collection in the Amazon Rekognition
|
|
1289
1309
|
* Developer Guide.</p>
|
|
1290
1310
|
* <p>To get the number of faces in a collection, call <a>DescribeCollection</a>. </p>
|
|
1291
|
-
*
|
|
1292
1311
|
* <p>If you're using version 1.0 of the face detection model, <code>IndexFaces</code>
|
|
1293
1312
|
* indexes the 15 largest faces in the input image. Later versions of the face detection model
|
|
1294
1313
|
* index the 100 largest faces in the input image. </p>
|
|
1295
|
-
* <p>If you're using version 4 or later of the face model, image orientation information
|
|
1296
|
-
*
|
|
1297
|
-
* <p>To determine which version of the model you're using, call <a>DescribeCollection</a>
|
|
1298
|
-
*
|
|
1299
|
-
*
|
|
1314
|
+
* <p>If you're using version 4 or later of the face model, image orientation information is not
|
|
1315
|
+
* returned in the <code>OrientationCorrection</code> field. </p>
|
|
1316
|
+
* <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
|
|
1317
|
+
* version from the value of <code>FaceModelVersion</code> in the response from
|
|
1318
|
+
* <code>IndexFaces</code>
|
|
1300
1319
|
* </p>
|
|
1301
1320
|
*
|
|
1302
1321
|
* <p>For more information, see Model Versioning in the Amazon Rekognition Developer
|
|
@@ -1306,23 +1325,22 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1306
1325
|
* external image ID to create a client-side index to associate the faces with each image. You
|
|
1307
1326
|
* can then use the index to find all faces in an image.</p>
|
|
1308
1327
|
* <p>You can specify the maximum number of faces to index with the <code>MaxFaces</code> input
|
|
1309
|
-
* parameter. This is useful when you want to index the largest faces in an image and don't want
|
|
1310
|
-
* smaller faces, such as those belonging to people standing in the background.</p>
|
|
1328
|
+
* parameter. This is useful when you want to index the largest faces in an image and don't want
|
|
1329
|
+
* to index smaller faces, such as those belonging to people standing in the background.</p>
|
|
1311
1330
|
* <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces
|
|
1312
|
-
* that don’t meet a required quality bar. The quality bar is based on a
|
|
1313
|
-
*
|
|
1314
|
-
*
|
|
1315
|
-
* the quality bar
|
|
1316
|
-
*
|
|
1317
|
-
* If you do not want to filter detected faces, specify <code>NONE</code>. </p>
|
|
1331
|
+
* that don’t meet a required quality bar. The quality bar is based on a variety of common use
|
|
1332
|
+
* cases. By default, <code>IndexFaces</code> chooses the quality bar that's used to filter
|
|
1333
|
+
* faces. You can also explicitly choose the quality bar. Use <code>QualityFilter</code>, to set
|
|
1334
|
+
* the quality bar by specifying <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>. If
|
|
1335
|
+
* you do not want to filter detected faces, specify <code>NONE</code>. </p>
|
|
1318
1336
|
* <note>
|
|
1319
|
-
* <p>To use quality filtering, you need a collection associated with version 3 of the
|
|
1320
|
-
*
|
|
1321
|
-
*
|
|
1337
|
+
* <p>To use quality filtering, you need a collection associated with version 3 of the face
|
|
1338
|
+
* model or higher. To get the version of the face model associated with a collection, call
|
|
1339
|
+
* <a>DescribeCollection</a>. </p>
|
|
1322
1340
|
* </note>
|
|
1323
1341
|
* <p>Information about faces detected in an image, but not indexed, is returned in an array of
|
|
1324
|
-
*
|
|
1325
|
-
*
|
|
1342
|
+
* <a>UnindexedFace</a> objects, <code>UnindexedFaces</code>. Faces aren't indexed
|
|
1343
|
+
* for reasons such as:</p>
|
|
1326
1344
|
* <ul>
|
|
1327
1345
|
* <li>
|
|
1328
1346
|
* <p>The number of faces detected exceeds the value of the <code>MaxFaces</code> request
|
|
@@ -1344,8 +1362,8 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1344
1362
|
* <p>The face doesn’t have enough detail to be suitable for face search.</p>
|
|
1345
1363
|
* </li>
|
|
1346
1364
|
* </ul>
|
|
1347
|
-
* <p>In response, the <code>IndexFaces</code> operation returns an array of metadata for
|
|
1348
|
-
*
|
|
1365
|
+
* <p>In response, the <code>IndexFaces</code> operation returns an array of metadata for all
|
|
1366
|
+
* detected faces, <code>FaceRecords</code>. This includes: </p>
|
|
1349
1367
|
* <ul>
|
|
1350
1368
|
* <li>
|
|
1351
1369
|
* <p>The bounding box, <code>BoundingBox</code>, of the detected face. </p>
|
|
@@ -1364,14 +1382,11 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1364
1382
|
* </ul>
|
|
1365
1383
|
* <p>If you request all facial attributes (by using the <code>detectionAttributes</code>
|
|
1366
1384
|
* parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for
|
|
1367
|
-
* example, location of eye and mouth) and other facial attributes. If you provide
|
|
1368
|
-
*
|
|
1385
|
+
* example, location of eye and mouth) and other facial attributes. If you provide the same
|
|
1386
|
+
* image, specify the same collection, and use the same external ID in the
|
|
1369
1387
|
* <code>IndexFaces</code> operation, Amazon Rekognition doesn't save duplicate face metadata.</p>
|
|
1370
|
-
*
|
|
1371
|
-
*
|
|
1372
1388
|
* <p></p>
|
|
1373
1389
|
*
|
|
1374
|
-
*
|
|
1375
1390
|
* <p>The input image is passed either as base64-encoded image bytes, or as a reference to an
|
|
1376
1391
|
* image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,
|
|
1377
1392
|
* passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. </p>
|
|
@@ -1382,12 +1397,14 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1382
1397
|
indexFaces(args: IndexFacesCommandInput, cb: (err: any, data?: IndexFacesCommandOutput) => void): void;
|
|
1383
1398
|
indexFaces(args: IndexFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IndexFacesCommandOutput) => void): void;
|
|
1384
1399
|
/**
|
|
1385
|
-
* <p>Returns list of collection IDs in your account.
|
|
1386
|
-
*
|
|
1387
|
-
*
|
|
1400
|
+
* <p>Returns list of collection IDs in your account. If the result is truncated, the
|
|
1401
|
+
* response also provides a <code>NextToken</code> that you can use in the subsequent request to
|
|
1402
|
+
* fetch the next set of collection IDs.</p>
|
|
1388
1403
|
*
|
|
1389
|
-
* <p>For an example, see Listing collections in the Amazon Rekognition Developer
|
|
1390
|
-
*
|
|
1404
|
+
* <p>For an example, see Listing collections in the Amazon Rekognition Developer
|
|
1405
|
+
* Guide.</p>
|
|
1406
|
+
* <p>This operation requires permissions to perform the
|
|
1407
|
+
* <code>rekognition:ListCollections</code> action.</p>
|
|
1391
1408
|
*/
|
|
1392
1409
|
listCollections(args: ListCollectionsCommandInput, options?: __HttpHandlerOptions): Promise<ListCollectionsCommandOutput>;
|
|
1393
1410
|
listCollections(args: ListCollectionsCommandInput, cb: (err: any, data?: ListCollectionsCommandOutput) => void): void;
|
|
@@ -1424,14 +1441,12 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1424
1441
|
listDatasetLabels(args: ListDatasetLabelsCommandInput, cb: (err: any, data?: ListDatasetLabelsCommandOutput) => void): void;
|
|
1425
1442
|
listDatasetLabels(args: ListDatasetLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetLabelsCommandOutput) => void): void;
|
|
1426
1443
|
/**
|
|
1427
|
-
* <p>Returns metadata for faces in the specified collection.
|
|
1428
|
-
*
|
|
1429
|
-
*
|
|
1430
|
-
*
|
|
1431
|
-
*
|
|
1432
|
-
*
|
|
1433
|
-
* <p>This operation requires permissions to perform the
|
|
1434
|
-
* <code>rekognition:ListFaces</code> action.</p>
|
|
1444
|
+
* <p>Returns metadata for faces in the specified collection. This metadata
|
|
1445
|
+
* includes information such as the bounding box coordinates, the confidence (that the bounding
|
|
1446
|
+
* box contains a face), and face ID. For an example, see Listing Faces in a Collection in the
|
|
1447
|
+
* Amazon Rekognition Developer Guide.</p>
|
|
1448
|
+
* <p>This operation requires permissions to perform the <code>rekognition:ListFaces</code>
|
|
1449
|
+
* action.</p>
|
|
1435
1450
|
*/
|
|
1436
1451
|
listFaces(args: ListFacesCommandInput, options?: __HttpHandlerOptions): Promise<ListFacesCommandOutput>;
|
|
1437
1452
|
listFaces(args: ListFacesCommandInput, cb: (err: any, data?: ListFacesCommandOutput) => void): void;
|
|
@@ -1450,11 +1465,10 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1450
1465
|
listStreamProcessors(args: ListStreamProcessorsCommandInput, cb: (err: any, data?: ListStreamProcessorsCommandOutput) => void): void;
|
|
1451
1466
|
listStreamProcessors(args: ListStreamProcessorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamProcessorsCommandOutput) => void): void;
|
|
1452
1467
|
/**
|
|
1453
|
-
* <p>
|
|
1454
|
-
*
|
|
1455
|
-
* </p>
|
|
1468
|
+
* <p> Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels
|
|
1469
|
+
* model. </p>
|
|
1456
1470
|
* <p>This operation requires permissions to perform the
|
|
1457
|
-
*
|
|
1471
|
+
* <code>rekognition:ListTagsForResource</code> action. </p>
|
|
1458
1472
|
*/
|
|
1459
1473
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
1460
1474
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
@@ -1482,14 +1496,13 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1482
1496
|
putProjectPolicy(args: PutProjectPolicyCommandInput, cb: (err: any, data?: PutProjectPolicyCommandOutput) => void): void;
|
|
1483
1497
|
putProjectPolicy(args: PutProjectPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutProjectPolicyCommandOutput) => void): void;
|
|
1484
1498
|
/**
|
|
1485
|
-
* <p>Returns an array of celebrities recognized in the input image.
|
|
1486
|
-
*
|
|
1499
|
+
* <p>Returns an array of celebrities recognized in the input image. For more
|
|
1500
|
+
* information, see Recognizing celebrities in the Amazon Rekognition Developer Guide. </p>
|
|
1487
1501
|
* <p>
|
|
1488
|
-
* <code>RecognizeCelebrities</code> returns the 64 largest faces in the image. It lists
|
|
1489
|
-
* recognized celebrities in the <code>CelebrityFaces</code> array and any unrecognized faces
|
|
1490
|
-
* the <code>UnrecognizedFaces</code> array. <code>RecognizeCelebrities</code> doesn't return
|
|
1502
|
+
* <code>RecognizeCelebrities</code> returns the 64 largest faces in the image. It lists
|
|
1503
|
+
* the recognized celebrities in the <code>CelebrityFaces</code> array and any unrecognized faces
|
|
1504
|
+
* in the <code>UnrecognizedFaces</code> array. <code>RecognizeCelebrities</code> doesn't return
|
|
1491
1505
|
* celebrities whose faces aren't among the largest 64 faces in the image.</p>
|
|
1492
|
-
*
|
|
1493
1506
|
* <p>For each celebrity recognized, <code>RecognizeCelebrities</code> returns a
|
|
1494
1507
|
* <code>Celebrity</code> object. The <code>Celebrity</code> object contains the celebrity
|
|
1495
1508
|
* name, ID, URL links to additional information, match confidence, and a
|
|
@@ -1507,10 +1520,8 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1507
1520
|
* CLI to call Amazon Rekognition operations, passing image bytes is not
|
|
1508
1521
|
* supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
1509
1522
|
*
|
|
1510
|
-
*
|
|
1511
|
-
*
|
|
1512
|
-
*
|
|
1513
|
-
* <p>For an example, see Recognizing celebrities in an image in the Amazon Rekognition Developer Guide.</p>
|
|
1523
|
+
* <p>For an example, see Recognizing celebrities in an image in the Amazon Rekognition
|
|
1524
|
+
* Developer Guide.</p>
|
|
1514
1525
|
* <p>This operation requires permissions to perform the
|
|
1515
1526
|
* <code>rekognition:RecognizeCelebrities</code> operation.</p>
|
|
1516
1527
|
*/
|
|
@@ -1525,18 +1536,14 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1525
1536
|
* <p>You can also search faces without indexing faces by using the
|
|
1526
1537
|
* <code>SearchFacesByImage</code> operation.</p>
|
|
1527
1538
|
* </note>
|
|
1539
|
+
* <p> The operation response returns an array of faces that match, ordered by similarity
|
|
1540
|
+
* score with the highest similarity first. More specifically, it is an array of metadata for
|
|
1541
|
+
* each face match that is found. Along with the metadata, the response also includes a
|
|
1542
|
+
* <code>confidence</code> value for each face match, indicating the confidence that the
|
|
1543
|
+
* specific face matches the input face. </p>
|
|
1528
1544
|
*
|
|
1529
|
-
* <p>
|
|
1530
|
-
*
|
|
1531
|
-
* an array of faces that match, ordered by similarity score with the highest
|
|
1532
|
-
* similarity first. More specifically, it is an
|
|
1533
|
-
* array of metadata for each face match that is found. Along with the metadata, the response also
|
|
1534
|
-
* includes a <code>confidence</code> value for each face match, indicating the confidence
|
|
1535
|
-
* that the specific face matches the input face.
|
|
1536
|
-
* </p>
|
|
1537
|
-
*
|
|
1538
|
-
* <p>For an example, see Searching for a face using its face ID in the Amazon Rekognition Developer Guide.</p>
|
|
1539
|
-
*
|
|
1545
|
+
* <p>For an example, see Searching for a face using its face ID in the Amazon Rekognition
|
|
1546
|
+
* Developer Guide.</p>
|
|
1540
1547
|
* <p>This operation requires permissions to perform the <code>rekognition:SearchFaces</code>
|
|
1541
1548
|
* action.</p>
|
|
1542
1549
|
*/
|
|
@@ -1548,49 +1555,40 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1548
1555
|
* the specified collection for matching faces. The operation compares the features of the input
|
|
1549
1556
|
* face with faces in the specified collection. </p>
|
|
1550
1557
|
* <note>
|
|
1551
|
-
* <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
|
|
1552
|
-
*
|
|
1558
|
+
* <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
|
|
1559
|
+
* to the <a>SearchFaces</a> operation. </p>
|
|
1553
1560
|
* <p> You can also call the <code>DetectFaces</code> operation and use the bounding boxes
|
|
1554
1561
|
* in the response to make face crops, which then you can pass in to the
|
|
1555
1562
|
* <code>SearchFacesByImage</code> operation. </p>
|
|
1556
1563
|
* </note>
|
|
1557
|
-
*
|
|
1558
1564
|
* <p>You pass the input image either as base64-encoded image bytes or as a reference to an
|
|
1559
1565
|
* image in an Amazon S3 bucket. If you use the
|
|
1560
1566
|
* AWS
|
|
1561
1567
|
* CLI to call Amazon Rekognition operations, passing image bytes is not
|
|
1562
1568
|
* supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
1563
|
-
* <p>
|
|
1564
|
-
*
|
|
1565
|
-
*
|
|
1566
|
-
*
|
|
1567
|
-
*
|
|
1568
|
-
*
|
|
1569
|
-
*
|
|
1570
|
-
* In the response, the operation also returns the bounding
|
|
1571
|
-
* box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition
|
|
1572
|
-
* used for the input image.
|
|
1573
|
-
* </p>
|
|
1569
|
+
* <p> The response returns an array of faces that match, ordered by similarity score with
|
|
1570
|
+
* the highest similarity first. More specifically, it is an array of metadata for each face
|
|
1571
|
+
* match found. Along with the metadata, the response also includes a <code>similarity</code>
|
|
1572
|
+
* indicating how similar the face is to the input face. In the response, the operation also
|
|
1573
|
+
* returns the bounding box (and a confidence level that the bounding box contains a face) of the
|
|
1574
|
+
* face that Amazon Rekognition used for the input image. </p>
|
|
1574
1575
|
* <p>If no faces are detected in the input image, <code>SearchFacesByImage</code> returns an
|
|
1575
|
-
*
|
|
1576
|
-
*
|
|
1577
|
-
* <p>For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.</p>
|
|
1576
|
+
* <code>InvalidParameterException</code> error. </p>
|
|
1578
1577
|
*
|
|
1578
|
+
* <p>For an example, Searching for a Face Using an Image in the Amazon Rekognition
|
|
1579
|
+
* Developer Guide.</p>
|
|
1579
1580
|
* <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces
|
|
1580
|
-
* that don’t meet a required quality bar. The quality bar is based on a
|
|
1581
|
-
*
|
|
1582
|
-
*
|
|
1583
|
-
*
|
|
1584
|
-
* If you do not want to filter detected faces, specify <code>NONE</code>. The default
|
|
1585
|
-
* value is <code>NONE</code>.</p>
|
|
1581
|
+
* that don’t meet a required quality bar. The quality bar is based on a variety of common use
|
|
1582
|
+
* cases. Use <code>QualityFilter</code> to set the quality bar for filtering by specifying
|
|
1583
|
+
* <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>. If you do not want to filter
|
|
1584
|
+
* detected faces, specify <code>NONE</code>. The default value is <code>NONE</code>.</p>
|
|
1586
1585
|
* <note>
|
|
1587
|
-
* <p>To use quality filtering, you need a collection associated with version 3 of the
|
|
1588
|
-
*
|
|
1589
|
-
*
|
|
1586
|
+
* <p>To use quality filtering, you need a collection associated with version 3 of the face
|
|
1587
|
+
* model or higher. To get the version of the face model associated with a collection, call
|
|
1588
|
+
* <a>DescribeCollection</a>. </p>
|
|
1590
1589
|
* </note>
|
|
1591
|
-
*
|
|
1592
|
-
*
|
|
1593
|
-
* action.</p>
|
|
1590
|
+
* <p>This operation requires permissions to perform the
|
|
1591
|
+
* <code>rekognition:SearchFacesByImage</code> action.</p>
|
|
1594
1592
|
*/
|
|
1595
1593
|
searchFacesByImage(args: SearchFacesByImageCommandInput, options?: __HttpHandlerOptions): Promise<SearchFacesByImageCommandOutput>;
|
|
1596
1594
|
searchFacesByImage(args: SearchFacesByImageCommandInput, cb: (err: any, data?: SearchFacesByImageCommandOutput) => void): void;
|
|
@@ -1772,21 +1770,20 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1772
1770
|
stopStreamProcessor(args: StopStreamProcessorCommandInput, cb: (err: any, data?: StopStreamProcessorCommandOutput) => void): void;
|
|
1773
1771
|
stopStreamProcessor(args: StopStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopStreamProcessorCommandOutput) => void): void;
|
|
1774
1772
|
/**
|
|
1775
|
-
* <p>
|
|
1776
|
-
*
|
|
1777
|
-
*
|
|
1778
|
-
* <p>This operation requires permissions to perform the
|
|
1779
|
-
*
|
|
1773
|
+
* <p> Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom
|
|
1774
|
+
* Labels model. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
1775
|
+
* Resources</a>. </p>
|
|
1776
|
+
* <p>This operation requires permissions to perform the <code>rekognition:TagResource</code>
|
|
1777
|
+
* action. </p>
|
|
1780
1778
|
*/
|
|
1781
1779
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
1782
1780
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1783
1781
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1784
1782
|
/**
|
|
1785
|
-
* <p>
|
|
1786
|
-
*
|
|
1787
|
-
* </p>
|
|
1783
|
+
* <p> Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels
|
|
1784
|
+
* model. </p>
|
|
1788
1785
|
* <p>This operation requires permissions to perform the
|
|
1789
|
-
*
|
|
1786
|
+
* <code>rekognition:UntagResource</code> action. </p>
|
|
1790
1787
|
*/
|
|
1791
1788
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
1792
1789
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|