ExAws.Rekognition v0.2.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_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_ListCollections.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 \\ 0.8) 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

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(), maybe_improper_list()) :: %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(), maybe_improper_list()) ::
  %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_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, next_token, sort_by \\ :id) View Source
get_celebrity_recognition(
  binary(),
  nil | 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

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

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