cloudworker-proxy
Version:
An api gateway for cloudflare workers
866 lines • 80.4 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 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 change 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 change 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 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 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.
*/
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 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.
*/
describeLanguageModel(callback?: (err: AWSError, data: TranscribeService.Types.DescribeLanguageModelResponse) => void): Request<TranscribeService.Types.DescribeLanguageModelResponse, 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 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 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 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>;
/**
* 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 type BaseModelName = "NarrowBand"|"WideBand"|string;
export type Boolean = boolean;
export type CLMLanguageCode = "en-US"|string;
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 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 kHz 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 kHz, 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;
}
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 AWS 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 AWS 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;
}
export interface CreateMedicalVocabularyResponse {
/**
* The name of the vocabulary. The name must be unique within an AWS 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;
}
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 AWS 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.
*/
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;
}
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 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.
*/
VocabularyFilterName: VocabularyFilterName;
}
export interface DeleteVocabularyRequest {
/**
* The name of the vocabulary to delete.
*/
VocabularyName: VocabularyName;
}
export interface DescribeLanguageModelRequest {
/**
* The name of the custom language model you submit to get more information.
*/
ModelName: ModelName;
}
export interface DescribeLanguageModelResponse {
/**
* The name of the custom language model you requested more information about.
*/
LanguageModel?: LanguageModel;
}
export type FailureReason = string;
export interface GetMedicalTranscriptionJobRequest {
/**
* The name of the medical transcription job.
*/
MedicalTranscriptionJobName: TranscriptionJobName;
}
export interface GetMedicalTranscriptionJobResponse {
/**
* An object that contains the results of the medical transcription job.
*/
MedicalTranscriptionJob?: MedicalTranscriptionJob;
}
export interface GetMedicalVocabularyRequest {
/**
* The name of the vocabulary that you want information about. The value is case sensitive.
*/
VocabularyName: VocabularyName;
}
export interface GetMedicalVocabularyResponse {
/**
* The name of the vocabulary returned by Amazon Transcribe Medical.
*/
VocabularyName?: VocabularyName;
/**
* The valid language code for your vocabulary entries.
*/
LanguageCode?: LanguageCode;
/**
* The processing state of the vocabulary. If the VocabularyState is READY then you can use it in the StartMedicalTranscriptionJob operation.
*/
VocabularyState?: VocabularyState;
/**
* The date and time that the vocabulary was last modified with a text file different from the one that was previously used.
*/
LastModifiedTime?: DateTime;
/**
* If the VocabularyState is FAILED, this field contains information about why the job failed.
*/
FailureReason?: FailureReason;
/**
* The location in Amazon S3 where the vocabulary is stored. Use this URI to get the contents of the vocabulary. You can download your vocabulary from the URI for a limited time.
*/
DownloadUri?: Uri;
}
export interface GetTranscriptionJobRequest {
/**
* The name of the job.
*/
TranscriptionJobName: TranscriptionJobName;
}
export interface GetTranscriptionJobResponse {
/**
* An object that contains the results of the transcription job.
*/
TranscriptionJob?: TranscriptionJob;
}
export interface GetVocabularyFilterRequest {
/**
* The name of the vocabulary filter for which to return information.
*/
VocabularyFilterName: VocabularyFilterName;
}
export interface GetVocabularyFilterResponse {
/**
* The name of the vocabulary filter.
*/
VocabularyFilterName?: VocabularyFilterName;
/**
* The language code of the words in the vocabulary filter.
*/
LanguageCode?: LanguageCode;
/**
* The date and time that the contents of the vocabulary filter were updated.
*/
LastModifiedTime?: DateTime;
/**
* The URI of the list of words in the vocabulary filter. You can use this URI to get the list of words.
*/
DownloadUri?: Uri;
}
export interface GetVocabularyRequest {
/**
* The name of the vocabulary to return information about. The name is case sensitive.
*/
VocabularyName: VocabularyName;
}
export interface GetVocabularyResponse {
/**
* The name of the vocabulary to return.
*/
VocabularyName?: VocabularyName;
/**
* The language code of the vocabulary entries.
*/
LanguageCode?: LanguageCode;
/**
* The processing state of the vocabulary.
*/
VocabularyState?: VocabularyState;
/**
* The date and time that the vocabulary was last modified.
*/
LastModifiedTime?: DateTime;
/**
* If the VocabularyState field is FAILED, this field contains information about why the job failed.
*/
FailureReason?: FailureReason;
/**
* The S3 location where the vocabulary is stored. Use this URI to get the contents of the vocabulary. The URI is available for a limited time.
*/
DownloadUri?: Uri;
}
export type IdentifiedLanguageScore = number;
export interface InputDataConfig {
/**
* The Amazon S3 prefix you specify to access the plain text files that you use to train your custom language model.
*/
S3Uri: Uri;
/**
* The Amazon S3 prefix you specify to access the plain text files that you use to tune your custom language model.
*/
TuningDataS3Uri?: Uri;
/**
* The Amazon Resource Name (ARN) that uniquely identifies the permissions you've given Amazon Transcribe to access your Amazon S3 buckets containing your media files or text data.
*/
DataAccessRoleArn: DataAccessRoleArn;
}
export interface JobExecutionSettings {
/**
* Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception. If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
*/
AllowDeferredExecution?: Boolean;
/**
* The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well. If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
*/
DataAccessRoleArn?: DataAccessRoleArn;
}
export type KMSKeyId = string;
export type LanguageCode = "af-ZA"|"ar-AE"|"ar-SA"|"cy-GB"|"da-DK"|"de-CH"|"de-DE"|"en-AB"|"en-AU"|"en-GB"|"en-IE"|"en-IN"|"en-US"|"en-WL"|"es-ES"|"es-US"|"fa-IR"|"fr-CA"|"fr-FR"|"ga-IE"|"gd-GB"|"he-IL"|"hi-IN"|"id-ID"|"it-IT"|"ja-JP"|"ko-KR"|"ms-MY"|"nl-NL"|"pt-BR"|"pt-PT"|"ru-RU"|"ta-IN"|"te-IN"|"tr-TR"|"zh-CN"|string;
export interface LanguageModel {
/**
* The name of the custom language model.
*/
ModelName?: ModelName;
/**
* The time the custom language model was created.
*/
CreateTime?: DateTime;
/**
* The most recent time the custom language model was modified.
*/
LastModifiedTime?: DateTime;
/**
* The language code you used to create your custom language model.
*/
LanguageCode?: CLMLanguageCode;
/**
* The Amazon Transcribe standard language model, or base model used to create the custom language model.
*/
BaseModelName?: BaseModelName;
/**
* The creation status of a custom language model. When the status is COMPLETED the model is ready for use.
*/
ModelStatus?: ModelStatus;
/**
* Whether the base model used for the custom language model is up to date. If this field is true then you are running the most up-to-date version of the base model in your custom language model.
*/
UpgradeAvailability?: Boolean;
/**
* The reason why the custom language model couldn't be created.
*/
FailureReason?: FailureReason;
/**
* The data access role and Amazon S3 prefixes for the input files used to train the custom language model.
*/
InputDataConfig?: InputDataConfig;
}
export type LanguageOptions = LanguageCode[];
export interface ListLanguageModelsRequest {
/**
* When specified, returns only custom language models with the specified status. Language models are ordered by creation date, with the newest models first. If you don't specify a status, Amazon Transcribe returns all custom language models ordered by date.
*/
StatusEquals?: ModelStatus;
/**
* When specified, the custom language model names returned contain the substring you've specified.
*/
NameContains?: ModelName;
/**
* When included, fetches the next set of jobs if the result of the previous request was truncated.
*/
NextToken?: NextToken;
/**
* The maximum number of language models to return in the response. If there are fewer results in the list, the response contains only the actual results.
*/
MaxResults?: MaxResults;
}
export interface ListLanguageModelsResponse {
/**
* The operation returns a page of jobs at a time. The maximum size of the list is set by the MaxResults parameter. If there are more language models in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the operation to return the next page of language models.
*/
NextToken?: NextToken;
/**
* A list of objects containing information about custom language models.
*/
Models?: Models;
}
export interface ListMedicalTranscriptionJobsRequest {
/**
* When specified, returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don't specify a status, Amazon Transcribe Medical returns all transcription jobs ordered by creation date.
*/
Status?: TranscriptionJobStatus;
/**
* When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
*/
JobNameContains?: TranscriptionJobName;
/**
* If you a receive a truncated result in the previous request of ListMedicalTranscriptionJobs, include NextToken to fetch the next set of jobs.
*/
NextToken?: NextToken;
/**
* The maximum number of medical transcription jobs to return in the response. IF there are fewer results in the list, this response contains only the actual results.
*/
MaxResults?: MaxResults;
}
export interface ListMedicalTranscriptionJobsResponse {
/**
* The requested status of the medical transcription jobs returned.
*/
Status?: TranscriptionJobStatus;
/**
* The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If the number of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the NextPage token. Include the token in the next request to the ListMedicalTranscriptionJobs operation to return in the next page of jobs.
*/
NextToken?: NextToken;
/**
* A list of objects containing summary information for a transcription job.
*/
MedicalTranscriptionJobSummaries?: MedicalTranscriptionJobSummaries;
}
export interface ListMedicalVocabulariesRequest {
/**
* If the result of your previous request to ListMedicalVocabularies was truncated, include the NextToken to fetch the next set of vocabularies.
*/
NextToken?: NextToken;
/**
* The maximum number of vocabularies to return in the response.
*/
MaxResults?: MaxResults;
/**
* When specified, returns only vocabularies with the VocabularyState equal to the specified vocabulary state. Use this field to see which vocabularies are ready for your medical transcription jobs.
*/
StateEquals?: VocabularyState;
/**
* Returns vocabularies whose names contain the specified string. The search is not case sensitive. ListMedicalVocabularies returns both "vocabularyname" and "VocabularyName".
*/
NameContains?: VocabularyName;
}
export interface ListMedicalVocabulariesResponse {
/**
* The requested vocabulary state.
*/
Status?: VocabularyState;
/**
* The ListMedicalVocabularies operation returns a page of vocabularies at a time. You set the maximum number of vocabularies to return on a page with the MaxResults parameter. If there are more jobs in the list will fit on a page, Amazon Transcribe Medical returns the NextPage token. To return the next page of vocabularies, include the token in the next request to the ListMedicalVocabularies operation .
*/
NextToken?: NextToken;
/**
* A list of objects that describe the vocabularies that match your search criteria.
*/
Vocabularies?: Vocabularies;
}
export interface ListTranscriptionJobsRequest {
/**
* When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.
*/
Status?: TranscriptionJobStatus;
/**
* When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
*/
JobNameContains?: TranscriptionJobName;
/**
* If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.
*/
NextToken?: NextToken;
/**
* The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.
*/
MaxResults?: MaxResults;
}
export interface ListTranscriptionJobsResponse {
/**
* The requested status of the jobs returned.
*/
Status?: TranscriptionJobStatus;
/**
* The ListTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListTranscriptionJobs operation to return in the next page of jobs.
*/
NextToken?: NextToken;
/**
* A list of objects containing summary information for a transcription job.
*/
TranscriptionJobSummaries?: TranscriptionJobSummaries;
}
export interface ListVocabulariesRequest {
/**
* If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.
*/
NextToken?: NextToken;
/**
* The maximum number of vocabularies to return in the response. If there are fewer results in the list, this response contains only the actual results.
*/
MaxResults?: MaxResults;
/**
* When specified, only returns vocabularies with the VocabularyState field equal to the specified state.
*/
StateEquals?: VocabularyState;
/**
* When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is not case sensitive, ListVocabularies returns both "vocabularyname" and "VocabularyName" in the response list.
*/
NameContains?: VocabularyName;
}
export interface ListVocabulariesResponse {
/**
* The requested vocabulary state.
*/
Status?: VocabularyState;
/**
* The ListVocabularies operation returns a page of vocabularies at a time. The maximum size of the page is set in the MaxResults parameter. If there are more jobs in the list than will fit on the page, Amazon Transcribe returns the NextPage token. To return in the next page of jobs, include the token in the next request to the ListVocabularies operation.
*/
NextToken?: NextToken;
/**
* A list of objects that describe the vocabularies that match the search criteria in the request.
*/
Vocabularies?: Vocabularies;
}
export interface ListVocabularyFiltersRequest {
/**
* If the result of the previous request to ListVocabularyFilters was truncated, include the NextToken to fetch the next set of collections.
*/
NextToken?: NextToken;
/**
* The maximum number of filters to return in the response. If there are fewer results in the list, this response contains only the actual results.
*/
MaxResults?: MaxResults;
/**
* Filters the response so that it only contains vocabulary filters whose name contains the specified string.
*/
NameContains?: VocabularyFilterName;
}
export interface ListVocabularyFiltersResponse {
/**
* The ListVocabularyFilters operation returns a page of collections at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListVocabularyFilters operation to return in the next page of jobs.
*/
NextToken?: NextToken;
/**
* The list of vocabulary filters. It contains at most MaxResults number of filters. If there are more filters, call the ListVocabularyFilters operation again with the NextToken parameter in the request set to the value of the NextToken field in the response.
*/
VocabularyFilters?: VocabularyFilters;
}
export type MaxAlternatives = number;
export type MaxResults = number;
export type MaxSpeakers = number;
export interface Media {
/**
* The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is: For example: For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
*/
MediaFileUri?: Uri;
}
export type MediaFormat = "mp3"|"mp4"|"wav"|"flac"|string;
export type MediaSampleRateHertz = number;
export interface MedicalTranscript {
/**
* The S3 object location of the medical transcript. Use this URI to access the medical transcript. This URI points to the S3 bucket you created to store the medical transcript.
*/
TranscriptFileUri?: Uri;
}
export interface MedicalTranscriptionJob {
/**
* The name for a given medical transcription job.
*/
MedicalTranscriptionJobName?: TranscriptionJobName;
/**
* The completion status of a medical transcription job.
*/
TranscriptionJobStatus?: TranscriptionJobStatus;
/**
* The language code for the language spoken in the source audio file. US English (en-US) is the only supported language for medical transcriptions. Any other value you enter for language code results in a BadRequestException error.
*/
LanguageCode?: LanguageCode;
/**
* The sample rate, in Hertz, of the source audio containing medical information. If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleHertz blank and let Amazon Transcribe Medical determine the sample rate.
*/
MediaSampleRateHertz?: MediaSampleRateHertz;
/**
* The format of the input media file.
*/
MediaFormat?: MediaFormat;
Media?: Media;
/**
* An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.
*/
Transcript?: MedicalTranscript;
/**
* A timestamp that shows when the job started processing.
*/
StartTime?: DateTime;
/**
* A timestamp that shows when the job was created.
*/
CreationTime?: DateTime;
/**
* A timestamp that shows when the job was completed.
*/
CompletionTime?: DateTime;
/**
* If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed. The FailureReason field contains 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 8000 and 48000 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;
/**
* Object that contains object.
*/
Settings?: MedicalTranscriptionSetting;
/**
* The medical specialty of any clinicians providing a dictation or having a conversation. PRIMARYCARE is the only available setting for this object. T