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_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_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_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_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.
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.
375 376 377 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 375 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 batch category (POST_CALL
) or a streaming
category (REAL_TIME
). Batch categories can only be applied to batch
transcriptions and streaming categories can only be applied to
streaming transcriptions. If you do not include InputType
, your
category is created as a batch 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 batch transcriptions and Creating categories for streaming transcriptions.
583 584 585 586 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 583 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
705 706 707 708 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 705 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 new entries, phrases, and terms 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.
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.
797 798 799 800 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 797 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.
924 925 926 927 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 924 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.
1046 1047 1048 1049 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1046 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.
1071 1072 1073 1074 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1071 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.
1096 1097 1098 1099 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1096 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.
1121 1122 1123 1124 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1121 def delete_language_model(params = {}, = {}) req = build_request(:delete_language_model, 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.
1146 1147 1148 1149 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1146 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.
1171 1172 1173 1174 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1171 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.
1196 1197 1198 1199 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1196 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.
1221 1222 1223 1224 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1221 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.
1247 1248 1249 1250 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1247 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.
1295 1296 1297 1298 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1295 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.
1376 1377 1378 1379 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1376 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.
1452 1453 1454 1455 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1452 def get_call_analytics_job(params = {}, = {}) req = build_request(:get_call_analytics_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.
1512 1513 1514 1515 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1512 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.
1558 1559 1560 1561 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1558 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.
1645 1646 1647 1648 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1645 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.
1691 1692 1693 1694 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1691 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.
1728 1729 1730 1731 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1728 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.
1826 1827 1828 1829 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1826 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.
1894 1895 1896 1897 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1894 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.
1965 1966 1967 1968 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 1965 def list_language_models(params = {}, = {}) req = build_request(:list_language_models, 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.
2037 2038 2039 2040 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2037 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.
2103 2104 2105 2106 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2103 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.
2152 2153 2154 2155 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2152 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.
2232 2233 2234 2235 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2232 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.
2298 2299 2300 2301 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2298 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.
2354 2355 2356 2357 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2354 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 batch transcriptions and Creating categories for streaming 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.
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
orRedactedMediaFileUri
): 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.
2598 2599 2600 2601 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2598 def start_call_analytics_job(params = {}, = {}) req = build_request(:start_call_analytics_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 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.
2911 2912 2913 2914 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 2911 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 theLanguageCode
parameter; you can find all valid language codes in the Supported languages table. If you don't know the languages spoken in your media, use eitherIdentifyLanguage
orIdentifyMultipleLanguages
and let Amazon Transcribe identify the languages for you.
3389 3390 3391 3392 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 3389 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.
3445 3446 3447 3448 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 3445 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
.
3485 3486 3487 3488 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 3485 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 .
3654 3655 3656 3657 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 3654 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.
3706 3707 3708 3709 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 3706 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.
3794 3795 3796 3797 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 3794 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.
3862 3863 3864 3865 |
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/client.rb', line 3862 def update_vocabulary_filter(params = {}, = {}) req = build_request(:update_vocabulary_filter, params) req.send_request() end |