ExAws.Rekognition v0.4.0 ExAws.Rekognition View Source

Operations on ExAws Rekognition

Link to this section Summary

Functions

https://docs.aws.amazon.com/rekognition/latest/dg/API_CompareFaces.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_CreateCollection.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_DeleteCollection.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_DeleteFaces.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_DescribeCollection.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_DetectFaces.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_DetectLabels.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_DetectModerationLabels.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_DetectText.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetCelebrityInfo.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetCelebrityRecognition.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetContentModeration.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetFaceDetection.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetFaceSearch.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetLabelDetection.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetPersonTracking.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_ListCollections.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_ListFaces.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_RecognizeCelebrities.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_SearchFaces.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_SearchFacesByImage.html

https://docs.aws.amazon.com/rekognition/latest/dg/API_StartCelebrityRecognition.html

Link to this section Functions

Link to this function

compare_faces(source_image, target_image, similarity_threshold \\ 80) View Source
compare_faces(
  binary() | ExAws.Rekognition.S3Object.t(),
  binary() | ExAws.Rekognition.S3Object.t(),
  number()
) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_CompareFaces.html

NOTE: When using an S3Object, you may need to insure that the S3 uses the same region as Rekognition

Link to this function

create_collection(collection_id) View Source
create_collection(binary()) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_CreateCollection.html

Link to this function

delete_collection(collection_id) View Source
delete_collection(binary()) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_DeleteCollection.html

Link to this function

delete_faces(collection_id, face_ids) View Source
delete_faces(binary(), [binary()]) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_DeleteFaces.html

Link to this function

describe_collection(collection_id) View Source
describe_collection(binary()) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_DescribeCollection.html

Link to this function

detect_faces(image, attributes \\ ["DEFAULT"]) View Source
detect_faces(binary() | ExAws.Rekognition.S3Object.t(), [binary()]) ::
  %ExAws.Operation.JSON{
    before_request: term(),
    data: term(),
    headers: term(),
    http_method: term(),
    params: term(),
    parser: term(),
    path: term(),
    service: term(),
    stream_builder: term()
  }

https://docs.aws.amazon.com/rekognition/latest/dg/API_DetectFaces.html

NOTE: When using an S3Object, you may need to insure that the S3 uses the same region as Rekognition

Link to this function

detect_labels(image, max_labels \\ nil, min_confidence \\ 55) View Source
detect_labels(
  binary() | ExAws.Rekognition.S3Object.t(),
  nil | integer(),
  number()
) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_DetectLabels.html

NOTE: When using an S3Object, you may need to insure that the S3 uses the same region as Rekognition

Link to this function

detect_moderation_labels(image, min_confidence \\ 50) View Source
detect_moderation_labels(binary() | ExAws.Rekognition.S3Object.t(), number()) ::
  %ExAws.Operation.JSON{
    before_request: term(),
    data: term(),
    headers: term(),
    http_method: term(),
    params: term(),
    parser: term(),
    path: term(),
    service: term(),
    stream_builder: term()
  }

https://docs.aws.amazon.com/rekognition/latest/dg/API_DetectModerationLabels.html

NOTE: When using an S3Object, you may need to insure that the S3 uses the same region as Rekognition

Link to this function

detect_text(image) View Source
detect_text(binary() | ExAws.Rekognition.S3Object.t()) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_DetectText.html

NOTE: When using an S3Object, you may need to insure that the S3 uses the same region as Rekognition

Link to this function

get_celebrity_info(id) View Source
get_celebrity_info(binary()) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetCelebrityInfo.html

Link to this function

get_celebrity_recognition(job_id, max_results \\ 1000, next_token \\ nil, sort_by \\ :id) View Source
get_celebrity_recognition(
  binary(),
  pos_integer(),
  nil | binary(),
  :id | :timestamp
) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetCelebrityRecognition.html

Link to this function

get_content_moderation(job_id, max_results \\ 1000, next_token \\ nil, sort_by \\ :timestamp) View Source
get_content_moderation(
  binary(),
  pos_integer(),
  nil | binary(),
  :name | :timestamp
) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetContentModeration.html

Link to this function

get_face_detection(job_id, max_results \\ 1000, next_token \\ nil) View Source
get_face_detection(binary(), pos_integer(), nil | binary()) ::
  %ExAws.Operation.JSON{
    before_request: term(),
    data: term(),
    headers: term(),
    http_method: term(),
    params: term(),
    parser: term(),
    path: term(),
    service: term(),
    stream_builder: term()
  }

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetFaceDetection.html

Link to this function

get_face_search(job_id, max_results \\ 1000, next_token \\ nil, sort_by \\ :timestamp) View Source
get_face_search(binary(), pos_integer(), nil | binary(), :index | :timestamp) ::
  %ExAws.Operation.JSON{
    before_request: term(),
    data: term(),
    headers: term(),
    http_method: term(),
    params: term(),
    parser: term(),
    path: term(),
    service: term(),
    stream_builder: term()
  }

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetFaceSearch.html

Link to this function

get_label_detection(job_id, max_results \\ 1000, next_token \\ nil, sort_by \\ :timestamp) View Source
get_label_detection(binary(), pos_integer(), nil | binary(), :name | :timestamp) ::
  %ExAws.Operation.JSON{
    before_request: term(),
    data: term(),
    headers: term(),
    http_method: term(),
    params: term(),
    parser: term(),
    path: term(),
    service: term(),
    stream_builder: term()
  }

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetLabelDetection.html

Link to this function

get_person_tracking(job_id, max_results \\ 1000, next_token \\ nil, sort_by \\ :timestamp) View Source
get_person_tracking(
  binary(),
  pos_integer(),
  nil | binary(),
  :index | :timestamp
) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_GetPersonTracking.html

Link to this function

index_faces(collection_id, image, external_image_id \\ nil, detection_attributes \\ ["DEFAULT"], max_faces \\ 100, quality_filter \\ :auto) View Source
index_faces(
  binary(),
  binary() | ExAws.Rekognition.S3Object.t(),
  nil | binary(),
  [binary()],
  nil | integer(),
  :auto | :none
) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_IndexFaces.html

NOTE: When using an S3Object, you may need to insure that the S3 uses the same region as Rekognition

Link to this function

list_collections(max_results \\ nil, next_token \\ nil) View Source
list_collections(nil | integer(), nil | binary()) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_ListCollections.html

Link to this function

list_faces(collection_id, max_results \\ nil, next_token \\ nil) View Source
list_faces(binary(), nil | integer(), nil | binary()) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_ListFaces.html

Link to this function

recognize_celebrities(image) View Source
recognize_celebrities(binary() | ExAws.Rekognition.S3Object.t()) ::
  %ExAws.Operation.JSON{
    before_request: term(),
    data: term(),
    headers: term(),
    http_method: term(),
    params: term(),
    parser: term(),
    path: term(),
    service: term(),
    stream_builder: term()
  }

https://docs.aws.amazon.com/rekognition/latest/dg/API_RecognizeCelebrities.html

Link to this function

search_faces(collection_id, face_id, face_match_threshold \\ 80, max_faces \\ 100) View Source
search_faces(binary(), binary(), number(), integer()) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_SearchFaces.html

Link to this function

search_faces_by_image(collection_id, image, face_match_threshold \\ 80, max_faces \\ 100) View Source
search_faces_by_image(
  binary(),
  binary() | ExAws.Rekognition.S3Object.t(),
  number(),
  integer()
) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_SearchFacesByImage.html

NOTE: When using an S3Object, you may need to insure that the S3 uses the same region as Rekognition

Link to this function

start_celebrity_recognition(video, client_request_token \\ nil, job_tag \\ nil, notification_channel \\ nil) View Source
start_celebrity_recognition(
  ExAws.Rekognition.S3Object.t(),
  nil | binary(),
  nil | binary(),
  nil | ExAws.Rekognition.NotificationChannelObject.t()
) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_StartCelebrityRecognition.html

Link to this function

start_content_moderation(video, min_confidence \\ 55, client_request_token \\ nil, job_tag \\ nil, notification_channel \\ nil) View Source
start_content_moderation(
  ExAws.Rekognition.S3Object.t(),
  number(),
  nil | binary(),
  nil | binary(),
  nil | ExAws.Rekognition.NotificationChannelObject.t()
) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_StartContentModeration.html

Link to this function

start_face_detection(video, face_attributes \\ :default, client_request_token \\ nil, job_tag \\ nil, notification_channel \\ nil) View Source
start_face_detection(
  ExAws.Rekognition.S3Object.t(),
  :default | :all,
  nil | binary(),
  nil | binary(),
  nil | ExAws.Rekognition.NotificationChannelObject.t()
) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_StartFaceDetection.html

Link to this function

start_face_search(video, collection_id, face_match_threshold \\ 80, client_request_token \\ nil, job_tag \\ nil, notification_channel \\ nil) View Source
start_face_search(
  ExAws.Rekognition.S3Object.t(),
  binary(),
  number(),
  nil | binary(),
  nil | binary(),
  nil | ExAws.Rekognition.NotificationChannelObject.t()
) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_StartFaceSearch.html

Link to this function

start_label_detection(video, min_confidence \\ 50, client_request_token \\ nil, job_tag \\ nil, notification_channel \\ nil) View Source
start_label_detection(
  ExAws.Rekognition.S3Object.t(),
  number(),
  nil | binary(),
  nil | binary(),
  nil | ExAws.Rekognition.NotificationChannelObject.t()
) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}

https://docs.aws.amazon.com/rekognition/latest/dg/API_StartLabelDetection.html

Link to this function

start_person_tracking(video, client_request_token \\ nil, job_tag \\ nil, notification_channel \\ nil) View Source
start_person_tracking(
  ExAws.Rekognition.S3Object.t(),
  nil | binary(),
  nil | binary(),
  nil | ExAws.Rekognition.NotificationChannelObject.t()
) :: %ExAws.Operation.JSON{
  before_request: term(),
  data: term(),
  headers: term(),
  http_method: term(),
  params: term(),
  parser: term(),
  path: term(),
  service: term(),
  stream_builder: term()
}