Class: Aws::TranscribeService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::TranscribeService::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb
Overview
An API client for TranscribeService. To construct a client, you need to configure a :region and :credentials.
client = Aws::TranscribeService::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_call_analytics_category(params = {}) ⇒ Types::CreateCallAnalyticsCategoryResponse
Creates a new Call Analytics category.
-
#create_language_model(params = {}) ⇒ Types::CreateLanguageModelResponse
Creates a new custom language model.
-
#create_medical_vocabulary(params = {}) ⇒ Types::CreateMedicalVocabularyResponse
Creates a new custom medical vocabulary.
-
#create_vocabulary(params = {}) ⇒ Types::CreateVocabularyResponse
Creates a new custom vocabulary.
-
#create_vocabulary_filter(params = {}) ⇒ Types::CreateVocabularyFilterResponse
Creates a new custom vocabulary filter.
-
#delete_call_analytics_category(params = {}) ⇒ Struct
Deletes a Call Analytics category.
-
#delete_call_analytics_job(params = {}) ⇒ Struct
Deletes a Call Analytics job.
-
#delete_language_model(params = {}) ⇒ Struct
Deletes a custom language model.
-
#delete_medical_scribe_job(params = {}) ⇒ Struct
Deletes a Medical Scribe job.
-
#delete_medical_transcription_job(params = {}) ⇒ Struct
Deletes a medical transcription job.
-
#delete_medical_vocabulary(params = {}) ⇒ Struct
Deletes a custom medical vocabulary.
-
#delete_transcription_job(params = {}) ⇒ Struct
Deletes a transcription job.
-
#delete_vocabulary(params = {}) ⇒ Struct
Deletes a custom vocabulary.
-
#delete_vocabulary_filter(params = {}) ⇒ Struct
Deletes a custom vocabulary filter.
-
#describe_language_model(params = {}) ⇒ Types::DescribeLanguageModelResponse
Provides information about the specified custom language model.
-
#get_call_analytics_category(params = {}) ⇒ Types::GetCallAnalyticsCategoryResponse
Provides information about the specified Call Analytics category.
-
#get_call_analytics_job(params = {}) ⇒ Types::GetCallAnalyticsJobResponse
Provides information about the specified Call Analytics job.
-
#get_medical_scribe_job(params = {}) ⇒ Types::GetMedicalScribeJobResponse
Provides information about the specified Medical Scribe job.
-
#get_medical_transcription_job(params = {}) ⇒ Types::GetMedicalTranscriptionJobResponse
Provides information about the specified medical transcription job.
-
#get_medical_vocabulary(params = {}) ⇒ Types::GetMedicalVocabularyResponse
Provides information about the specified custom medical vocabulary.
-
#get_transcription_job(params = {}) ⇒ Types::GetTranscriptionJobResponse
Provides information about the specified transcription job.
-
#get_vocabulary(params = {}) ⇒ Types::GetVocabularyResponse
Provides information about the specified custom vocabulary.
-
#get_vocabulary_filter(params = {}) ⇒ Types::GetVocabularyFilterResponse
Provides information about the specified custom vocabulary filter.
-
#list_call_analytics_categories(params = {}) ⇒ Types::ListCallAnalyticsCategoriesResponse
Provides a list of Call Analytics categories, including all rules that make up each category.
-
#list_call_analytics_jobs(params = {}) ⇒ Types::ListCallAnalyticsJobsResponse
Provides a list of Call Analytics jobs that match the specified criteria.
-
#list_language_models(params = {}) ⇒ Types::ListLanguageModelsResponse
Provides a list of custom language models that match the specified criteria.
-
#list_medical_scribe_jobs(params = {}) ⇒ Types::ListMedicalScribeJobsResponse
Provides a list of Medical Scribe jobs that match the specified criteria.
-
#list_medical_transcription_jobs(params = {}) ⇒ Types::ListMedicalTranscriptionJobsResponse
Provides a list of medical transcription jobs that match the specified criteria.
-
#list_medical_vocabularies(params = {}) ⇒ Types::ListMedicalVocabulariesResponse
Provides a list of custom medical vocabularies that match the specified criteria.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags associated with the specified transcription job, vocabulary, model, or resource.
-
#list_transcription_jobs(params = {}) ⇒ Types::ListTranscriptionJobsResponse
Provides a list of transcription jobs that match the specified criteria.
-
#list_vocabularies(params = {}) ⇒ Types::ListVocabulariesResponse
Provides a list of custom vocabularies that match the specified criteria.
-
#list_vocabulary_filters(params = {}) ⇒ Types::ListVocabularyFiltersResponse
Provides a list of custom vocabulary filters that match the specified criteria.
-
#start_call_analytics_job(params = {}) ⇒ Types::StartCallAnalyticsJobResponse
Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request.
-
#start_medical_scribe_job(params = {}) ⇒ Types::StartMedicalScribeJobResponse
Transcribes patient-clinician conversations and generates clinical notes.
-
#start_medical_transcription_job(params = {}) ⇒ Types::StartMedicalTranscriptionJobResponse
Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request.
-
#start_transcription_job(params = {}) ⇒ Types::StartTranscriptionJobResponse
Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request.
-
#tag_resource(params = {}) ⇒ Struct
Adds one or more custom tags, each in the form of a key:value pair, to the specified resource.
-
#transcribe_audio(params = {}) ⇒ Types::TranscribeAudioResponse
Transcribes a media file and returns the transcript in the same response.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified Amazon Transcribe resource.
-
#update_call_analytics_category(params = {}) ⇒ Types::UpdateCallAnalyticsCategoryResponse
Updates the specified Call Analytics category with new rules.
-
#update_language_model(params = {}) ⇒ Types::UpdateLanguageModelResponse
Updates the encryption configuration for an existing custom language model.
-
#update_medical_vocabulary(params = {}) ⇒ Types::UpdateMedicalVocabularyResponse
Updates an existing custom medical vocabulary with new values.
-
#update_vocabulary(params = {}) ⇒ Types::UpdateVocabularyResponse
Updates an existing custom vocabulary with new values.
-
#update_vocabulary_filter(params = {}) ⇒ Types::UpdateVocabularyFilterResponse
Updates an existing custom vocabulary filter with a new list of words.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
486 487 488 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 486 def initialize(*args) super end |
Instance Method Details
#create_call_analytics_category(params = {}) ⇒ Types::CreateCallAnalyticsCategoryResponse
Creates a new Call Analytics category.
All categories are automatically applied to your Call Analytics transcriptions. Note that in order to apply categories to your transcriptions, you must create them before submitting your transcription request, as categories cannot be applied retroactively.
When creating a new category, you can use the InputType parameter to
label the category as a POST_CALL or a REAL_TIME category.
POST_CALL categories can only be applied to post-call transcriptions
and REAL_TIME categories can only be applied to real-time
transcriptions. If you do not include InputType, your category is
created as a POST_CALL category by default.
Call Analytics categories are composed of rules. For each category, you must create between 1 and 20 rules. Rules can include these parameters: , , , and .
To update an existing category, see .
To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.
714 715 716 717 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 714 def create_call_analytics_category(params = {}, = {}) req = build_request(:create_call_analytics_category, params) req.send_request() end |
#create_language_model(params = {}) ⇒ Types::CreateLanguageModelResponse
Creates a new custom language model.
When creating a new custom 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
The location of your training and tuning files (this must be an Amazon S3 URI)
The language of your model
A unique name for your model
847 848 849 850 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 847 def create_language_model(params = {}, = {}) req = build_request(:create_language_model, params) req.send_request() end |
#create_medical_vocabulary(params = {}) ⇒ Types::CreateMedicalVocabularyResponse
Creates a new custom medical vocabulary.
Before creating a new custom medical vocabulary, you must first upload
a text file that contains your vocabulary table into an Amazon S3
bucket. Note that this differs from , where you can include a list of
terms within your request using the Phrases flag;
CreateMedicalVocabulary does not support the Phrases flag and only
accepts vocabularies in table format.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
For more information, see Custom vocabularies.
940 941 942 943 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 940 def create_medical_vocabulary(params = {}, = {}) req = build_request(:create_medical_vocabulary, params) req.send_request() end |
#create_vocabulary(params = {}) ⇒ Types::CreateVocabularyResponse
Creates a new custom vocabulary.
When creating a new custom vocabulary, you can either upload a text
file that contains your new entries, phrases, and terms into an Amazon
S3 bucket and include the URI in your request. Or you can include a
list of terms directly in your request using the Phrases flag.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
For more information, see Custom vocabularies.
1097 1098 1099 1100 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1097 def create_vocabulary(params = {}, = {}) req = build_request(:create_vocabulary, params) req.send_request() end |
#create_vocabulary_filter(params = {}) ⇒ Types::CreateVocabularyFilterResponse
Creates a new custom vocabulary filter.
You can use custom vocabulary filters to mask, delete, or flag specific words from your transcript. Custom vocabulary filters are commonly used to mask profanity in transcripts.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
For more information, see Vocabulary filtering.
1250 1251 1252 1253 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1250 def create_vocabulary_filter(params = {}, = {}) req = build_request(:create_vocabulary_filter, params) req.send_request() end |
#delete_call_analytics_category(params = {}) ⇒ Struct
Deletes a Call Analytics category. To use this operation, specify the
name of the category you want to delete using CategoryName. Category
names are case sensitive.
1275 1276 1277 1278 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1275 def delete_call_analytics_category(params = {}, = {}) req = build_request(:delete_call_analytics_category, params) req.send_request() end |
#delete_call_analytics_job(params = {}) ⇒ Struct
Deletes a Call Analytics job. To use this operation, specify the name
of the job you want to delete using CallAnalyticsJobName. Job names
are case sensitive.
1300 1301 1302 1303 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1300 def delete_call_analytics_job(params = {}, = {}) req = build_request(:delete_call_analytics_job, params) req.send_request() end |
#delete_language_model(params = {}) ⇒ Struct
Deletes a custom language model. To use this operation, specify the
name of the language model you want to delete using ModelName.
custom language model names are case sensitive.
1325 1326 1327 1328 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1325 def delete_language_model(params = {}, = {}) req = build_request(:delete_language_model, params) req.send_request() end |
#delete_medical_scribe_job(params = {}) ⇒ Struct
Deletes a Medical Scribe job. To use this operation, specify the name
of the job you want to delete using MedicalScribeJobName. Job names
are case sensitive.
1350 1351 1352 1353 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1350 def delete_medical_scribe_job(params = {}, = {}) req = build_request(:delete_medical_scribe_job, params) req.send_request() end |
#delete_medical_transcription_job(params = {}) ⇒ Struct
Deletes a medical transcription job. To use this operation, specify
the name of the job you want to delete using
MedicalTranscriptionJobName. Job names are case sensitive.
1375 1376 1377 1378 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1375 def delete_medical_transcription_job(params = {}, = {}) req = build_request(:delete_medical_transcription_job, params) req.send_request() end |
#delete_medical_vocabulary(params = {}) ⇒ Struct
Deletes a custom medical vocabulary. To use this operation, specify
the name of the custom vocabulary you want to delete using
VocabularyName. Custom vocabulary names are case sensitive.
1400 1401 1402 1403 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1400 def delete_medical_vocabulary(params = {}, = {}) req = build_request(:delete_medical_vocabulary, params) req.send_request() end |
#delete_transcription_job(params = {}) ⇒ Struct
Deletes a transcription job. To use this operation, specify the name
of the job you want to delete using TranscriptionJobName. Job names
are case sensitive.
1425 1426 1427 1428 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1425 def delete_transcription_job(params = {}, = {}) req = build_request(:delete_transcription_job, params) req.send_request() end |
#delete_vocabulary(params = {}) ⇒ Struct
Deletes a custom vocabulary. To use this operation, specify the name
of the custom vocabulary you want to delete using VocabularyName.
Custom vocabulary names are case sensitive.
1450 1451 1452 1453 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1450 def delete_vocabulary(params = {}, = {}) req = build_request(:delete_vocabulary, params) req.send_request() end |
#delete_vocabulary_filter(params = {}) ⇒ Struct
Deletes a custom vocabulary filter. To use this operation, specify the
name of the custom vocabulary filter you want to delete using
VocabularyFilterName. Custom vocabulary filter names are case
sensitive.
1476 1477 1478 1479 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1476 def delete_vocabulary_filter(params = {}, = {}) req = build_request(:delete_vocabulary_filter, params) req.send_request() end |
#describe_language_model(params = {}) ⇒ Types::DescribeLanguageModelResponse
Provides information about the specified custom language model.
This operation also shows if the base language model that 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 DescribeLanguageModel to help
identify the reason for this failure.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- language_model_completed
1532 1533 1534 1535 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1532 def describe_language_model(params = {}, = {}) req = build_request(:describe_language_model, params) req.send_request() end |
#get_call_analytics_category(params = {}) ⇒ Types::GetCallAnalyticsCategoryResponse
Provides information about the specified Call Analytics category.
To get a list of your Call Analytics categories, use the operation.
1616 1617 1618 1619 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1616 def get_call_analytics_category(params = {}, = {}) req = build_request(:get_call_analytics_category, params) req.send_request() end |
#get_call_analytics_job(params = {}) ⇒ Types::GetCallAnalyticsJobResponse
Provides information about the specified Call Analytics job.
To view the job's status, refer to CallAnalyticsJobStatus. If the
status is COMPLETED, the job is finished. You can find your
completed transcript at the URI specified in TranscriptFileUri. If
the status is FAILED, FailureReason provides details on why your
transcription job failed.
If you enabled personally identifiable information (PII) redaction,
the redacted transcript appears at the location specified in
RedactedTranscriptFileUri.
If you chose to redact the audio in your media file, you can find your
redacted media file at the location specified in
RedactedMediaFileUri.
To get a list of your Call Analytics jobs, use the operation.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- call_analytics_job_completed
1705 1706 1707 1708 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1705 def get_call_analytics_job(params = {}, = {}) req = build_request(:get_call_analytics_job, params) req.send_request() end |
#get_medical_scribe_job(params = {}) ⇒ Types::GetMedicalScribeJobResponse
Provides information about the specified Medical Scribe job.
To view the status of the specified medical transcription job, check
the MedicalScribeJobStatus field. If the status is COMPLETED, the
job is finished. You can find the results at the location specified in
MedicalScribeOutput. If the status is FAILED, FailureReason
provides details on why your Medical Scribe job failed.
To get a list of your Medical Scribe jobs, use the operation.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- medical_scribe_job_completed
1772 1773 1774 1775 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1772 def get_medical_scribe_job(params = {}, = {}) req = build_request(:get_medical_scribe_job, params) req.send_request() end |
#get_medical_transcription_job(params = {}) ⇒ Types::GetMedicalTranscriptionJobResponse
Provides information about the specified medical transcription job.
To view the status of the specified medical transcription job, check
the TranscriptionJobStatus field. If the status is COMPLETED, the
job is finished. You can find the results at the location specified in
TranscriptFileUri. If the status is FAILED, FailureReason
provides details on why your transcription job failed.
To get a list of your medical transcription jobs, use the operation.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- medical_transcription_job_completed
1837 1838 1839 1840 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1837 def get_medical_transcription_job(params = {}, = {}) req = build_request(:get_medical_transcription_job, params) req.send_request() end |
#get_medical_vocabulary(params = {}) ⇒ Types::GetMedicalVocabularyResponse
Provides information about the specified custom medical vocabulary.
To view the status of the specified custom medical vocabulary, check
the VocabularyState field. If the status is READY, your custom
vocabulary is available to use. If the status is FAILED,
FailureReason provides details on why your vocabulary failed.
To get a list of your custom medical vocabularies, use the operation.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- medical_vocabulary_ready
1888 1889 1890 1891 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1888 def get_medical_vocabulary(params = {}, = {}) req = build_request(:get_medical_vocabulary, params) req.send_request() end |
#get_transcription_job(params = {}) ⇒ Types::GetTranscriptionJobResponse
Provides information about the specified transcription job.
To view the status of the specified transcription job, check the
TranscriptionJobStatus field. If the status is COMPLETED, the job
is finished. You can find the results at the location specified in
TranscriptFileUri. If the status is FAILED, FailureReason
provides details on why your transcription job failed.
If you enabled content redaction, the redacted transcript can be found
at the location specified in RedactedTranscriptFileUri.
To get a list of your transcription jobs, use the operation.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- transcription_job_completed
1983 1984 1985 1986 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1983 def get_transcription_job(params = {}, = {}) req = build_request(:get_transcription_job, params) req.send_request() end |
#get_vocabulary(params = {}) ⇒ Types::GetVocabularyResponse
Provides information about the specified custom vocabulary.
To view the status of the specified custom vocabulary, check the
VocabularyState field. If the status is READY, your custom
vocabulary is available to use. If the status is FAILED,
FailureReason provides details on why your custom vocabulary failed.
To get a list of your custom vocabularies, use the operation.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- vocabulary_ready
2040 2041 2042 2043 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2040 def get_vocabulary(params = {}, = {}) req = build_request(:get_vocabulary, params) req.send_request() end |
#get_vocabulary_filter(params = {}) ⇒ Types::GetVocabularyFilterResponse
Provides information about the specified custom vocabulary filter.
To get a list of your custom vocabulary filters, use the operation.
2083 2084 2085 2086 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2083 def get_vocabulary_filter(params = {}, = {}) req = build_request(:get_vocabulary_filter, params) req.send_request() end |
#list_call_analytics_categories(params = {}) ⇒ Types::ListCallAnalyticsCategoriesResponse
Provides a list of Call Analytics categories, including all rules that make up each category.
To get detailed information about a specific Call Analytics category, use the operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2184 2185 2186 2187 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2184 def list_call_analytics_categories(params = {}, = {}) req = build_request(:list_call_analytics_categories, params) req.send_request() end |
#list_call_analytics_jobs(params = {}) ⇒ Types::ListCallAnalyticsJobsResponse
Provides a list of Call Analytics jobs that match the specified criteria. If no criteria are specified, all Call Analytics jobs are returned.
To get detailed information about a specific Call Analytics job, use the operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2256 2257 2258 2259 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2256 def list_call_analytics_jobs(params = {}, = {}) req = build_request(:list_call_analytics_jobs, params) req.send_request() end |
#list_language_models(params = {}) ⇒ Types::ListLanguageModelsResponse
Provides a list of custom language models that match the specified criteria. If no criteria are specified, all custom language models are returned.
To get detailed information about a specific custom language model, use the operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2330 2331 2332 2333 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2330 def list_language_models(params = {}, = {}) req = build_request(:list_language_models, params) req.send_request() end |
#list_medical_scribe_jobs(params = {}) ⇒ Types::ListMedicalScribeJobsResponse
Provides a list of Medical Scribe jobs that match the specified criteria. If no criteria are specified, all Medical Scribe jobs are returned.
To get detailed information about a specific Medical Scribe job, use the operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2398 2399 2400 2401 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2398 def list_medical_scribe_jobs(params = {}, = {}) req = build_request(:list_medical_scribe_jobs, params) req.send_request() end |
#list_medical_transcription_jobs(params = {}) ⇒ Types::ListMedicalTranscriptionJobsResponse
Provides a list of medical transcription jobs that match the specified criteria. If no criteria are specified, all medical transcription jobs are returned.
To get detailed information about a specific medical transcription job, use the operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2470 2471 2472 2473 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2470 def list_medical_transcription_jobs(params = {}, = {}) req = build_request(:list_medical_transcription_jobs, params) req.send_request() end |
#list_medical_vocabularies(params = {}) ⇒ Types::ListMedicalVocabulariesResponse
Provides a list of custom medical vocabularies that match the specified criteria. If no criteria are specified, all custom medical vocabularies are returned.
To get detailed information about a specific custom medical vocabulary, use the operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2536 2537 2538 2539 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2536 def list_medical_vocabularies(params = {}, = {}) req = build_request(:list_medical_vocabularies, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags associated with the specified transcription job, vocabulary, model, or resource.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
2585 2586 2587 2588 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2585 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_transcription_jobs(params = {}) ⇒ Types::ListTranscriptionJobsResponse
Provides a list of transcription jobs that match the specified criteria. If no criteria are specified, all transcription jobs are returned.
To get detailed information about a specific transcription job, use the operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2668 2669 2670 2671 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2668 def list_transcription_jobs(params = {}, = {}) req = build_request(:list_transcription_jobs, params) req.send_request() end |
#list_vocabularies(params = {}) ⇒ Types::ListVocabulariesResponse
Provides a list of custom vocabularies that match the specified criteria. If no criteria are specified, all custom vocabularies are returned.
To get detailed information about a specific custom vocabulary, use the operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2734 2735 2736 2737 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2734 def list_vocabularies(params = {}, = {}) req = build_request(:list_vocabularies, params) req.send_request() end |
#list_vocabulary_filters(params = {}) ⇒ Types::ListVocabularyFiltersResponse
Provides a list of custom vocabulary filters that match the specified criteria. If no criteria are specified, all custom vocabularies are returned.
To get detailed information about a specific custom vocabulary filter, use the operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2790 2791 2792 2793 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2790 def list_vocabulary_filters(params = {}, = {}) req = build_request(:list_vocabulary_filters, params) req.send_request() end |
#start_call_analytics_job(params = {}) ⇒ Types::StartCallAnalyticsJobResponse
Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request.
In addition to many standard transcription features, Call Analytics provides you with call characteristics, call summarization, speaker sentiment, and optional redaction of your text transcript and your audio file. You can also apply custom categories to flag specified conditions. To learn more about these features and insights, refer to Analyzing call center audio with Call Analytics.
If you want to apply categories to your Call Analytics job, you must create them before submitting your job request. Categories cannot be retroactively applied to a job. To create a new category, use the operation. To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.
To make a StartCallAnalyticsJob request, you must first upload your
media file into an Amazon S3 bucket; you can then specify the Amazon
S3 location of the file using the Media parameter.
Job queuing is available for Call Analytics jobs. If you pass a
DataAccessRoleArn in your request and you exceed your Concurrent Job
Limit, your job will automatically be added to a queue to be processed
once your concurrent job count is below the limit.
You must include the following parameters in your
StartCallAnalyticsJob request:
region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.CallAnalyticsJobName: A custom name that you create for your transcription job that's unique within your Amazon Web Services account.Media(MediaFileUriorRedactedMediaFileUri): The Amazon S3 location of your media file.
RedactedMediaFileUri, instead of MediaFileUri,
to specify the location of your input audio. If you choose to redact
your audio, you can find your redacted media at the location specified
in the RedactedMediaFileUri field of your response.
3045 3046 3047 3048 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 3045 def start_call_analytics_job(params = {}, = {}) req = build_request(:start_call_analytics_job, params) req.send_request() end |
#start_medical_scribe_job(params = {}) ⇒ Types::StartMedicalScribeJobResponse
Transcribes patient-clinician conversations and generates clinical notes.
Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, classifies dialogues, extracts medical terms, and generates preliminary clinical notes. To learn more about these features, refer to Amazon Web Services HealthScribe.
To make a StartMedicalScribeJob request, you must first upload your
media file into an Amazon S3 bucket; you can then specify the Amazon
S3 location of the file using the Media parameter.
You must include the following parameters in your
StartMedicalTranscriptionJob request:
DataAccessRoleArn: The ARN of an IAM role with the these minimum permissions: read permission on input file Amazon S3 bucket specified inMedia, write permission on the Amazon S3 bucket specified inOutputBucketName, and full permissions on the KMS key specified inOutputEncryptionKMSKeyId(if set). The role should also allowtranscribe.amazonaws.comto assume it.Media(MediaFileUri): The Amazon S3 location of your media file.MedicalScribeJobName: A custom name you create for your MedicalScribe job that is unique within your Amazon Web Services account.OutputBucketName: The Amazon S3 bucket where you want your output files stored.Settings: AMedicalScribeSettingsobject that must set exactly one ofShowSpeakerLabelsorChannelIdentificationto true. IfShowSpeakerLabelsis true,MaxSpeakerLabelsmust also be set.ChannelDefinitions: AMedicalScribeChannelDefinitionsarray should be set if and only if theChannelIdentificationvalue ofSettingsis set to true.
3296 3297 3298 3299 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 3296 def start_medical_scribe_job(params = {}, = {}) req = build_request(:start_medical_scribe_job, params) req.send_request() end |
#start_medical_transcription_job(params = {}) ⇒ Types::StartMedicalTranscriptionJobResponse
Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request.
In addition to many standard transcription features, Amazon Transcribe Medical provides you with a robust medical vocabulary and, optionally, content identification, which adds flags to personal health information (PHI). To learn more about these features, refer to How Amazon Transcribe Medical works.
To make a StartMedicalTranscriptionJob request, you must first
upload your media file into an Amazon S3 bucket; you can then specify
the Amazon S3 location of the file using the Media parameter.
You must include the following parameters in your
StartMedicalTranscriptionJob request:
region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.MedicalTranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account.Media(MediaFileUri): The Amazon S3 location of your media file.LanguageCode: This must been-US.OutputBucketName: The Amazon S3 bucket where you want your transcript stored. If you want your output stored in a sub-folder of this bucket, you must also includeOutputKey.Specialty: This must bePRIMARYCARE.Type: Choose whether your audio is a conversation or a dictation.
3589 3590 3591 3592 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 3589 def start_medical_transcription_job(params = {}, = {}) req = build_request(:start_medical_transcription_job, params) req.send_request() end |
#start_transcription_job(params = {}) ⇒ Types::StartTranscriptionJobResponse
Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request.
To make a StartTranscriptionJob request, you must first upload your
media file into an Amazon S3 bucket; you can then specify the Amazon
S3 location of the file using the Media parameter.
You must include the following parameters in your
StartTranscriptionJob request:
region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.TranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account.Media(MediaFileUri): The Amazon S3 location of your media file.One of
LanguageCode,IdentifyLanguage, orIdentifyMultipleLanguages: If you know the language of your media file, specify it using theLanguageCodeparameter; you can find all valid language codes in the Supported languages table. If you do not know the languages spoken in your media, use eitherIdentifyLanguageorIdentifyMultipleLanguagesand let Amazon Transcribe identify the languages for you.
4077 4078 4079 4080 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 4077 def start_transcription_job(params = {}, = {}) req = build_request(:start_transcription_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds one or more custom tags, each in the form of a key:value pair, to the specified resource.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
4133 4134 4135 4136 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 4133 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#transcribe_audio(params = {}) ⇒ Types::TranscribeAudioResponse
Transcribes a media file and returns the transcript in the same response. There is no job to start and no status to poll.
Use TranscribeAudio when you already have a complete media file and
want the transcript right away. For large files, long audio, or bulk
processing, use .
You must include the following parameters in your TranscribeAudio
request:
Media: Your audio, either as inline bytes (MediaBytes) or as the Amazon S3 location of a media file (MediaFileUri).One of
LanguageorLanguageDetectionMode: Specify the language of your audio, or have Amazon Transcribe identify it.
Your audio must be between 0.5 seconds and 1 hour long. Supported formats are WAV, MP3, FLAC, M4A, MP4, Ogg, WebM, and AMR.
If you send your audio in the request (MediaBytes), the file can be
up to 25 MB. If you provide an Amazon S3 location (MediaFileUri),
the file can be up to 500 MB.
Amazon Transcribe always turns on smart formatting, also known as inverse text normalization (ITN). It writes numbers, dates, currency, and similar items in their usual written form. For example, "one hundred" becomes "100". You can't turn smart formatting off.
By default, Amazon Transcribe returns the transcript in
TranscriptResponse. If you include OutputConfiguration, Amazon
Transcribe writes the transcript to the Amazon S3 location you specify
instead, and the response contains only that location.
4371 4372 4373 4374 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 4371 def transcribe_audio(params = {}, = {}) req = build_request(:transcribe_audio, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified Amazon Transcribe resource.
If you include UntagResource in your request, you must also include
ResourceArn and TagKeys.
4411 4412 4413 4414 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 4411 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_call_analytics_category(params = {}) ⇒ Types::UpdateCallAnalyticsCategoryResponse
Updates the specified Call Analytics category with new rules. Note
that the UpdateCallAnalyticsCategory operation overwrites all
existing rules contained in the specified category. You cannot append
additional rules onto an existing category.
To create a new category, see .
4583 4584 4585 4586 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 4583 def update_call_analytics_category(params = {}, = {}) req = build_request(:update_call_analytics_category, params) req.send_request() end |
#update_language_model(params = {}) ⇒ Types::UpdateLanguageModelResponse
Updates the encryption configuration for an existing custom language model. You can use this operation to change the KMS key used to encrypt your model artifacts. The model artifacts are re-encrypted in place. No model training is required.
Your custom language model must not be in the IN_PROGRESS state when
you call this operation. You cannot submit another update while a
previous update is in progress. Use to check the current state of your
model.
Your custom language model remains available for transcription jobs while the update is being processed.
4656 4657 4658 4659 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 4656 def update_language_model(params = {}, = {}) req = build_request(:update_language_model, params) req.send_request() end |
#update_medical_vocabulary(params = {}) ⇒ Types::UpdateMedicalVocabularyResponse
Updates an existing custom medical vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing custom vocabulary.
4708 4709 4710 4711 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 4708 def update_medical_vocabulary(params = {}, = {}) req = build_request(:update_medical_vocabulary, params) req.send_request() end |
#update_vocabulary(params = {}) ⇒ Types::UpdateVocabularyResponse
Updates an existing custom vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing custom vocabulary.
Your custom vocabulary must be in a terminal state (READY or
FAILED) before you can update it. You must include either Phrases
or VocabularyFileUri in your request.
4830 4831 4832 4833 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 4830 def update_vocabulary(params = {}, = {}) req = build_request(:update_vocabulary, params) req.send_request() end |
#update_vocabulary_filter(params = {}) ⇒ Types::UpdateVocabularyFilterResponse
Updates an existing custom vocabulary filter with a new list of words. The new list you provide overwrites all previous entries; you cannot append new terms onto an existing custom vocabulary filter.
You must include either Words or VocabularyFilterFileUri in your
request.
4932 4933 4934 4935 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 4932 def update_vocabulary_filter(params = {}, = {}) req = build_request(:update_vocabulary_filter, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success or :failure from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay and :max_attempts values.
| waiter_name | params | :delay | :max_attempts |
|---|---|---|---|
| call_analytics_job_completed | #get_call_analytics_job | 10 | 180 |
| language_model_completed | #describe_language_model | 120 | 180 |
| medical_scribe_job_completed | #get_medical_scribe_job | 10 | 180 |
| medical_transcription_job_completed | #get_medical_transcription_job | 10 | 180 |
| medical_vocabulary_ready | #get_medical_vocabulary | 10 | 180 |
| transcription_job_completed | #get_transcription_job | 10 | 180 |
| vocabulary_ready | #get_vocabulary | 10 | 180 |
5053 5054 5055 5056 5057 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 5053 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |