prowler-sdk-poc
Version:
728 lines (727 loc) • 125 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class TranscribeService extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: TranscribeService.Types.ClientConfiguration)
config: Config & TranscribeService.Types.ClientConfiguration;
/**
* Creates an analytics category. Amazon Transcribe applies the conditions specified by your analytics categories to your call analytics jobs. For each analytics category, you specify one or more rules. For example, you can specify a rule that the customer sentiment was neutral or negative within that category. If you start a call analytics job, Amazon Transcribe applies the category to the analytics job that you've specified.
*/
createCallAnalyticsCategory(params: TranscribeService.Types.CreateCallAnalyticsCategoryRequest, callback?: (err: AWSError, data: TranscribeService.Types.CreateCallAnalyticsCategoryResponse) => void): Request<TranscribeService.Types.CreateCallAnalyticsCategoryResponse, AWSError>;
/**
* Creates an analytics category. Amazon Transcribe applies the conditions specified by your analytics categories to your call analytics jobs. For each analytics category, you specify one or more rules. For example, you can specify a rule that the customer sentiment was neutral or negative within that category. If you start a call analytics job, Amazon Transcribe applies the category to the analytics job that you've specified.
*/
createCallAnalyticsCategory(callback?: (err: AWSError, data: TranscribeService.Types.CreateCallAnalyticsCategoryResponse) => void): Request<TranscribeService.Types.CreateCallAnalyticsCategoryResponse, AWSError>;
/**
* 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.
*/
createLanguageModel(params: TranscribeService.Types.CreateLanguageModelRequest, callback?: (err: AWSError, data: TranscribeService.Types.CreateLanguageModelResponse) => void): Request<TranscribeService.Types.CreateLanguageModelResponse, AWSError>;
/**
* 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.
*/
createLanguageModel(callback?: (err: AWSError, data: TranscribeService.Types.CreateLanguageModelResponse) => void): Request<TranscribeService.Types.CreateLanguageModelResponse, AWSError>;
/**
* Creates a new custom vocabulary that you can use to modify how Amazon Transcribe Medical transcribes your audio file.
*/
createMedicalVocabulary(params: TranscribeService.Types.CreateMedicalVocabularyRequest, callback?: (err: AWSError, data: TranscribeService.Types.CreateMedicalVocabularyResponse) => void): Request<TranscribeService.Types.CreateMedicalVocabularyResponse, AWSError>;
/**
* Creates a new custom vocabulary that you can use to modify how Amazon Transcribe Medical transcribes your audio file.
*/
createMedicalVocabulary(callback?: (err: AWSError, data: TranscribeService.Types.CreateMedicalVocabularyResponse) => void): Request<TranscribeService.Types.CreateMedicalVocabularyResponse, AWSError>;
/**
* Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.
*/
createVocabulary(params: TranscribeService.Types.CreateVocabularyRequest, callback?: (err: AWSError, data: TranscribeService.Types.CreateVocabularyResponse) => void): Request<TranscribeService.Types.CreateVocabularyResponse, AWSError>;
/**
* Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.
*/
createVocabulary(callback?: (err: AWSError, data: TranscribeService.Types.CreateVocabularyResponse) => void): Request<TranscribeService.Types.CreateVocabularyResponse, AWSError>;
/**
* Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.
*/
createVocabularyFilter(params: TranscribeService.Types.CreateVocabularyFilterRequest, callback?: (err: AWSError, data: TranscribeService.Types.CreateVocabularyFilterResponse) => void): Request<TranscribeService.Types.CreateVocabularyFilterResponse, AWSError>;
/**
* Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.
*/
createVocabularyFilter(callback?: (err: AWSError, data: TranscribeService.Types.CreateVocabularyFilterResponse) => void): Request<TranscribeService.Types.CreateVocabularyFilterResponse, AWSError>;
/**
* Deletes a call analytics category using its name.
*/
deleteCallAnalyticsCategory(params: TranscribeService.Types.DeleteCallAnalyticsCategoryRequest, callback?: (err: AWSError, data: TranscribeService.Types.DeleteCallAnalyticsCategoryResponse) => void): Request<TranscribeService.Types.DeleteCallAnalyticsCategoryResponse, AWSError>;
/**
* Deletes a call analytics category using its name.
*/
deleteCallAnalyticsCategory(callback?: (err: AWSError, data: TranscribeService.Types.DeleteCallAnalyticsCategoryResponse) => void): Request<TranscribeService.Types.DeleteCallAnalyticsCategoryResponse, AWSError>;
/**
* Deletes a call analytics job using its name.
*/
deleteCallAnalyticsJob(params: TranscribeService.Types.DeleteCallAnalyticsJobRequest, callback?: (err: AWSError, data: TranscribeService.Types.DeleteCallAnalyticsJobResponse) => void): Request<TranscribeService.Types.DeleteCallAnalyticsJobResponse, AWSError>;
/**
* Deletes a call analytics job using its name.
*/
deleteCallAnalyticsJob(callback?: (err: AWSError, data: TranscribeService.Types.DeleteCallAnalyticsJobResponse) => void): Request<TranscribeService.Types.DeleteCallAnalyticsJobResponse, AWSError>;
/**
* Deletes a custom language model using its name.
*/
deleteLanguageModel(params: TranscribeService.Types.DeleteLanguageModelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a custom language model using its name.
*/
deleteLanguageModel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a transcription job generated by Amazon Transcribe Medical and any related information.
*/
deleteMedicalTranscriptionJob(params: TranscribeService.Types.DeleteMedicalTranscriptionJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a transcription job generated by Amazon Transcribe Medical and any related information.
*/
deleteMedicalTranscriptionJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a vocabulary from Amazon Transcribe Medical.
*/
deleteMedicalVocabulary(params: TranscribeService.Types.DeleteMedicalVocabularyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a vocabulary from Amazon Transcribe Medical.
*/
deleteMedicalVocabulary(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.
*/
deleteTranscriptionJob(params: TranscribeService.Types.DeleteTranscriptionJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.
*/
deleteTranscriptionJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a vocabulary from Amazon Transcribe.
*/
deleteVocabulary(params: TranscribeService.Types.DeleteVocabularyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a vocabulary from Amazon Transcribe.
*/
deleteVocabulary(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes a vocabulary filter.
*/
deleteVocabularyFilter(params: TranscribeService.Types.DeleteVocabularyFilterRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes a vocabulary filter.
*/
deleteVocabularyFilter(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Gets information about a single custom language model. Use this information to see details about the language model in your Amazon Web Services 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.
*/
describeLanguageModel(params: TranscribeService.Types.DescribeLanguageModelRequest, callback?: (err: AWSError, data: TranscribeService.Types.DescribeLanguageModelResponse) => void): Request<TranscribeService.Types.DescribeLanguageModelResponse, AWSError>;
/**
* Gets information about a single custom language model. Use this information to see details about the language model in your Amazon Web Services 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.
*/
describeLanguageModel(callback?: (err: AWSError, data: TranscribeService.Types.DescribeLanguageModelResponse) => void): Request<TranscribeService.Types.DescribeLanguageModelResponse, AWSError>;
/**
* Retrieves information about a call analytics category.
*/
getCallAnalyticsCategory(params: TranscribeService.Types.GetCallAnalyticsCategoryRequest, callback?: (err: AWSError, data: TranscribeService.Types.GetCallAnalyticsCategoryResponse) => void): Request<TranscribeService.Types.GetCallAnalyticsCategoryResponse, AWSError>;
/**
* Retrieves information about a call analytics category.
*/
getCallAnalyticsCategory(callback?: (err: AWSError, data: TranscribeService.Types.GetCallAnalyticsCategoryResponse) => void): Request<TranscribeService.Types.GetCallAnalyticsCategoryResponse, AWSError>;
/**
* Returns information about a call analytics job. To see the status of the job, check the CallAnalyticsJobStatus 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 personally identifiable information (PII) redaction, the redacted transcript appears in the RedactedTranscriptFileUri field.
*/
getCallAnalyticsJob(params: TranscribeService.Types.GetCallAnalyticsJobRequest, callback?: (err: AWSError, data: TranscribeService.Types.GetCallAnalyticsJobResponse) => void): Request<TranscribeService.Types.GetCallAnalyticsJobResponse, AWSError>;
/**
* Returns information about a call analytics job. To see the status of the job, check the CallAnalyticsJobStatus 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 personally identifiable information (PII) redaction, the redacted transcript appears in the RedactedTranscriptFileUri field.
*/
getCallAnalyticsJob(callback?: (err: AWSError, data: TranscribeService.Types.GetCallAnalyticsJobResponse) => void): Request<TranscribeService.Types.GetCallAnalyticsJobResponse, AWSError>;
/**
* 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.
*/
getMedicalTranscriptionJob(params: TranscribeService.Types.GetMedicalTranscriptionJobRequest, callback?: (err: AWSError, data: TranscribeService.Types.GetMedicalTranscriptionJobResponse) => void): Request<TranscribeService.Types.GetMedicalTranscriptionJobResponse, AWSError>;
/**
* 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.
*/
getMedicalTranscriptionJob(callback?: (err: AWSError, data: TranscribeService.Types.GetMedicalTranscriptionJobResponse) => void): Request<TranscribeService.Types.GetMedicalTranscriptionJobResponse, AWSError>;
/**
* Retrieves information about a medical vocabulary.
*/
getMedicalVocabulary(params: TranscribeService.Types.GetMedicalVocabularyRequest, callback?: (err: AWSError, data: TranscribeService.Types.GetMedicalVocabularyResponse) => void): Request<TranscribeService.Types.GetMedicalVocabularyResponse, AWSError>;
/**
* Retrieves information about a medical vocabulary.
*/
getMedicalVocabulary(callback?: (err: AWSError, data: TranscribeService.Types.GetMedicalVocabularyResponse) => void): Request<TranscribeService.Types.GetMedicalVocabularyResponse, AWSError>;
/**
* 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.
*/
getTranscriptionJob(params: TranscribeService.Types.GetTranscriptionJobRequest, callback?: (err: AWSError, data: TranscribeService.Types.GetTranscriptionJobResponse) => void): Request<TranscribeService.Types.GetTranscriptionJobResponse, AWSError>;
/**
* 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.
*/
getTranscriptionJob(callback?: (err: AWSError, data: TranscribeService.Types.GetTranscriptionJobResponse) => void): Request<TranscribeService.Types.GetTranscriptionJobResponse, AWSError>;
/**
* Gets information about a vocabulary.
*/
getVocabulary(params: TranscribeService.Types.GetVocabularyRequest, callback?: (err: AWSError, data: TranscribeService.Types.GetVocabularyResponse) => void): Request<TranscribeService.Types.GetVocabularyResponse, AWSError>;
/**
* Gets information about a vocabulary.
*/
getVocabulary(callback?: (err: AWSError, data: TranscribeService.Types.GetVocabularyResponse) => void): Request<TranscribeService.Types.GetVocabularyResponse, AWSError>;
/**
* Returns information about a vocabulary filter.
*/
getVocabularyFilter(params: TranscribeService.Types.GetVocabularyFilterRequest, callback?: (err: AWSError, data: TranscribeService.Types.GetVocabularyFilterResponse) => void): Request<TranscribeService.Types.GetVocabularyFilterResponse, AWSError>;
/**
* Returns information about a vocabulary filter.
*/
getVocabularyFilter(callback?: (err: AWSError, data: TranscribeService.Types.GetVocabularyFilterResponse) => void): Request<TranscribeService.Types.GetVocabularyFilterResponse, AWSError>;
/**
* Provides more information about the call analytics categories that you've created. You can use the information in this list to find a specific category. You can then use the operation to get more information about it.
*/
listCallAnalyticsCategories(params: TranscribeService.Types.ListCallAnalyticsCategoriesRequest, callback?: (err: AWSError, data: TranscribeService.Types.ListCallAnalyticsCategoriesResponse) => void): Request<TranscribeService.Types.ListCallAnalyticsCategoriesResponse, AWSError>;
/**
* Provides more information about the call analytics categories that you've created. You can use the information in this list to find a specific category. You can then use the operation to get more information about it.
*/
listCallAnalyticsCategories(callback?: (err: AWSError, data: TranscribeService.Types.ListCallAnalyticsCategoriesResponse) => void): Request<TranscribeService.Types.ListCallAnalyticsCategoriesResponse, AWSError>;
/**
* List call analytics jobs with a specified status or substring that matches their names.
*/
listCallAnalyticsJobs(params: TranscribeService.Types.ListCallAnalyticsJobsRequest, callback?: (err: AWSError, data: TranscribeService.Types.ListCallAnalyticsJobsResponse) => void): Request<TranscribeService.Types.ListCallAnalyticsJobsResponse, AWSError>;
/**
* List call analytics jobs with a specified status or substring that matches their names.
*/
listCallAnalyticsJobs(callback?: (err: AWSError, data: TranscribeService.Types.ListCallAnalyticsJobsResponse) => void): Request<TranscribeService.Types.ListCallAnalyticsJobsResponse, AWSError>;
/**
* 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.
*/
listLanguageModels(params: TranscribeService.Types.ListLanguageModelsRequest, callback?: (err: AWSError, data: TranscribeService.Types.ListLanguageModelsResponse) => void): Request<TranscribeService.Types.ListLanguageModelsResponse, AWSError>;
/**
* 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.
*/
listLanguageModels(callback?: (err: AWSError, data: TranscribeService.Types.ListLanguageModelsResponse) => void): Request<TranscribeService.Types.ListLanguageModelsResponse, AWSError>;
/**
* Lists medical transcription jobs with a specified status or substring that matches their names.
*/
listMedicalTranscriptionJobs(params: TranscribeService.Types.ListMedicalTranscriptionJobsRequest, callback?: (err: AWSError, data: TranscribeService.Types.ListMedicalTranscriptionJobsResponse) => void): Request<TranscribeService.Types.ListMedicalTranscriptionJobsResponse, AWSError>;
/**
* Lists medical transcription jobs with a specified status or substring that matches their names.
*/
listMedicalTranscriptionJobs(callback?: (err: AWSError, data: TranscribeService.Types.ListMedicalTranscriptionJobsResponse) => void): Request<TranscribeService.Types.ListMedicalTranscriptionJobsResponse, AWSError>;
/**
* 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.
*/
listMedicalVocabularies(params: TranscribeService.Types.ListMedicalVocabulariesRequest, callback?: (err: AWSError, data: TranscribeService.Types.ListMedicalVocabulariesResponse) => void): Request<TranscribeService.Types.ListMedicalVocabulariesResponse, AWSError>;
/**
* 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.
*/
listMedicalVocabularies(callback?: (err: AWSError, data: TranscribeService.Types.ListMedicalVocabulariesResponse) => void): Request<TranscribeService.Types.ListMedicalVocabulariesResponse, AWSError>;
/**
* Lists all tags associated with a given transcription job, vocabulary, or resource.
*/
listTagsForResource(params: TranscribeService.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: TranscribeService.Types.ListTagsForResourceResponse) => void): Request<TranscribeService.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists all tags associated with a given transcription job, vocabulary, or resource.
*/
listTagsForResource(callback?: (err: AWSError, data: TranscribeService.Types.ListTagsForResourceResponse) => void): Request<TranscribeService.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists transcription jobs with the specified status.
*/
listTranscriptionJobs(params: TranscribeService.Types.ListTranscriptionJobsRequest, callback?: (err: AWSError, data: TranscribeService.Types.ListTranscriptionJobsResponse) => void): Request<TranscribeService.Types.ListTranscriptionJobsResponse, AWSError>;
/**
* Lists transcription jobs with the specified status.
*/
listTranscriptionJobs(callback?: (err: AWSError, data: TranscribeService.Types.ListTranscriptionJobsResponse) => void): Request<TranscribeService.Types.ListTranscriptionJobsResponse, AWSError>;
/**
* Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.
*/
listVocabularies(params: TranscribeService.Types.ListVocabulariesRequest, callback?: (err: AWSError, data: TranscribeService.Types.ListVocabulariesResponse) => void): Request<TranscribeService.Types.ListVocabulariesResponse, AWSError>;
/**
* Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.
*/
listVocabularies(callback?: (err: AWSError, data: TranscribeService.Types.ListVocabulariesResponse) => void): Request<TranscribeService.Types.ListVocabulariesResponse, AWSError>;
/**
* Gets information about vocabulary filters.
*/
listVocabularyFilters(params: TranscribeService.Types.ListVocabularyFiltersRequest, callback?: (err: AWSError, data: TranscribeService.Types.ListVocabularyFiltersResponse) => void): Request<TranscribeService.Types.ListVocabularyFiltersResponse, AWSError>;
/**
* Gets information about vocabulary filters.
*/
listVocabularyFilters(callback?: (err: AWSError, data: TranscribeService.Types.ListVocabularyFiltersResponse) => void): Request<TranscribeService.Types.ListVocabularyFiltersResponse, AWSError>;
/**
* Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but also returns additional insights. These insights include how quickly or loudly the caller or agent was speaking. To retrieve additional insights with your analytics jobs, create categories. A category is a way to classify analytics jobs based on attributes, such as a customer's sentiment or a particular phrase being used during the call. For more information, see the operation.
*/
startCallAnalyticsJob(params: TranscribeService.Types.StartCallAnalyticsJobRequest, callback?: (err: AWSError, data: TranscribeService.Types.StartCallAnalyticsJobResponse) => void): Request<TranscribeService.Types.StartCallAnalyticsJobResponse, AWSError>;
/**
* Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but also returns additional insights. These insights include how quickly or loudly the caller or agent was speaking. To retrieve additional insights with your analytics jobs, create categories. A category is a way to classify analytics jobs based on attributes, such as a customer's sentiment or a particular phrase being used during the call. For more information, see the operation.
*/
startCallAnalyticsJob(callback?: (err: AWSError, data: TranscribeService.Types.StartCallAnalyticsJobResponse) => void): Request<TranscribeService.Types.StartCallAnalyticsJobResponse, AWSError>;
/**
* Starts a batch job to transcribe medical speech to text.
*/
startMedicalTranscriptionJob(params: TranscribeService.Types.StartMedicalTranscriptionJobRequest, callback?: (err: AWSError, data: TranscribeService.Types.StartMedicalTranscriptionJobResponse) => void): Request<TranscribeService.Types.StartMedicalTranscriptionJobResponse, AWSError>;
/**
* Starts a batch job to transcribe medical speech to text.
*/
startMedicalTranscriptionJob(callback?: (err: AWSError, data: TranscribeService.Types.StartMedicalTranscriptionJobResponse) => void): Request<TranscribeService.Types.StartMedicalTranscriptionJobResponse, AWSError>;
/**
* Starts an asynchronous job to transcribe speech to text.
*/
startTranscriptionJob(params: TranscribeService.Types.StartTranscriptionJobRequest, callback?: (err: AWSError, data: TranscribeService.Types.StartTranscriptionJobResponse) => void): Request<TranscribeService.Types.StartTranscriptionJobResponse, AWSError>;
/**
* Starts an asynchronous job to transcribe speech to text.
*/
startTranscriptionJob(callback?: (err: AWSError, data: TranscribeService.Types.StartTranscriptionJobResponse) => void): Request<TranscribeService.Types.StartTranscriptionJobResponse, AWSError>;
/**
* Tags a Amazon Transcribe resource with the given list of tags.
*/
tagResource(params: TranscribeService.Types.TagResourceRequest, callback?: (err: AWSError, data: TranscribeService.Types.TagResourceResponse) => void): Request<TranscribeService.Types.TagResourceResponse, AWSError>;
/**
* Tags a Amazon Transcribe resource with the given list of tags.
*/
tagResource(callback?: (err: AWSError, data: TranscribeService.Types.TagResourceResponse) => void): Request<TranscribeService.Types.TagResourceResponse, AWSError>;
/**
* Removes specified tags from a specified Amazon Transcribe resource.
*/
untagResource(params: TranscribeService.Types.UntagResourceRequest, callback?: (err: AWSError, data: TranscribeService.Types.UntagResourceResponse) => void): Request<TranscribeService.Types.UntagResourceResponse, AWSError>;
/**
* Removes specified tags from a specified Amazon Transcribe resource.
*/
untagResource(callback?: (err: AWSError, data: TranscribeService.Types.UntagResourceResponse) => void): Request<TranscribeService.Types.UntagResourceResponse, AWSError>;
/**
* Updates the call analytics category with new values. The UpdateCallAnalyticsCategory operation overwrites all of the existing information with the values that you provide in the request.
*/
updateCallAnalyticsCategory(params: TranscribeService.Types.UpdateCallAnalyticsCategoryRequest, callback?: (err: AWSError, data: TranscribeService.Types.UpdateCallAnalyticsCategoryResponse) => void): Request<TranscribeService.Types.UpdateCallAnalyticsCategoryResponse, AWSError>;
/**
* Updates the call analytics category with new values. The UpdateCallAnalyticsCategory operation overwrites all of the existing information with the values that you provide in the request.
*/
updateCallAnalyticsCategory(callback?: (err: AWSError, data: TranscribeService.Types.UpdateCallAnalyticsCategoryResponse) => void): Request<TranscribeService.Types.UpdateCallAnalyticsCategoryResponse, AWSError>;
/**
* 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.
*/
updateMedicalVocabulary(params: TranscribeService.Types.UpdateMedicalVocabularyRequest, callback?: (err: AWSError, data: TranscribeService.Types.UpdateMedicalVocabularyResponse) => void): Request<TranscribeService.Types.UpdateMedicalVocabularyResponse, AWSError>;
/**
* 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.
*/
updateMedicalVocabulary(callback?: (err: AWSError, data: TranscribeService.Types.UpdateMedicalVocabularyResponse) => void): Request<TranscribeService.Types.UpdateMedicalVocabularyResponse, AWSError>;
/**
* 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.
*/
updateVocabulary(params: TranscribeService.Types.UpdateVocabularyRequest, callback?: (err: AWSError, data: TranscribeService.Types.UpdateVocabularyResponse) => void): Request<TranscribeService.Types.UpdateVocabularyResponse, AWSError>;
/**
* 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.
*/
updateVocabulary(callback?: (err: AWSError, data: TranscribeService.Types.UpdateVocabularyResponse) => void): Request<TranscribeService.Types.UpdateVocabularyResponse, AWSError>;
/**
* Updates a vocabulary filter with a new list of filtered words.
*/
updateVocabularyFilter(params: TranscribeService.Types.UpdateVocabularyFilterRequest, callback?: (err: AWSError, data: TranscribeService.Types.UpdateVocabularyFilterResponse) => void): Request<TranscribeService.Types.UpdateVocabularyFilterResponse, AWSError>;
/**
* Updates a vocabulary filter with a new list of filtered words.
*/
updateVocabularyFilter(callback?: (err: AWSError, data: TranscribeService.Types.UpdateVocabularyFilterResponse) => void): Request<TranscribeService.Types.UpdateVocabularyFilterResponse, AWSError>;
}
declare namespace TranscribeService {
export interface AbsoluteTimeRange {
/**
* A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values: StartTime - 10000 Endtime - 50000 The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
*/
StartTime?: TimestampMilliseconds;
/**
* A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values: StartTime - 10000 Endtime - 50000 The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
*/
EndTime?: TimestampMilliseconds;
/**
* A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000, the time range is set to the first 100,000 milliseconds of the call.
*/
First?: TimestampMilliseconds;
/**
* A time range from the value that you've specified to the end of the call. For example, if you specify 100000, the time range is set to the last 100,000 milliseconds of the call.
*/
Last?: TimestampMilliseconds;
}
export type BaseModelName = "NarrowBand"|"WideBand"|string;
export type Boolean = boolean;
export type CLMLanguageCode = "en-US"|"hi-IN"|"es-US"|"en-GB"|"en-AU"|string;
export interface CallAnalyticsJob {
/**
* The name of the call analytics job.
*/
CallAnalyticsJobName?: CallAnalyticsJobName;
/**
* The status of the analytics job.
*/
CallAnalyticsJobStatus?: CallAnalyticsJobStatus;
/**
* If you know the language spoken between the customer and the agent, specify a language code for this field. If you don't know the language, you can leave this field blank, and Amazon Transcribe will use machine learning to automatically identify the language. To improve the accuracy of language identification, you can provide an array containing the possible language codes for the language spoken in your audio. Refer to Supported languages and language-specific features for additional information.
*/
LanguageCode?: LanguageCode;
/**
* The sample rate, in Hertz, of the audio.
*/
MediaSampleRateHertz?: MediaSampleRateHertz;
/**
* The format of the input audio file. Note: for call analytics jobs, only the following media formats are supported: MP3, MP4, WAV, FLAC, OGG, and WebM.
*/
MediaFormat?: MediaFormat;
Media?: Media;
Transcript?: Transcript;
/**
* A timestamp that shows when the analytics job started processing.
*/
StartTime?: DateTime;
/**
* A timestamp that shows when the analytics job was created.
*/
CreationTime?: DateTime;
/**
* A timestamp that shows when the analytics job was completed.
*/
CompletionTime?: DateTime;
/**
* If the AnalyticsJobStatus is FAILED, this field contains information about why the job failed. The FailureReason field can contain one of the following values: Unsupported media format: The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values. The media format provided does not match the detected media format: The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure the two values match. Invalid sample rate for audio file: The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz. The sample rate provided does not match the detected sample rate: The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match. Invalid file size: file size too large: The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide. Invalid number of channels: number of channels too large: Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference.
*/
FailureReason?: FailureReason;
/**
* The Amazon Resource Number (ARN) that you use to get access to the analytics job.
*/
DataAccessRoleArn?: DataAccessRoleArn;
/**
* A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. This value appears only when you don't provide a single language code. Larger values indicate that Amazon Transcribe has higher confidence in the language that it identified
*/
IdentifiedLanguageScore?: IdentifiedLanguageScore;
/**
* Provides information about the settings used to run a transcription job.
*/
Settings?: CallAnalyticsJobSettings;
/**
* Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.
*/
ChannelDefinitions?: ChannelDefinitions;
}
export type CallAnalyticsJobName = string;
export interface CallAnalyticsJobSettings {
/**
* The name of a vocabulary to use when processing the call analytics job.
*/
VocabularyName?: VocabularyName;
/**
* The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the same language code as the analytics job.
*/
VocabularyFilterName?: VocabularyFilterName;
/**
* Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.
*/
VocabularyFilterMethod?: VocabularyFilterMethod;
/**
* The structure used to describe a custom language model.
*/
LanguageModelName?: ModelName;
ContentRedaction?: ContentRedaction;
/**
* When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you. To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages and language-specific features for additional information.
*/
LanguageOptions?: LanguageOptions;
}
export type CallAnalyticsJobStatus = "QUEUED"|"IN_PROGRESS"|"FAILED"|"COMPLETED"|string;
export type CallAnalyticsJobSummaries = CallAnalyticsJobSummary[];
export interface CallAnalyticsJobSummary {
/**
* The name of the call analytics job.
*/
CallAnalyticsJobName?: CallAnalyticsJobName;
/**
* A timestamp that shows when the call analytics job was created.
*/
CreationTime?: DateTime;
/**
* A timestamp that shows when the job began processing.
*/
StartTime?: DateTime;
/**
* A timestamp that shows when the job was completed.
*/
CompletionTime?: DateTime;
/**
* The language of the transcript in the source audio file.
*/
LanguageCode?: LanguageCode;
/**
* The status of the call analytics job.
*/
CallAnalyticsJobStatus?: CallAnalyticsJobStatus;
/**
* If the CallAnalyticsJobStatus is FAILED, a description of the error.
*/
FailureReason?: FailureReason;
}
export type CategoryName = string;
export interface CategoryProperties {
/**
* The name of the call analytics category.
*/
CategoryName?: CategoryName;
/**
* The rules used to create a call analytics category.
*/
Rules?: RuleList;
/**
* A timestamp that shows when the call analytics category was created.
*/
CreateTime?: DateTime;
/**
* A timestamp that shows when the call analytics category was most recently updated.
*/
LastUpdateTime?: DateTime;
}
export type CategoryPropertiesList = CategoryProperties[];
export interface ChannelDefinition {
/**
* A value that indicates the audio channel.
*/
ChannelId?: ChannelId;
/**
* Indicates whether the person speaking on the audio channel is the agent or customer.
*/
ParticipantRole?: ParticipantRole;
}
export type ChannelDefinitions = ChannelDefinition[];
export type ChannelId = number;
export interface ContentRedaction {
/**
* Request parameter that defines the entities to be redacted. The only accepted value is PII.
*/
RedactionType: RedactionType;
/**
* The output transcript file stored in either the default S3 bucket or in a bucket you specify. When you choose redacted Amazon Transcribe outputs only the redacted transcript. When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted transcripts.
*/
RedactionOutput: RedactionOutput;
}
export interface CreateCallAnalyticsCategoryRequest {
/**
* The name that you choose for your category when you create it.
*/
CategoryName: CategoryName;
/**
* To create a category, you must specify between 1 and 20 rules. For each rule, you specify a filter to be applied to the attributes of the call. For example, you can specify a sentiment filter to detect if the customer's sentiment was negative or neutral.
*/
Rules: RuleList;
}
export interface CreateCallAnalyticsCategoryResponse {
/**
* The rules and associated metadata used to create a category.
*/
CategoryProperties?: CategoryProperties;
}
export interface CreateLanguageModelRequest {
/**
* The language of the input text you're using to train your custom language model.
*/
LanguageCode: CLMLanguageCode;
/**
* The Amazon Transcribe standard language model, or base model used to create your custom language model. If you want to use your custom language model to transcribe audio with a sample rate of 16,000 Hz or greater, choose Wideband. If you want to use your custom language model to transcribe audio with a sample rate that is less than 16,000 Hz, choose Narrowband.
*/
BaseModelName: BaseModelName;
/**
* The name you choose for your custom language model when you create it.
*/
ModelName: ModelName;
/**
* Contains the data access role and the Amazon S3 prefixes to read the required input files to create a custom language model.
*/
InputDataConfig: InputDataConfig;
/**
* Adds one or more tags, each in the form of a key:value pair, to a new language model at the time you create this new model.
*/
Tags?: TagList;
}
export interface CreateLanguageModelResponse {
/**
* The language code of the text you've used to create a custom language model.
*/
LanguageCode?: CLMLanguageCode;
/**
* The Amazon Transcribe standard language model, or base model you've used to create a custom language model.
*/
BaseModelName?: BaseModelName;
/**
* The name you've chosen for your custom language model.
*/
ModelName?: ModelName;
/**
* The data access role and Amazon S3 prefixes you've chosen to create your custom language model.
*/
InputDataConfig?: InputDataConfig;
/**
* The status of the custom language model. When the status is COMPLETED the model is ready to use.
*/
ModelStatus?: ModelStatus;
}
export interface CreateMedicalVocabularyRequest {
/**
* The name of the custom vocabulary. This case-sensitive name must be unique within an Amazon Web Services account. If you try to create a vocabulary with the same name as a previous vocabulary, you get a ConflictException error.
*/
VocabularyName: VocabularyName;
/**
* The language code for the language used for the entries in your custom vocabulary. The language code of your custom vocabulary must match the language code of your transcription job. US English (en-US) is the only language code available for Amazon Transcribe Medical.
*/
LanguageCode: LanguageCode;
/**
* The location in Amazon S3 of the text file you use to define your custom vocabulary. The URI must be in the same Amazon Web Services Region as the resource that you're calling. Enter information about your VocabularyFileUri in the following format: https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey> The following is an example URI for a vocabulary file that is stored in Amazon S3: https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide. For more information about custom vocabularies, see Medical Custom Vocabularies.
*/
VocabularyFileUri: Uri;
/**
* Adds one or more tags, each in the form of a key:value pair, to a new medical vocabulary at the time you create this new vocabulary.
*/
Tags?: TagList;
}
export interface CreateMedicalVocabularyResponse {
/**
* The name of the vocabulary. The name must be unique within an Amazon Web Services account and is case sensitive.
*/
VocabularyName?: VocabularyName;
/**
* The language code for the entries in your custom vocabulary. US English (en-US) is the only valid language code for Amazon Transcribe Medical.
*/
LanguageCode?: LanguageCode;
/**
* The processing state of your custom vocabulary in Amazon Transcribe Medical. If the state is READY, you can use the vocabulary in a StartMedicalTranscriptionJob request.
*/
VocabularyState?: VocabularyState;
/**
* The date and time that you created the vocabulary.
*/
LastModifiedTime?: DateTime;
/**
* If the VocabularyState field is FAILED, this field contains information about why the job failed.
*/
FailureReason?: FailureReason;
}
export interface CreateVocabularyFilterRequest {
/**
* The vocabulary filter name. The name must be unique within the account that contains it. If you try to create a vocabulary filter with the same name as another vocabulary filter, you get a ConflictException error.
*/
VocabularyFilterName: VocabularyFilterName;
/**
* The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.
*/
LanguageCode: LanguageCode;
/**
* The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies. If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.
*/
Words?: Words;
/**
* The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies. The specified file must be less than 50 KB of UTF-8 characters. If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.
*/
VocabularyFilterFileUri?: Uri;
/**
* Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary filter at the time you create this new vocabulary filter.
*/
Tags?: TagList;
}
export interface CreateVocabularyFilterResponse {
/**
* The name of the vocabulary filter.
*/
VocabularyFilterName?: VocabularyFilterName;
/**
* The language code of the words in the collection.
*/
LanguageCode?: LanguageCode;
/**
* The date and time that the vocabulary filter was modified.
*/
LastModifiedTime?: DateTime;
}
export interface CreateVocabularyRequest {
/**
* The name of the vocabulary. The name must be unique within an Amazon Web Services account. The name is case sensitive. If you try to create a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.
*/
VocabularyName: VocabularyName;
/**
* The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see transcribe-whatis.
*/
LanguageCode: LanguageCode;
/**
* An array of strings that contains the vocabulary entries.
*/
Phrases?: Phrases;
/**
* The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is: For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide. For more information about custom vocabularies, see Custom vocabularies.
*/
VocabularyFileUri?: Uri;
/**
* Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary at the time you create this new vocabulary.
*/
Tags?: TagList;
}
export interface CreateVocabularyResponse {
/**
* The name of the vocabulary.
*/
VocabularyName?: VocabularyName;
/**
* The language code of the vocabulary entries.
*/
LanguageCode?: LanguageCode;
/**
* The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request.
*/
VocabularyState?: VocabularyState;
/**
* The date and time that the vocabulary was created.
*/
LastModifiedTime?: DateTime;
/**
* If the VocabularyState field is FAILED, this field contains information about why the job failed.
*/
FailureReason?: FailureReason;
}
export type DataAccessRoleArn = string;
export type DateTime = Date;
export interface DeleteCallAnalyticsCategoryRequest {
/**
* The name of the call analytics category that you're choosing to delete. The value is case sensitive.
*/
CategoryName: CategoryName;
}
export interface DeleteCallAnalyticsCategoryResponse {
}
export interface DeleteCallAnalyticsJobRequest {
/**
* The name of the call analytics job you want to delete.
*/
CallAnalyticsJobName: CallAnalyticsJobName;
}
export interface DeleteCallAnalyticsJobResponse {
}
export interface DeleteLanguageModelRequest {
/**
* The name of the model you're choosing to delete.
*/
ModelName: ModelName;
}
export interface DeleteMedicalTranscriptionJobRequest {
/**
* The name you provide to the DeleteMedicalTranscriptionJob object to delete a transcription job.
*/
MedicalTranscriptionJobName: TranscriptionJobName;
}
export interface DeleteMedicalVocabularyRequest {
/**
* The name of the vocabulary that you want to delete.
*/
VocabularyName: VocabularyName;
}
export interface DeleteTranscriptionJobRequest {
/**
* The name of the transcription job to be deleted.
*/
TranscriptionJobName: TranscriptionJobName;
}
export interface DeleteVocabularyFilterRequest {
/**
* The name of the vocabulary filter to remove.