/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.transcribe; import javax.annotation.Generated; import com.amazonaws.services.transcribe.model.*; /** * Interface for accessing Amazon Transcribe Service asynchronously. Each asynchronous method will return a Java Future * object representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.transcribe.AbstractAmazonTranscribeAsync} instead. *
**
* Amazon Transcribe offers three main types of batch transcription: Standard, Medical, and Call * Analytics. *
** Standard transcriptions are the most common option. Refer to for details. *
** Medical transcriptions are tailored to medical professionals and incorporate medical terms. A common use case * for this service is transcribing doctor-patient dialogue into after-visit notes. Refer to for details. *
** Call Analytics transcriptions are designed for use with call center audio on two different channels; if you're * looking for insight into customer service calls, use this option. Refer to for details. *
** 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. *
* * @param createCallAnalyticsCategoryRequest * @return A Java Future containing the result of the CreateCallAnalyticsCategory operation returned by the service. * @sample AmazonTranscribeAsync.CreateCallAnalyticsCategory * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param createCallAnalyticsCategoryRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateCallAnalyticsCategory operation returned by the service. * @sample AmazonTranscribeAsyncHandler.CreateCallAnalyticsCategory * @see AWS API Documentation */ java.util.concurrent.Future* 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 *
** 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 *
** 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. *
* * @param createMedicalVocabularyRequest * @return A Java Future containing the result of the CreateMedicalVocabulary operation returned by the service. * @sample AmazonTranscribeAsync.CreateMedicalVocabulary * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param createMedicalVocabularyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateMedicalVocabulary operation returned by the service. * @sample AmazonTranscribeAsyncHandler.CreateMedicalVocabulary * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param createVocabularyRequest * @return A Java Future containing the result of the CreateVocabulary operation returned by the service. * @sample AmazonTranscribeAsync.CreateVocabulary * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param createVocabularyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateVocabulary operation returned by the service. * @sample AmazonTranscribeAsyncHandler.CreateVocabulary * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param createVocabularyFilterRequest * @return A Java Future containing the result of the CreateVocabularyFilter operation returned by the service. * @sample AmazonTranscribeAsync.CreateVocabularyFilter * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param createVocabularyFilterRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateVocabularyFilter operation returned by the service. * @sample AmazonTranscribeAsyncHandler.CreateVocabularyFilter * @see AWS API Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* Provides information about the specified Call Analytics category. *
** To get a list of your Call Analytics categories, use the operation. *
* * @param getCallAnalyticsCategoryRequest * @return A Java Future containing the result of the GetCallAnalyticsCategory operation returned by the service. * @sample AmazonTranscribeAsync.GetCallAnalyticsCategory * @see AWS API Documentation */ java.util.concurrent.Future* Provides information about the specified Call Analytics category. *
** To get a list of your Call Analytics categories, use the operation. *
* * @param getCallAnalyticsCategoryRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetCallAnalyticsCategory operation returned by the service. * @sample AmazonTranscribeAsyncHandler.GetCallAnalyticsCategory * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param getCallAnalyticsJobRequest * @return A Java Future containing the result of the GetCallAnalyticsJob operation returned by the service. * @sample AmazonTranscribeAsync.GetCallAnalyticsJob * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param getCallAnalyticsJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetCallAnalyticsJob operation returned by the service. * @sample AmazonTranscribeAsyncHandler.GetCallAnalyticsJob * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param getMedicalTranscriptionJobRequest * @return A Java Future containing the result of the GetMedicalTranscriptionJob operation returned by the service. * @sample AmazonTranscribeAsync.GetMedicalTranscriptionJob * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param getMedicalTranscriptionJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetMedicalTranscriptionJob operation returned by the service. * @sample AmazonTranscribeAsyncHandler.GetMedicalTranscriptionJob * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param getMedicalVocabularyRequest * @return A Java Future containing the result of the GetMedicalVocabulary operation returned by the service. * @sample AmazonTranscribeAsync.GetMedicalVocabulary * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param getMedicalVocabularyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetMedicalVocabulary operation returned by the service. * @sample AmazonTranscribeAsyncHandler.GetMedicalVocabulary * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param getTranscriptionJobRequest * @return A Java Future containing the result of the GetTranscriptionJob operation returned by the service. * @sample AmazonTranscribeAsync.GetTranscriptionJob * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param getTranscriptionJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetTranscriptionJob operation returned by the service. * @sample AmazonTranscribeAsyncHandler.GetTranscriptionJob * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param getVocabularyRequest * @return A Java Future containing the result of the GetVocabulary operation returned by the service. * @sample AmazonTranscribeAsync.GetVocabulary * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param getVocabularyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetVocabulary operation returned by the service. * @sample AmazonTranscribeAsyncHandler.GetVocabulary * @see AWS API * Documentation */ java.util.concurrent.Future* Provides information about the specified custom vocabulary filter. *
** To get a list of your custom vocabulary filters, use the operation. *
* * @param getVocabularyFilterRequest * @return A Java Future containing the result of the GetVocabularyFilter operation returned by the service. * @sample AmazonTranscribeAsync.GetVocabularyFilter * @see AWS * API Documentation */ java.util.concurrent.Future* Provides information about the specified custom vocabulary filter. *
** To get a list of your custom vocabulary filters, use the operation. *
* * @param getVocabularyFilterRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetVocabularyFilter operation returned by the service. * @sample AmazonTranscribeAsyncHandler.GetVocabularyFilter * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param listCallAnalyticsCategoriesRequest * @return A Java Future containing the result of the ListCallAnalyticsCategories operation returned by the service. * @sample AmazonTranscribeAsync.ListCallAnalyticsCategories * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listCallAnalyticsCategoriesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListCallAnalyticsCategories operation returned by the service. * @sample AmazonTranscribeAsyncHandler.ListCallAnalyticsCategories * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listCallAnalyticsJobsRequest * @return A Java Future containing the result of the ListCallAnalyticsJobs operation returned by the service. * @sample AmazonTranscribeAsync.ListCallAnalyticsJobs * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listCallAnalyticsJobsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListCallAnalyticsJobs operation returned by the service. * @sample AmazonTranscribeAsyncHandler.ListCallAnalyticsJobs * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listLanguageModelsRequest * @return A Java Future containing the result of the ListLanguageModels operation returned by the service. * @sample AmazonTranscribeAsync.ListLanguageModels * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param listLanguageModelsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListLanguageModels operation returned by the service. * @sample AmazonTranscribeAsyncHandler.ListLanguageModels * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param listMedicalTranscriptionJobsRequest * @return A Java Future containing the result of the ListMedicalTranscriptionJobs operation returned by the * service. * @sample AmazonTranscribeAsync.ListMedicalTranscriptionJobs * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listMedicalTranscriptionJobsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListMedicalTranscriptionJobs operation returned by the * service. * @sample AmazonTranscribeAsyncHandler.ListMedicalTranscriptionJobs * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listMedicalVocabulariesRequest * @return A Java Future containing the result of the ListMedicalVocabularies operation returned by the service. * @sample AmazonTranscribeAsync.ListMedicalVocabularies * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listMedicalVocabulariesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListMedicalVocabularies operation returned by the service. * @sample AmazonTranscribeAsyncHandler.ListMedicalVocabularies * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonTranscribeAsync.ListTagsForResource * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param listTagsForResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonTranscribeAsyncHandler.ListTagsForResource * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param listTranscriptionJobsRequest * @return A Java Future containing the result of the ListTranscriptionJobs operation returned by the service. * @sample AmazonTranscribeAsync.ListTranscriptionJobs * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listTranscriptionJobsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTranscriptionJobs operation returned by the service. * @sample AmazonTranscribeAsyncHandler.ListTranscriptionJobs * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listVocabulariesRequest * @return A Java Future containing the result of the ListVocabularies operation returned by the service. * @sample AmazonTranscribeAsync.ListVocabularies * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param listVocabulariesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListVocabularies operation returned by the service. * @sample AmazonTranscribeAsyncHandler.ListVocabularies * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param listVocabularyFiltersRequest * @return A Java Future containing the result of the ListVocabularyFilters operation returned by the service. * @sample AmazonTranscribeAsync.ListVocabularyFilters * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listVocabularyFiltersRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListVocabularyFilters operation returned by the service. * @sample AmazonTranscribeAsyncHandler.ListVocabularyFilters * @see AWS API Documentation */ java.util.concurrent.Future* Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to * include in your request. *
** In addition to many standard transcription features, Call Analytics provides you with call characteristics, call * summarization, speaker sentiment, and optional redaction of your text transcript and your audio file. You can * also apply custom categories to flag specified conditions. To learn more about these features and insights, refer * to Analyzing call center audio * with Call Analytics. *
** If you want to apply categories to your Call Analytics job, you must create them before submitting your job * request. Categories cannot be retroactively applied to a job. To create a new category, use the operation. To * learn more about Call Analytics categories, see Creating categories for * post-call transcriptions and Creating categories for * real-time transcriptions. *
*
* To make a StartCallAnalyticsJob
request, you must first upload your media file into an Amazon S3
* bucket; you can then specify the Amazon S3 location of the file using the Media
parameter.
*
* 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.
*
* 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.
*
* Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to * include in your request. *
** In addition to many standard transcription features, Call Analytics provides you with call characteristics, call * summarization, speaker sentiment, and optional redaction of your text transcript and your audio file. You can * also apply custom categories to flag specified conditions. To learn more about these features and insights, refer * to Analyzing call center audio * with Call Analytics. *
** If you want to apply categories to your Call Analytics job, you must create them before submitting your job * request. Categories cannot be retroactively applied to a job. To create a new category, use the operation. To * learn more about Call Analytics categories, see Creating categories for * post-call transcriptions and Creating categories for * real-time transcriptions. *
*
* To make a StartCallAnalyticsJob
request, you must first upload your media file into an Amazon S3
* bucket; you can then specify the Amazon S3 location of the file using the Media
parameter.
*
* 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.
*
* 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.
*
* 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 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.
*
* 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 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.
*
* 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 don't know the languages spoken in your media, use either IdentifyLanguage
or
* IdentifyMultipleLanguages
and let Amazon Transcribe identify the languages for you.
*
* 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 don't know the languages spoken in your media, use either IdentifyLanguage
or
* IdentifyMultipleLanguages
and let Amazon Transcribe identify the languages for you.
*
* 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. *
* * @param tagResourceRequest * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AmazonTranscribeAsync.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param tagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AmazonTranscribeAsyncHandler.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Removes the specified tags from the specified Amazon Transcribe resource. *
*
* If you include UntagResource
in your request, you must also include ResourceArn
and
* TagKeys
.
*
* Removes the specified tags from the specified Amazon Transcribe resource. *
*
* If you include UntagResource
in your request, you must also include ResourceArn
and
* TagKeys
.
*
* 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 . *
* * @param updateCallAnalyticsCategoryRequest * @return A Java Future containing the result of the UpdateCallAnalyticsCategory operation returned by the service. * @sample AmazonTranscribeAsync.UpdateCallAnalyticsCategory * @see AWS API Documentation */ java.util.concurrent.Future
* 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 . *
* * @param updateCallAnalyticsCategoryRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateCallAnalyticsCategory operation returned by the service. * @sample AmazonTranscribeAsyncHandler.UpdateCallAnalyticsCategory * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param updateMedicalVocabularyRequest * @return A Java Future containing the result of the UpdateMedicalVocabulary operation returned by the service. * @sample AmazonTranscribeAsync.UpdateMedicalVocabulary * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param updateMedicalVocabularyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateMedicalVocabulary operation returned by the service. * @sample AmazonTranscribeAsyncHandler.UpdateMedicalVocabulary * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param updateVocabularyRequest * @return A Java Future containing the result of the UpdateVocabulary operation returned by the service. * @sample AmazonTranscribeAsync.UpdateVocabulary * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param updateVocabularyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateVocabulary operation returned by the service. * @sample AmazonTranscribeAsyncHandler.UpdateVocabulary * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param updateVocabularyFilterRequest * @return A Java Future containing the result of the UpdateVocabularyFilter operation returned by the service. * @sample AmazonTranscribeAsync.UpdateVocabularyFilter * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param updateVocabularyFilterRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateVocabularyFilter operation returned by the service. * @sample AmazonTranscribeAsyncHandler.UpdateVocabularyFilter * @see AWS API Documentation */ java.util.concurrent.Future