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_language_model(params = {}) ⇒ Types::CreateLanguageModelResponse
Creates a new custom language model.
-
#create_medical_vocabulary(params = {}) ⇒ Types::CreateMedicalVocabularyResponse
Creates a new custom vocabulary that you can use to change how Amazon Transcribe Medical transcribes your audio file.
-
#create_vocabulary(params = {}) ⇒ Types::CreateVocabularyResponse
Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.
-
#create_vocabulary_filter(params = {}) ⇒ Types::CreateVocabularyFilterResponse
Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.
-
#delete_language_model(params = {}) ⇒ Struct
Deletes a custom language model using its name.
-
#delete_medical_transcription_job(params = {}) ⇒ Struct
Deletes a transcription job generated by Amazon Transcribe Medical and any related information.
-
#delete_medical_vocabulary(params = {}) ⇒ Struct
Deletes a vocabulary from Amazon Transcribe Medical.
-
#delete_transcription_job(params = {}) ⇒ Struct
Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.
-
#delete_vocabulary(params = {}) ⇒ Struct
Deletes a vocabulary from Amazon Transcribe.
-
#delete_vocabulary_filter(params = {}) ⇒ Struct
Removes a vocabulary filter.
-
#describe_language_model(params = {}) ⇒ Types::DescribeLanguageModelResponse
Gets information about a single custom language model.
-
#get_medical_transcription_job(params = {}) ⇒ Types::GetMedicalTranscriptionJobResponse
Returns information about a transcription job from Amazon Transcribe Medical.
-
#get_medical_vocabulary(params = {}) ⇒ Types::GetMedicalVocabularyResponse
Retrieves information about a medical vocabulary.
-
#get_transcription_job(params = {}) ⇒ Types::GetTranscriptionJobResponse
Returns information about a transcription job.
-
#get_vocabulary(params = {}) ⇒ Types::GetVocabularyResponse
Gets information about a vocabulary.
-
#get_vocabulary_filter(params = {}) ⇒ Types::GetVocabularyFilterResponse
Returns information about a vocabulary filter.
-
#list_language_models(params = {}) ⇒ Types::ListLanguageModelsResponse
Provides more information about the custom language models you've created.
-
#list_medical_transcription_jobs(params = {}) ⇒ Types::ListMedicalTranscriptionJobsResponse
Lists medical transcription jobs with a specified status or substring that matches their names.
-
#list_medical_vocabularies(params = {}) ⇒ Types::ListMedicalVocabulariesResponse
Returns a list of vocabularies that match the specified criteria.
-
#list_transcription_jobs(params = {}) ⇒ Types::ListTranscriptionJobsResponse
Lists transcription jobs with the specified status.
-
#list_vocabularies(params = {}) ⇒ Types::ListVocabulariesResponse
Returns a list of vocabularies that match the specified criteria.
-
#list_vocabulary_filters(params = {}) ⇒ Types::ListVocabularyFiltersResponse
Gets information about vocabulary filters.
-
#start_medical_transcription_job(params = {}) ⇒ Types::StartMedicalTranscriptionJobResponse
Starts a batch job to transcribe medical speech to text.
-
#start_transcription_job(params = {}) ⇒ Types::StartTranscriptionJobResponse
Starts an asynchronous job to transcribe speech to text.
-
#update_medical_vocabulary(params = {}) ⇒ Types::UpdateMedicalVocabularyResponse
Updates a vocabulary with new values that you provide in a different text file from the one you used to create the vocabulary.
-
#update_vocabulary(params = {}) ⇒ Types::UpdateVocabularyResponse
Updates an existing vocabulary with new values.
-
#update_vocabulary_filter(params = {}) ⇒ Types::UpdateVocabularyFilterResponse
Updates a vocabulary filter with a new list of filtered words.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
334 335 336 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#create_language_model(params = {}) ⇒ Types::CreateLanguageModelResponse
Creates a new custom language model. Use Amazon S3 prefixes to provide the location of your input files. The time it takes to create your model depends on the size of your training data.
400 401 402 403 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 400 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 vocabulary that you can use to change how Amazon Transcribe Medical transcribes your audio file.
474 475 476 477 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 474 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 that you can use to change the way Amazon Transcribe handles transcription of an audio file.
539 540 541 542 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 539 def create_vocabulary(params = {}, = {}) req = build_request(:create_vocabulary, params) req.send_request() end |
#create_vocabulary_filter(params = {}) ⇒ Types::CreateVocabularyFilterResponse
Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.
611 612 613 614 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 611 def create_vocabulary_filter(params = {}, = {}) req = build_request(:create_vocabulary_filter, params) req.send_request() end |
#delete_language_model(params = {}) ⇒ Struct
Deletes a custom language model using its name.
633 634 635 636 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 633 def delete_language_model(params = {}, = {}) req = build_request(:delete_language_model, params) req.send_request() end |
#delete_medical_transcription_job(params = {}) ⇒ Struct
Deletes a transcription job generated by Amazon Transcribe Medical and any related information.
657 658 659 660 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 657 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 vocabulary from Amazon Transcribe Medical.
679 680 681 682 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 679 def delete_medical_vocabulary(params = {}, = {}) req = build_request(:delete_medical_vocabulary, params) req.send_request() end |
#delete_transcription_job(params = {}) ⇒ Struct
Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.
702 703 704 705 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 702 def delete_transcription_job(params = {}, = {}) req = build_request(:delete_transcription_job, params) req.send_request() end |
#delete_vocabulary(params = {}) ⇒ Struct
Deletes a vocabulary from Amazon Transcribe.
724 725 726 727 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 724 def delete_vocabulary(params = {}, = {}) req = build_request(:delete_vocabulary, params) req.send_request() end |
#delete_vocabulary_filter(params = {}) ⇒ Struct
Removes a vocabulary filter.
746 747 748 749 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 746 def delete_vocabulary_filter(params = {}, = {}) req = build_request(:delete_vocabulary_filter, params) req.send_request() end |
#describe_language_model(params = {}) ⇒ Types::DescribeLanguageModelResponse
Gets information about a single custom language model. Use this information to see details about the language model in your AWS account. You can also see whether the base language model 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 the language model wasn't created, you can use this operation to understand why Amazon Transcribe couldn't create it.
792 793 794 795 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 792 def describe_language_model(params = {}, = {}) req = build_request(:describe_language_model, params) req.send_request() end |
#get_medical_transcription_job(params = {}) ⇒ Types::GetMedicalTranscriptionJobResponse
Returns information about a transcription job from Amazon Transcribe
Medical. To see the status of the job, check the
TranscriptionJobStatus
field. If the status is COMPLETED
, the job
is finished. You find the results of the completed job in the
TranscriptFileUri
field.
842 843 844 845 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 842 def get_medical_transcription_job(params = {}, = {}) req = build_request(:get_medical_transcription_job, params) req.send_request() end |
#get_medical_vocabulary(params = {}) ⇒ Types::GetMedicalVocabularyResponse
Retrieves information about a medical vocabulary.
881 882 883 884 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 881 def get_medical_vocabulary(params = {}, = {}) req = build_request(:get_medical_vocabulary, params) req.send_request() end |
#get_transcription_job(params = {}) ⇒ Types::GetTranscriptionJobResponse
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
.
942 943 944 945 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 942 def get_transcription_job(params = {}, = {}) req = build_request(:get_transcription_job, params) req.send_request() end |
#get_vocabulary(params = {}) ⇒ Types::GetVocabularyResponse
Gets information about a vocabulary.
981 982 983 984 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 981 def get_vocabulary(params = {}, = {}) req = build_request(:get_vocabulary, params) req.send_request() end |
#get_vocabulary_filter(params = {}) ⇒ Types::GetVocabularyFilterResponse
Returns information about a vocabulary filter.
1015 1016 1017 1018 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1015 def get_vocabulary_filter(params = {}, = {}) req = build_request(:get_vocabulary_filter, params) req.send_request() end |
#list_language_models(params = {}) ⇒ Types::ListLanguageModelsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1080 1081 1082 1083 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1080 def list_language_models(params = {}, = {}) req = build_request(:list_language_models, params) req.send_request() end |
#list_medical_transcription_jobs(params = {}) ⇒ Types::ListMedicalTranscriptionJobsResponse
Lists medical transcription jobs with a specified status or substring that matches their names.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1145 1146 1147 1148 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1145 def list_medical_transcription_jobs(params = {}, = {}) req = build_request(:list_medical_transcription_jobs, params) req.send_request() end |
#list_medical_vocabularies(params = {}) ⇒ Types::ListMedicalVocabulariesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1203 1204 1205 1206 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1203 def list_medical_vocabularies(params = {}, = {}) req = build_request(:list_medical_vocabularies, params) req.send_request() end |
#list_transcription_jobs(params = {}) ⇒ Types::ListTranscriptionJobsResponse
Lists transcription jobs with the specified status.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1269 1270 1271 1272 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1269 def list_transcription_jobs(params = {}, = {}) req = build_request(:list_transcription_jobs, params) req.send_request() end |
#list_vocabularies(params = {}) ⇒ Types::ListVocabulariesResponse
Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1327 1328 1329 1330 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1327 def list_vocabularies(params = {}, = {}) req = build_request(:list_vocabularies, params) req.send_request() end |
#list_vocabulary_filters(params = {}) ⇒ Types::ListVocabularyFiltersResponse
Gets information about vocabulary filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1375 1376 1377 1378 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1375 def list_vocabulary_filters(params = {}, = {}) req = build_request(:list_vocabulary_filters, params) req.send_request() end |
#start_medical_transcription_job(params = {}) ⇒ Types::StartMedicalTranscriptionJobResponse
Starts a batch job to transcribe medical speech to text.
1550 1551 1552 1553 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1550 def start_medical_transcription_job(params = {}, = {}) req = build_request(:start_medical_transcription_job, params) req.send_request() end |
#start_transcription_job(params = {}) ⇒ Types::StartTranscriptionJobResponse
Starts an asynchronous job to transcribe speech to text.
1768 1769 1770 1771 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1768 def start_transcription_job(params = {}, = {}) req = build_request(:start_transcription_job, params) req.send_request() end |
#update_medical_vocabulary(params = {}) ⇒ Types::UpdateMedicalVocabularyResponse
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.
1839 1840 1841 1842 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1839 def update_medical_vocabulary(params = {}, = {}) req = build_request(:update_medical_vocabulary, params) req.send_request() end |
#update_vocabulary(params = {}) ⇒ Types::UpdateVocabularyResponse
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.
1904 1905 1906 1907 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1904 def update_vocabulary(params = {}, = {}) req = build_request(:update_vocabulary, params) req.send_request() end |
#update_vocabulary_filter(params = {}) ⇒ Types::UpdateVocabularyFilterResponse
Updates a vocabulary filter with a new list of filtered words.
1968 1969 1970 1971 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1968 def update_vocabulary_filter(params = {}, = {}) req = build_request(:update_vocabulary_filter, params) req.send_request() end |