ExAws.Rekognition v0.6.0 ExAws.Rekognition View Source
Operations on ExAws Rekognition
Link to this section Summary
Link to this section Types
compare_faces_opt()
View Sourcecompare_faces_opt() :: {:similarity_threshold, 0..100}
create_stream_processor_opt()
View Sourcecreate_stream_processor_opt() :: {:collection_id, binary()} | {:face_match_threshold, 0..100}
detect_labels_opt()
View Sourcedetect_labels_opt() :: {:max_labels, non_neg_integer()} | {:min_confidence, 0..100}
detect_moderation_labels_opt()
View Sourcedetect_moderation_labels_opt() :: {:min_confidence, 0..100}
get_celebrity_recognition_opt()
View Sourceget_celebrity_recognition_opt() :: get_opt() | {:sort_by, :id | :timestamp}
get_content_moderation_opt()
View Sourceget_content_moderation_opt() :: get_opt() | {:sort_by, :name | :timestamp}
get_face_search_opt()
View Sourceget_face_search_opt() :: get_opt() | {:sort_by, :index | :timestamp}
get_label_detection_opt()
View Sourceget_label_detection_opt() :: get_opt() | {:sort_by, :name | :timestamp}
get_opt()
View Sourceget_opt() :: {:max_results, pos_integer()} | {:next_token, binary()}
get_person_tracking_opt()
View Sourceget_person_tracking_opt() :: get_opt() | {:sort_by, :index | :timestamp}
index_faces_opt()
View Sourceindex_faces_opt() :: {:external_image_id, binary()} | {:detection_attributes, [binary()]} | {:max_faces, pos_integer()} | {:quality_filter, :auto | :none}
list_opt()
View Sourcelist_opt() :: {:max_results, 0..4096} | {:next_token, binary()}
list_stream_processors_opt()
View Sourcelist_stream_processors_opt() :: list_opt()
search_faces_by_image_opt()
View Sourcesearch_faces_by_image_opt() :: search_faces_opt()
search_faces_opt()
View Sourcesearch_faces_opt() :: {:face_match_threshold, 0..100} | {:max_faces, 1..4096}
start_celebrity_recognition_opt()
View Sourcestart_celebrity_recognition_opt() :: start_opt()
start_content_moderation_opt()
View Sourcestart_content_moderation_opt() :: start_opt() | {:min_confidence, 0..100}
start_face_detection_opt()
View Sourcestart_face_detection_opt() :: start_opt() | {:face_attributes, :default | :all}
start_face_search_opt()
View Sourcestart_face_search_opt() :: start_opt() | {:face_match_threshold, 0..100}
start_label_detection_opt()
View Sourcestart_label_detection_opt() :: start_opt() | {:min_confidence, 0..100}
start_opt()
View Sourcestart_opt() :: {:client_request_token, binary()} | {:job_tag, binary()} | {:notification_channel, ExAws.Rekognition.NotificationChannelObject.t()}
start_person_tracking_opt()
View Sourcestart_person_tracking_opt() :: start_opt()
Link to this section Functions
compare_faces(source_image, target_image, opts \\ [])
View Sourcecompare_faces(image(), image(), [compare_faces_opt()]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_CompareFaces.html
NOTE: When using an S3Object, you may need to ensure that the S3 uses the same region as Rekognition
create_collection(collection_id)
View Sourcecreate_collection(binary()) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_CreateCollection.html
create_stream_processor(input, output, name, role_arn, opts \\ [])
View Sourcecreate_stream_processor(binary(), binary(), binary(), binary(), [ create_stream_processor_opt() ]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_CreateStreamProcessor.html
delete_collection(collection_id)
View Sourcedelete_collection(binary()) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_DeleteCollection.html
delete_faces(collection_id, face_ids)
View Sourcedelete_faces(binary(), [binary()]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_DeleteFaces.html
delete_stream_processor(name)
View Sourcedelete_stream_processor(binary()) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_DeleteStreamProcessor.html
describe_collection(collection_id)
View Sourcedescribe_collection(binary()) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_DescribeCollection.html
describe_stream_processor(name)
View Sourcedescribe_stream_processor(binary()) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_DescribeStreamProcessor.html
detect_faces(image, opts \\ [])
View Sourcedetect_faces(image(), [detect_faces_opt()]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_DetectFaces.html
NOTE: When using an S3Object, you may need to ensure that the S3 uses the same region as Rekognition
detect_labels(image, opts \\ [])
View Sourcedetect_labels(image(), [detect_labels_opt()]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_DetectLabels.html
NOTE: When using an S3Object, you may need to ensure that the S3 uses the same region as Rekognition
detect_moderation_labels(image, opts \\ [])
View Sourcedetect_moderation_labels(image(), [detect_moderation_labels_opt()]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_DetectModerationLabels.html
NOTE: When using an S3Object, you may need to ensure that the S3 uses the same region as Rekognition
detect_text(image)
View Sourcedetect_text(image()) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_DetectText.html
NOTE: When using an S3Object, you may need to ensure that the S3 uses the same region as Rekognition
get_celebrity_info(id)
View Sourceget_celebrity_info(binary()) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_GetCelebrityInfo.html
get_celebrity_recognition(job_id, opts \\ [])
View Sourceget_celebrity_recognition(binary(), [get_celebrity_recognition_opt()]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_GetCelebrityRecognition.html
get_content_moderation(job_id, opts \\ [])
View Sourceget_content_moderation(binary(), [get_content_moderation_opt()]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_GetContentModeration.html
get_face_detection(job_id, opts \\ [])
View Sourceget_face_detection(binary(), [get_face_detection_opt()]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_GetFaceDetection.html
get_face_search(job_id, opts \\ [])
View Sourceget_face_search(binary(), [get_face_search_opt()]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_GetFaceSearch.html
get_label_detection(job_id, opts \\ [])
View Sourceget_label_detection(binary(), [get_label_detection_opt()]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_GetLabelDetection.html
get_person_tracking(job_id, opts \\ [])
View Sourceget_person_tracking(binary(), [get_person_tracking_opt()]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_GetPersonTracking.html
index_faces(collection_id, image, opts \\ [])
View Sourceindex_faces(binary(), image(), [index_faces_opt()]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_IndexFaces.html
NOTE: When using an S3Object, you may need to ensure that the S3 uses the same region as Rekognition
list_collections(opts \\ [])
View Sourcelist_collections([list_collections_opt()]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_ListCollections.html
list_faces(collection_id, opts \\ [])
View Sourcelist_faces(binary(), [list_faces_opt()]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_ListFaces.html
list_stream_processors(opts \\ [])
View Sourcelist_stream_processors([list_stream_processors_opt()]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_ListStreamProcessors.html
recognize_celebrities(image)
View Sourcerecognize_celebrities(image()) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_RecognizeCelebrities.html
search_faces(collection_id, face_id, opts \\ [])
View Sourcesearch_faces(binary(), binary(), [search_faces_opt()]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_SearchFaces.html
search_faces_by_image(collection_id, image, opts \\ [])
View Sourcesearch_faces_by_image(binary(), image(), [search_faces_by_image_opt()]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_SearchFacesByImage.html
NOTE: When using an S3Object, you may need to ensure that the S3 uses the same region as Rekognition.
start_celebrity_recognition(video, opts \\ [])
View Sourcestart_celebrity_recognition(ExAws.Rekognition.S3Object.t(), [ start_celebrity_recognition_opt() ]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_StartCelebrityRecognition.html
start_content_moderation(video, opts \\ [])
View Sourcestart_content_moderation(ExAws.Rekognition.S3Object.t(), [ start_content_moderation_opt() ]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_StartContentModeration.html
start_face_detection(video, opts \\ [])
View Sourcestart_face_detection(ExAws.Rekognition.S3Object.t(), [ start_face_detection_opt() ]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_StartFaceDetection.html
start_face_search(video, collection_id, opts \\ [])
View Sourcestart_face_search(ExAws.Rekognition.S3Object.t(), binary(), [ start_face_search_opt() ]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_StartFaceSearch.html
start_label_detection(video, opts \\ [])
View Sourcestart_label_detection(ExAws.Rekognition.S3Object.t(), [ start_label_detection_opt() ]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_StartLabelDetection.html
start_person_tracking(video, opts \\ [])
View Sourcestart_person_tracking(ExAws.Rekognition.S3Object.t(), [ start_person_tracking_opt() ]) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_StartPersonTracking.html
start_stream_processor(name)
View Sourcestart_stream_processor(binary()) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_StartStreamProcessor.html
stop_stream_processor(name)
View Sourcestop_stream_processor(binary()) :: ExAws.Operation.JSON.t()
https://docs.aws.amazon.com/rekognition/latest/dg/API_StopStreamProcessor.html