Class: Aws::TranscribeService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::TranscribeService::Client
- Includes:
- ClientStubs
- Defined in:
- 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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
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.
-
#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_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.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
395 396 397 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 395 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
4424 4425 4426 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 4424 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
4427 4428 4429 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 4427 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 4402 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-transcribeservice' context[:gem_version] = '1.95.0' Seahorse::Client::Request.new(handlers, context) end |
#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].
[1]: docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html [2]: docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html
603 604 605 606 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 603 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
725 726 727 728 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 725 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].
[1]: docs.aws.amazon.com/transcribe/latest/dg/charsets.html [2]: docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html
818 819 820 821 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 818 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].
[1]: docs.aws.amazon.com/transcribe/latest/dg/charsets.html [2]: docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html
963 964 965 966 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 963 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].
[1]: docs.aws.amazon.com/transcribe/latest/dg/charsets.html [2]: docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html
1103 1104 1105 1106 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1103 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.
1128 1129 1130 1131 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1128 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.
1153 1154 1155 1156 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1153 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.
1178 1179 1180 1181 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1178 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.
1203 1204 1205 1206 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1203 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.
1228 1229 1230 1231 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1228 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.
1253 1254 1255 1256 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1253 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.
1278 1279 1280 1281 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1278 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.
1303 1304 1305 1306 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1303 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.
1329 1330 1331 1332 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1329 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.
1377 1378 1379 1380 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1377 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.
1458 1459 1460 1461 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1458 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.
1535 1536 1537 1538 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1535 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.
1595 1596 1597 1598 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1595 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.
1655 1656 1657 1658 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1655 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.
1701 1702 1703 1704 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1701 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.
1791 1792 1793 1794 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1791 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.
1837 1838 1839 1840 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1837 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.
1874 1875 1876 1877 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1874 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.
1972 1973 1974 1975 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 1972 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.
2040 2041 2042 2043 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 2040 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.
2111 2112 2113 2114 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 2111 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.
2179 2180 2181 2182 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 2179 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.
2251 2252 2253 2254 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 2251 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.
2317 2318 2319 2320 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 2317 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].
2366 2367 2368 2369 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 2366 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.
2449 2450 2451 2452 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 2449 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.
2515 2516 2517 2518 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 2515 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.
2571 2572 2573 2574 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 2571 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][2
-
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.
Note that job queuing is enabled by default for Call Analytics jobs.
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.
-
‘DataAccessRoleArn`: The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files.
-
‘Media` (`MediaFileUri` or `RedactedMediaFileUri`): The Amazon S3 location of your media file.
<note markdown=“1”> With Call Analytics, you can redact the audio contained in your media file by including ‘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.
</note>
[1]: docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html [2]: docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html [3]: docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html [4]: docs.aws.amazon.com/general/latest/gr/transcribe.html
2821 2822 2823 2824 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 2821 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 in `Media`, write permission on the Amazon S3 bucket specified in `OutputBucketName`, and full permissions on the KMS key specified in `OutputEncryptionKMSKeyId` (if set). The role should also allow `transcribe.amazonaws.com` to 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`: A `MedicalScribeSettings` obect that must set exactly one of `ShowSpeakerLabels` or `ChannelIdentification` to true. If `ShowSpeakerLabels` is true, `MaxSpeakerLabels` must also be set.
-
‘ChannelDefinitions`: A `MedicalScribeChannelDefinitions` array should be set if and only if the `ChannelIdentification` value of `Settings` is set to true.
[1]: docs.aws.amazon.com/transcribe/latest/dg/health-scribe.html
3072 3073 3074 3075 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 3072 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 be `en-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 include `OutputKey`.
-
‘Specialty`: This must be `PRIMARYCARE`.
-
‘Type`: Choose whether your audio is a conversation or a dictation.
[1]: docs.aws.amazon.com/transcribe/latest/dg/how-it-works-med.html [2]: docs.aws.amazon.com/general/latest/gr/transcribe.html
3384 3385 3386 3387 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 3384 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`, or `IdentifyMultipleLanguages`: If you know the language of your media file, specify it using the `LanguageCode` parameter; you can find all valid language codes in the [Supported languages] table. If you do not know the languages spoken in your media, use either `IdentifyLanguage` or `IdentifyMultipleLanguages` and let Amazon Transcribe identify the languages for you.
[1]: docs.aws.amazon.com/general/latest/gr/transcribe.html [2]: docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
3884 3885 3886 3887 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 3884 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].
3940 3941 3942 3943 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 3940 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, 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`.
3980 3981 3982 3983 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 3980 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 .
4149 4150 4151 4152 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 4149 def update_call_analytics_category(params = {}, = {}) req = build_request(:update_call_analytics_category, 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.
4201 4202 4203 4204 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 4201 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.
4307 4308 4309 4310 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 4307 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.
4393 4394 4395 4396 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 4393 def update_vocabulary_filter(params = {}, = {}) req = build_request(:update_vocabulary_filter, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
4417 4418 4419 |
# File 'lib/aws-sdk-transcribeservice/client.rb', line 4417 def waiter_names [] end |