ex_aws_transcribe v0.2.3 ExAws.Transcribe View Source

Operations for AWS Transcribe

Link to this section Summary

Functions

Returns information about a transcription job

Lists transcription jobs with the specified status

Starts an asynchronous job to transcribe speech to text

Link to this section Types

Link to this type

list_transcription_jobs_opts() View Source
list_transcription_jobs_opts() :: [
  job_name_contains: binary(),
  max_results: integer(),
  next_token: binary(),
  status: binary()
]

Link to this type

media() View Source
media() :: [{:media_file_uri, binary()}]

Link to this type

start_transcription_job_opts() View Source
start_transcription_job_opts() :: [
  language_code: binary(),
  media: media(),
  media_format: binary(),
  transcription_job_name: binary(),
  media_sample_rate_hertz: integer(),
  output_bucket_name: binary(),
  settings: start_transcription_job_settings()
]

Link to this type

start_transcription_job_settings() View Source
start_transcription_job_settings() :: [
  channel_identification: boolean(),
  max_speaker_labels: integer(),
  show_speaker_labels: boolean(),
  vocabulary_name: binary()
]

Link to this section Functions

Link to this function

get_transcription_job(name) View Source
get_transcription_job(name :: binary()) :: ExAws.Operation.JSON.t()

Returns information about a transcription job.

Doc: https://docs.aws.amazon.com/transcribe/latest/dg/API_GetTranscriptionJob.html

Example:

  ExAws.Transcribe.get_transcription_job("Job1")
Link to this function

list_transcription_jobs(opts \\ []) View Source
list_transcription_jobs(opts :: list_transcription_jobs_opts()) ::
  ExAws.Operation.JSON.t()

Lists transcription jobs with the specified status.

Doc: https://docs.aws.amazon.com/transcribe/latest/dg/API_ListTranscriptionJobs.html

Examples:

  # List jobs
  ExAws.Transcribe.list_transcription_jobs()

  # List completed jobs
  ExAws.Transcribe.list_transcription_jobs(status: "COMPLETED")
Link to this function

start_transcription_job(name, uri, format, language, opts \\ []) View Source
start_transcription_job(
  name :: binary(),
  uri :: binary(),
  format :: binary(),
  language :: binary(),
  start_transcription_job_opts()
) :: ExAws.Operation.JSON.t()

Starts an asynchronous job to transcribe speech to text.

Doc: https://docs.aws.amazon.com/transcribe/latest/dg/API_StartTranscriptionJob.html

Example:

  Transcribe.start_transcription_job("MyJob", "s3://mybucket/myfile.mp3", "mp3", "en-US", settings: [show_speaker_labels: true])