View Source AWS.Transcribe (aws-elixir v0.11.0)

Operations and objects for transcribing speech to text.

Link to this section Summary

Functions

Creates a new custom language model.

Creates a new custom medical vocabulary.

Creates a new custom vocabulary.

Creates a new vocabulary filter that you can use to filter words from your transcription output.

Deletes a custom language model.

Deletes a medical transcription job, along with any related information.

Deletes a custom medical vocabulary.

Deletes a transcription job, along with any related information.

Provides information about a specific custom language model in your Amazon Web Services account.

Retrieves information about a call analytics category.

Retrieves information about a call analytics job.

Retrieves information about a medical transcription job.

Retrieves information about a medical vocabulary.

Returns information about a transcription job.

Gets information about a vocabulary.

Returns information about a vocabulary filter.

Provides more information about the call analytics categories that you've created.

List call analytics jobs with a specified status or substring that matches their names.

Provides more information about the custom language models you've created.

Lists medical transcription jobs with a specified status or substring that matches their names.

Returns a list of vocabularies that match the specified criteria.

Lists all tags associated with a given transcription job, vocabulary, or resource.

Lists transcription jobs with the specified status.

Returns a list of vocabularies that match the specified criteria.

Gets information about vocabulary filters.

Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but also returns additional insights.

Starts a batch job to transcribe medical speech to text.

Starts an asynchronous job to transcribe speech to text.

Tags an Amazon Transcribe resource with the given list of tags.

Removes specified tags from a specified Amazon Transcribe resource.

Updates the call analytics category with new values.

Updates a vocabulary with new values that you provide in a different text file from the one you used to create the vocabulary.

Updates an existing vocabulary with new values.

Updates a vocabulary filter with a new list of filtered words.

Link to this section Functions

Link to this function

create_call_analytics_category(client, input, options \\ [])

View Source

Creates a call analytics category.

Amazon Transcribe applies the conditions specified by your call analytics categories to your call analytics jobs. For each analytics category, you must create between 1 and 20 rules. For example, you can create a 'greeting' category with a rule that flags calls in which your agent does not use a specified phrase (for example: "Please note this call may be recorded.") in the first 15 seconds of the call. When you start a call analytics job, Amazon Transcribe applies all your existing call analytics categories to that job.

Link to this function

create_language_model(client, input, options \\ [])

View Source

Creates a new custom language model.

When creating a new language model, you must specify if you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model. You then include the S3 URI location of your training and tuning files, the language for the model, a unique name, and any tags you want associated with your model.

Link to this function

create_medical_vocabulary(client, input, options \\ [])

View Source

Creates a new custom medical vocabulary.

When creating a new medical vocabulary, you must upload a text file that contains your new entries, phrases, and terms into an S3 bucket. Note that this differs from , where you can include a list of terms within your request using the Phrases flag, as CreateMedicalVocabulary does not support the Phrases flag.

For more information on creating a custom vocabulary text file, see Creating a custom vocabulary.

Link to this function

create_vocabulary(client, input, options \\ [])

View Source

Creates a new custom vocabulary.

When creating a new medical vocabulary, you can either upload a text file that contains your new entries, phrases, and terms into an S3 bucket or include a list of terms directly in your request using the Phrases flag.

For more information on creating a custom vocabulary, see Creating a custom vocabulary.

Link to this function

create_vocabulary_filter(client, input, options \\ [])

View Source

Creates a new vocabulary filter that you can use to filter words from your transcription output.

For example, you can use this operation to remove profanity from your transcript.

Link to this function

delete_call_analytics_category(client, input, options \\ [])

View Source

Deletes a call analytics category.

To use this operation, specify the name of the category you want to delete using CategoryName.

Link to this function

delete_call_analytics_job(client, input, options \\ [])

View Source

Deletes a call analytics job.

To use this operation, specify the name of the job you want to delete using CallAnalyticsJobName.

Link to this function

delete_language_model(client, input, options \\ [])

View Source

Deletes a custom language model.

To use this operation, specify the name of the language model you want to delete using ModelName.

Link to this function

delete_medical_transcription_job(client, input, options \\ [])

View Source

Deletes a medical transcription job, along with any related information.

To use this operation, specify the name of the job you want to delete using MedicalTranscriptionJobName.

Link to this function

delete_medical_vocabulary(client, input, options \\ [])

View Source

Deletes a custom medical vocabulary.

To use this operation, specify the name of the vocabulary you want to delete using VocabularyName.

Link to this function

delete_transcription_job(client, input, options \\ [])

View Source

Deletes a transcription job, along with any related information.

To use this operation, specify the name of the job you want to delete using TranscriptionJobName.

Link to this function

delete_vocabulary(client, input, options \\ [])

View Source

Deletes a custom vocabulary.

To use this operation, specify the name of the vocabulary you want to delete using VocabularyName.

Link to this function

delete_vocabulary_filter(client, input, options \\ [])

View Source

Deletes a vocabulary filter.

To use this operation, specify the name of the vocabulary filter you want to delete using VocabularyFilterName.

Link to this function

describe_language_model(client, input, options \\ [])

View Source

Provides information about a specific custom language model in your Amazon Web Services account.

This operation also shows if the base language model you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model.

If you tried to create a new custom language model and the request wasn't successful, you can use this operation to help identify the reason.

Link to this function

get_call_analytics_category(client, input, options \\ [])

View Source

Retrieves information about a call analytics category.

Link to this function

get_call_analytics_job(client, input, options \\ [])

View Source

Retrieves information about a call analytics job.

To view the job's status, refer to the CallAnalyticsJobStatus field. If the status is COMPLETED, the job is finished. You can then find your transcript at the URI specified in the TranscriptFileUri field. If you enabled personally identifiable information (PII) redaction, the redacted transcript appears in the RedactedTranscriptFileUri field.

Link to this function

get_medical_transcription_job(client, input, options \\ [])

View Source

Retrieves information about a medical transcription job.

To view the job's status, refer to the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You can then find your transcript at the URI specified in the TranscriptFileUri field.

Link to this function

get_medical_vocabulary(client, input, options \\ [])

View Source

Retrieves information about a medical vocabulary.

Link to this function

get_transcription_job(client, input, options \\ [])

View Source

Returns information about a transcription job.

To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri.

Link to this function

get_vocabulary(client, input, options \\ [])

View Source

Gets information about a vocabulary.

Link to this function

get_vocabulary_filter(client, input, options \\ [])

View Source

Returns information about a vocabulary filter.

Link to this function

list_call_analytics_categories(client, input, options \\ [])

View Source

Provides more information about the call analytics categories that you've created.

You can use the information in this list to find a specific category. You can then use the operation to get more information about it.

Link to this function

list_call_analytics_jobs(client, input, options \\ [])

View Source

List call analytics jobs with a specified status or substring that matches their names.

Link to this function

list_language_models(client, input, options \\ [])

View Source

Provides more information about the custom language models you've created.

You can use the information in this list to find a specific custom language model. You can then use the operation to get more information about it.

Link to this function

list_medical_transcription_jobs(client, input, options \\ [])

View Source

Lists medical transcription jobs with a specified status or substring that matches their names.

Link to this function

list_medical_vocabularies(client, input, options \\ [])

View Source

Returns a list of vocabularies that match the specified criteria.

If you don't enter a value in any of the request parameters, returns the entire list of vocabularies.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Lists all tags associated with a given transcription job, vocabulary, or resource.

Link to this function

list_transcription_jobs(client, input, options \\ [])

View Source

Lists transcription jobs with the specified status.

Link to this function

list_vocabularies(client, input, options \\ [])

View Source

Returns a list of vocabularies that match the specified criteria.

If no criteria are specified, returns the entire list of vocabularies.

Link to this function

list_vocabulary_filters(client, input, options \\ [])

View Source

Gets information about vocabulary filters.

Link to this function

start_call_analytics_job(client, input, options \\ [])

View Source

Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but also returns additional insights.

These insights include how quickly or loudly the caller or agent was speaking. To retrieve additional insights with your analytics jobs, create categories. A category is a way to classify analytics jobs based on attributes, such as a customer's sentiment or a particular phrase being used during the call. For more information, see the operation.

Link to this function

start_medical_transcription_job(client, input, options \\ [])

View Source

Starts a batch job to transcribe medical speech to text.

Link to this function

start_transcription_job(client, input, options \\ [])

View Source

Starts an asynchronous job to transcribe speech to text.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Tags an Amazon Transcribe resource with the given list of tags.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes specified tags from a specified Amazon Transcribe resource.

Link to this function

update_call_analytics_category(client, input, options \\ [])

View Source

Updates the call analytics category with new values.

The UpdateCallAnalyticsCategory operation overwrites all of the existing information with the values that you provide in the request.

Link to this function

update_medical_vocabulary(client, input, options \\ [])

View Source

Updates a vocabulary with new values that you provide in a different text file from the one you used to create the vocabulary.

The UpdateMedicalVocabulary operation overwrites all of the existing information with the values that you provide in the request.

Link to this function

update_vocabulary(client, input, options \\ [])

View Source

Updates an existing vocabulary with new values.

The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request.

Link to this function

update_vocabulary_filter(client, input, options \\ [])

View Source

Updates a vocabulary filter with a new list of filtered words.