public interface AmazonTranscribe
Operations and objects for transcribing speech to text.
Modifier and Type | Method and Description |
---|---|
CreateLanguageModelResult |
createLanguageModel(CreateLanguageModelRequest createLanguageModelRequest)
Creates a new custom language model.
|
CreateMedicalVocabularyResult |
createMedicalVocabulary(CreateMedicalVocabularyRequest createMedicalVocabularyRequest)
Creates a new custom vocabulary that you can use to change how Amazon
Transcribe Medical transcribes your audio file.
|
CreateVocabularyResult |
createVocabulary(CreateVocabularyRequest createVocabularyRequest)
Creates a new custom vocabulary that you can use to change the way Amazon
Transcribe handles transcription of an audio file.
|
CreateVocabularyFilterResult |
createVocabularyFilter(CreateVocabularyFilterRequest createVocabularyFilterRequest)
Creates a new vocabulary filter that you can use to filter words, such as
profane words, from the output of a transcription job.
|
void |
deleteLanguageModel(DeleteLanguageModelRequest deleteLanguageModelRequest)
Deletes a custom language model using its name.
|
void |
deleteMedicalTranscriptionJob(DeleteMedicalTranscriptionJobRequest deleteMedicalTranscriptionJobRequest)
Deletes a transcription job generated by Amazon Transcribe Medical and
any related information.
|
void |
deleteMedicalVocabulary(DeleteMedicalVocabularyRequest deleteMedicalVocabularyRequest)
Deletes a vocabulary from Amazon Transcribe Medical.
|
void |
deleteTranscriptionJob(DeleteTranscriptionJobRequest deleteTranscriptionJobRequest)
Deletes a previously submitted transcription job along with any other
generated results such as the transcription, models, and so on.
|
void |
deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest)
Deletes a vocabulary from Amazon Transcribe.
|
void |
deleteVocabularyFilter(DeleteVocabularyFilterRequest deleteVocabularyFilterRequest)
Removes a vocabulary filter.
|
DescribeLanguageModelResult |
describeLanguageModel(DescribeLanguageModelRequest describeLanguageModelRequest)
Gets information about a single custom language model.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request,
typically used for debugging issues where a service isn't acting as
expected.
|
GetMedicalTranscriptionJobResult |
getMedicalTranscriptionJob(GetMedicalTranscriptionJobRequest getMedicalTranscriptionJobRequest)
Returns information about a transcription job from Amazon Transcribe
Medical.
|
GetMedicalVocabularyResult |
getMedicalVocabulary(GetMedicalVocabularyRequest getMedicalVocabularyRequest)
Retrieves information about a medical vocabulary.
|
GetTranscriptionJobResult |
getTranscriptionJob(GetTranscriptionJobRequest getTranscriptionJobRequest)
Returns information about a transcription job.
|
GetVocabularyResult |
getVocabulary(GetVocabularyRequest getVocabularyRequest)
Gets information about a vocabulary.
|
GetVocabularyFilterResult |
getVocabularyFilter(GetVocabularyFilterRequest getVocabularyFilterRequest)
Returns information about a vocabulary filter.
|
ListLanguageModelsResult |
listLanguageModels(ListLanguageModelsRequest listLanguageModelsRequest)
Provides more information about the custom language models you've
created.
|
ListMedicalTranscriptionJobsResult |
listMedicalTranscriptionJobs(ListMedicalTranscriptionJobsRequest listMedicalTranscriptionJobsRequest)
Lists medical transcription jobs with a specified status or substring
that matches their names.
|
ListMedicalVocabulariesResult |
listMedicalVocabularies(ListMedicalVocabulariesRequest listMedicalVocabulariesRequest)
Returns a list of vocabularies that match the specified criteria.
|
ListTranscriptionJobsResult |
listTranscriptionJobs(ListTranscriptionJobsRequest listTranscriptionJobsRequest)
Lists transcription jobs with the specified status.
|
ListVocabulariesResult |
listVocabularies(ListVocabulariesRequest listVocabulariesRequest)
Returns a list of vocabularies that match the specified criteria.
|
ListVocabularyFiltersResult |
listVocabularyFilters(ListVocabularyFiltersRequest listVocabularyFiltersRequest)
Gets information about vocabulary filters.
|
void |
setEndpoint(java.lang.String endpoint)
Overrides the default endpoint for this client
("https://transcribe.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
setEndpoint(String) , sets the
regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartMedicalTranscriptionJobResult |
startMedicalTranscriptionJob(StartMedicalTranscriptionJobRequest startMedicalTranscriptionJobRequest)
Starts a batch job to transcribe medical speech to text.
|
StartTranscriptionJobResult |
startTranscriptionJob(StartTranscriptionJobRequest startTranscriptionJobRequest)
Starts an asynchronous job to transcribe speech to text.
|
UpdateMedicalVocabularyResult |
updateMedicalVocabulary(UpdateMedicalVocabularyRequest updateMedicalVocabularyRequest)
Updates a vocabulary with new values that you provide in a different text
file from the one you used to create the vocabulary.
|
UpdateVocabularyResult |
updateVocabulary(UpdateVocabularyRequest updateVocabularyRequest)
Updates an existing vocabulary with new values.
|
UpdateVocabularyFilterResult |
updateVocabularyFilter(UpdateVocabularyFilterRequest updateVocabularyFilterRequest)
Updates a vocabulary filter with a new list of filtered words.
|
void setEndpoint(java.lang.String endpoint) throws java.lang.IllegalArgumentException
Callers can pass in just the endpoint (ex:
"transcribe.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "https://transcribe.us-east-1.amazonaws.com"). If the
protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint
- The endpoint (ex: "transcribe.us-east-1.amazonaws.com")
or a full URL, including the protocol (ex:
"https://transcribe.us-east-1.amazonaws.com") of the region
specific AWS endpoint this client will communicate with.java.lang.IllegalArgumentException
- If any problems are detected with the
specified endpoint.void setRegion(Region region) throws java.lang.IllegalArgumentException
setEndpoint(String)
, sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region
- The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions)
for
accessing a given region.java.lang.IllegalArgumentException
- If the given region is null,
or if this service isn't available in the given region. See
Region.isServiceSupported(String)
Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
CreateLanguageModelResult createLanguageModel(CreateLanguageModelRequest createLanguageModelRequest) throws AmazonClientException, AmazonServiceException
Creates a new custom language model. Use Amazon S3 prefixes to provide the location of your input files. The time it takes to create your model depends on the size of your training data.
createLanguageModelRequest
- BadRequestException
LimitExceededException
InternalFailureException
ConflictException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.CreateMedicalVocabularyResult createMedicalVocabulary(CreateMedicalVocabularyRequest createMedicalVocabularyRequest) throws AmazonClientException, AmazonServiceException
Creates a new custom vocabulary that you can use to change how Amazon Transcribe Medical transcribes your audio file.
createMedicalVocabularyRequest
- BadRequestException
LimitExceededException
InternalFailureException
ConflictException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.CreateVocabularyResult createVocabulary(CreateVocabularyRequest createVocabularyRequest) throws AmazonClientException, AmazonServiceException
Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.
createVocabularyRequest
- BadRequestException
LimitExceededException
InternalFailureException
ConflictException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.CreateVocabularyFilterResult createVocabularyFilter(CreateVocabularyFilterRequest createVocabularyFilterRequest) throws AmazonClientException, AmazonServiceException
Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.
createVocabularyFilterRequest
- BadRequestException
LimitExceededException
InternalFailureException
ConflictException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.void deleteLanguageModel(DeleteLanguageModelRequest deleteLanguageModelRequest) throws AmazonClientException, AmazonServiceException
Deletes a custom language model using its name.
deleteLanguageModelRequest
- BadRequestException
LimitExceededException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.void deleteMedicalTranscriptionJob(DeleteMedicalTranscriptionJobRequest deleteMedicalTranscriptionJobRequest) throws AmazonClientException, AmazonServiceException
Deletes a transcription job generated by Amazon Transcribe Medical and any related information.
deleteMedicalTranscriptionJobRequest
- LimitExceededException
BadRequestException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.void deleteMedicalVocabulary(DeleteMedicalVocabularyRequest deleteMedicalVocabularyRequest) throws AmazonClientException, AmazonServiceException
Deletes a vocabulary from Amazon Transcribe Medical.
deleteMedicalVocabularyRequest
- NotFoundException
LimitExceededException
BadRequestException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.void deleteTranscriptionJob(DeleteTranscriptionJobRequest deleteTranscriptionJobRequest) throws AmazonClientException, AmazonServiceException
Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.
deleteTranscriptionJobRequest
- LimitExceededException
BadRequestException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.void deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest) throws AmazonClientException, AmazonServiceException
Deletes a vocabulary from Amazon Transcribe.
deleteVocabularyRequest
- NotFoundException
LimitExceededException
BadRequestException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.void deleteVocabularyFilter(DeleteVocabularyFilterRequest deleteVocabularyFilterRequest) throws AmazonClientException, AmazonServiceException
Removes a vocabulary filter.
deleteVocabularyFilterRequest
- NotFoundException
LimitExceededException
BadRequestException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.DescribeLanguageModelResult describeLanguageModel(DescribeLanguageModelRequest describeLanguageModelRequest) throws AmazonClientException, AmazonServiceException
Gets information about a single custom language model. Use this information to see details about the language model in your AWS account. You can also see whether the base language model used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model. If the language model wasn't created, you can use this operation to understand why Amazon Transcribe couldn't create it.
describeLanguageModelRequest
- BadRequestException
LimitExceededException
InternalFailureException
NotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.GetMedicalTranscriptionJobResult getMedicalTranscriptionJob(GetMedicalTranscriptionJobRequest getMedicalTranscriptionJobRequest) throws AmazonClientException, AmazonServiceException
Returns information about a transcription job from Amazon Transcribe
Medical. To see the status of the job, check the
TranscriptionJobStatus
field. If the status is
COMPLETED
, the job is finished. You find the results of the
completed job in the TranscriptFileUri
field.
getMedicalTranscriptionJobRequest
- BadRequestException
LimitExceededException
InternalFailureException
NotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.GetMedicalVocabularyResult getMedicalVocabulary(GetMedicalVocabularyRequest getMedicalVocabularyRequest) throws AmazonClientException, AmazonServiceException
Retrieves information about a medical vocabulary.
getMedicalVocabularyRequest
- NotFoundException
LimitExceededException
InternalFailureException
BadRequestException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.GetTranscriptionJobResult getTranscriptionJob(GetTranscriptionJobRequest getTranscriptionJobRequest) throws AmazonClientException, AmazonServiceException
Returns information about a transcription job. To see the status of the
job, check the TranscriptionJobStatus
field. If the status
is COMPLETED
, the job is finished and you can find the
results at the location specified in the TranscriptFileUri
field. If you enable content redaction, the redacted transcript appears
in RedactedTranscriptFileUri
.
getTranscriptionJobRequest
- BadRequestException
LimitExceededException
InternalFailureException
NotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.GetVocabularyResult getVocabulary(GetVocabularyRequest getVocabularyRequest) throws AmazonClientException, AmazonServiceException
Gets information about a vocabulary.
getVocabularyRequest
- NotFoundException
LimitExceededException
InternalFailureException
BadRequestException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.GetVocabularyFilterResult getVocabularyFilter(GetVocabularyFilterRequest getVocabularyFilterRequest) throws AmazonClientException, AmazonServiceException
Returns information about a vocabulary filter.
getVocabularyFilterRequest
- NotFoundException
LimitExceededException
InternalFailureException
BadRequestException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.ListLanguageModelsResult listLanguageModels(ListLanguageModelsRequest listLanguageModelsRequest) throws AmazonClientException, AmazonServiceException
Provides more information about the custom language models you've created. You can use the information in this list to find a specific custom language model. You can then use the operation to get more information about it.
listLanguageModelsRequest
- BadRequestException
LimitExceededException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.ListMedicalTranscriptionJobsResult listMedicalTranscriptionJobs(ListMedicalTranscriptionJobsRequest listMedicalTranscriptionJobsRequest) throws AmazonClientException, AmazonServiceException
Lists medical transcription jobs with a specified status or substring that matches their names.
listMedicalTranscriptionJobsRequest
- BadRequestException
LimitExceededException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.ListMedicalVocabulariesResult listMedicalVocabularies(ListMedicalVocabulariesRequest listMedicalVocabulariesRequest) throws AmazonClientException, AmazonServiceException
Returns a list of vocabularies that match the specified criteria. If you don't enter a value in any of the request parameters, returns the entire list of vocabularies.
listMedicalVocabulariesRequest
- BadRequestException
LimitExceededException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.ListTranscriptionJobsResult listTranscriptionJobs(ListTranscriptionJobsRequest listTranscriptionJobsRequest) throws AmazonClientException, AmazonServiceException
Lists transcription jobs with the specified status.
listTranscriptionJobsRequest
- BadRequestException
LimitExceededException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.ListVocabulariesResult listVocabularies(ListVocabulariesRequest listVocabulariesRequest) throws AmazonClientException, AmazonServiceException
Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.
listVocabulariesRequest
- BadRequestException
LimitExceededException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.ListVocabularyFiltersResult listVocabularyFilters(ListVocabularyFiltersRequest listVocabularyFiltersRequest) throws AmazonClientException, AmazonServiceException
Gets information about vocabulary filters.
listVocabularyFiltersRequest
- BadRequestException
LimitExceededException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.StartMedicalTranscriptionJobResult startMedicalTranscriptionJob(StartMedicalTranscriptionJobRequest startMedicalTranscriptionJobRequest) throws AmazonClientException, AmazonServiceException
Starts a batch job to transcribe medical speech to text.
startMedicalTranscriptionJobRequest
- BadRequestException
LimitExceededException
InternalFailureException
ConflictException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.StartTranscriptionJobResult startTranscriptionJob(StartTranscriptionJobRequest startTranscriptionJobRequest) throws AmazonClientException, AmazonServiceException
Starts an asynchronous job to transcribe speech to text.
startTranscriptionJobRequest
- BadRequestException
LimitExceededException
InternalFailureException
ConflictException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.UpdateMedicalVocabularyResult updateMedicalVocabulary(UpdateMedicalVocabularyRequest updateMedicalVocabularyRequest) throws AmazonClientException, AmazonServiceException
Updates a vocabulary with new values that you provide in a different text
file from the one you used to create the vocabulary. The
UpdateMedicalVocabulary
operation overwrites all of the
existing information with the values that you provide in the request.
updateMedicalVocabularyRequest
- BadRequestException
LimitExceededException
InternalFailureException
NotFoundException
ConflictException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.UpdateVocabularyResult updateVocabulary(UpdateVocabularyRequest updateVocabularyRequest) throws AmazonClientException, AmazonServiceException
Updates an existing vocabulary with new values. The
UpdateVocabulary
operation overwrites all of the existing
information with the values that you provide in the request.
updateVocabularyRequest
- BadRequestException
LimitExceededException
InternalFailureException
NotFoundException
ConflictException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.UpdateVocabularyFilterResult updateVocabularyFilter(UpdateVocabularyFilterRequest updateVocabularyFilterRequest) throws AmazonClientException, AmazonServiceException
Updates a vocabulary filter with a new list of filtered words.
updateVocabularyFilterRequest
- BadRequestException
LimitExceededException
InternalFailureException
NotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Transcribe indicating either a problem with the data in the
request, or a server side issue.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.