TranscribeService

import { TranscribeService } from "https://aws-api.deno.dev/v0.3/services/transcribeservice.ts?docs=full";

class TranscribeService {

constructor(apiFactory: client.ApiFactory);

async createCallAnalyticsCategory(params: CreateCallAnalyticsCategoryRequest, opts?: client.RequestOptions): Promise<CreateCallAnalyticsCategoryResponse>;

async createLanguageModel(params: CreateLanguageModelRequest, opts?: client.RequestOptions): Promise<CreateLanguageModelResponse>;

async createMedicalVocabulary(params: CreateMedicalVocabularyRequest, opts?: client.RequestOptions): Promise<CreateMedicalVocabularyResponse>;

async createVocabulary(params: CreateVocabularyRequest, opts?: client.RequestOptions): Promise<CreateVocabularyResponse>;

async createVocabularyFilter(params: CreateVocabularyFilterRequest, opts?: client.RequestOptions): Promise<CreateVocabularyFilterResponse>;

async deleteCallAnalyticsCategory(params: DeleteCallAnalyticsCategoryRequest, opts?: client.RequestOptions): Promise<void>;

async deleteCallAnalyticsJob(params: DeleteCallAnalyticsJobRequest, opts?: client.RequestOptions): Promise<void>;

async deleteLanguageModel(params: DeleteLanguageModelRequest, opts?: client.RequestOptions): Promise<void>;

async deleteMedicalTranscriptionJob(params: DeleteMedicalTranscriptionJobRequest, opts?: client.RequestOptions): Promise<void>;

async deleteMedicalVocabulary(params: DeleteMedicalVocabularyRequest, opts?: client.RequestOptions): Promise<void>;

async deleteTranscriptionJob(params: DeleteTranscriptionJobRequest, opts?: client.RequestOptions): Promise<void>;

async deleteVocabulary(params: DeleteVocabularyRequest, opts?: client.RequestOptions): Promise<void>;

async deleteVocabularyFilter(params: DeleteVocabularyFilterRequest, opts?: client.RequestOptions): Promise<void>;

async describeLanguageModel(params: DescribeLanguageModelRequest, opts?: client.RequestOptions): Promise<DescribeLanguageModelResponse>;

async getCallAnalyticsCategory(params: GetCallAnalyticsCategoryRequest, opts?: client.RequestOptions): Promise<GetCallAnalyticsCategoryResponse>;

async getCallAnalyticsJob(params: GetCallAnalyticsJobRequest, opts?: client.RequestOptions): Promise<GetCallAnalyticsJobResponse>;

async getMedicalTranscriptionJob(params: GetMedicalTranscriptionJobRequest, opts?: client.RequestOptions): Promise<GetMedicalTranscriptionJobResponse>;

async getMedicalVocabulary(params: GetMedicalVocabularyRequest, opts?: client.RequestOptions): Promise<GetMedicalVocabularyResponse>;

async getTranscriptionJob(params: GetTranscriptionJobRequest, opts?: client.RequestOptions): Promise<GetTranscriptionJobResponse>;

async getVocabulary(params: GetVocabularyRequest, opts?: client.RequestOptions): Promise<GetVocabularyResponse>;

async getVocabularyFilter(params: GetVocabularyFilterRequest, opts?: client.RequestOptions): Promise<GetVocabularyFilterResponse>;

async listCallAnalyticsCategories(params?: ListCallAnalyticsCategoriesRequest, opts?: client.RequestOptions): Promise<ListCallAnalyticsCategoriesResponse>;

async listCallAnalyticsJobs(params?: ListCallAnalyticsJobsRequest, opts?: client.RequestOptions): Promise<ListCallAnalyticsJobsResponse>;

async listLanguageModels(params?: ListLanguageModelsRequest, opts?: client.RequestOptions): Promise<ListLanguageModelsResponse>;

async listMedicalTranscriptionJobs(params?: ListMedicalTranscriptionJobsRequest, opts?: client.RequestOptions): Promise<ListMedicalTranscriptionJobsResponse>;

async listMedicalVocabularies(params?: ListMedicalVocabulariesRequest, opts?: client.RequestOptions): Promise<ListMedicalVocabulariesResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listTranscriptionJobs(params?: ListTranscriptionJobsRequest, opts?: client.RequestOptions): Promise<ListTranscriptionJobsResponse>;

async listVocabularies(params?: ListVocabulariesRequest, opts?: client.RequestOptions): Promise<ListVocabulariesResponse>;

async listVocabularyFilters(params?: ListVocabularyFiltersRequest, opts?: client.RequestOptions): Promise<ListVocabularyFiltersResponse>;

async startCallAnalyticsJob(params: StartCallAnalyticsJobRequest, opts?: client.RequestOptions): Promise<StartCallAnalyticsJobResponse>;

async startMedicalTranscriptionJob(params: StartMedicalTranscriptionJobRequest, opts?: client.RequestOptions): Promise<StartMedicalTranscriptionJobResponse>;

async startTranscriptionJob(params: StartTranscriptionJobRequest, opts?: client.RequestOptions): Promise<StartTranscriptionJobResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateCallAnalyticsCategory(params: UpdateCallAnalyticsCategoryRequest, opts?: client.RequestOptions): Promise<UpdateCallAnalyticsCategoryResponse>;

async updateMedicalVocabulary(params: UpdateMedicalVocabularyRequest, opts?: client.RequestOptions): Promise<UpdateMedicalVocabularyResponse>;

async updateVocabulary(params: UpdateVocabularyRequest, opts?: client.RequestOptions): Promise<UpdateVocabularyResponse>;

async updateVocabularyFilter(params: UpdateVocabularyFilterRequest, opts?: client.RequestOptions): Promise<UpdateVocabularyFilterResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new TranscribeService(apiFactory: client.ApiFactory)

[src]

§Methods

createCallAnalyticsCategory(params: CreateCallAnalyticsCategoryRequest, opts?: client.RequestOptions): Promise<CreateCallAnalyticsCategoryResponse>

[src]

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.

createLanguageModel(params: CreateLanguageModelRequest, opts?: client.RequestOptions): Promise<CreateLanguageModelResponse>

[src]

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.

createMedicalVocabulary(params: CreateMedicalVocabularyRequest, opts?: client.RequestOptions): Promise<CreateMedicalVocabularyResponse>

[src]

Creates a new custom vocabulary that you can use to modify how Amazon Transcribe Medical transcribes your audio file.

createVocabulary(params: CreateVocabularyRequest, opts?: client.RequestOptions): Promise<CreateVocabularyResponse>

[src]

Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.

createVocabularyFilter(params: CreateVocabularyFilterRequest, opts?: client.RequestOptions): Promise<CreateVocabularyFilterResponse>

[src]

Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.

deleteCallAnalyticsCategory(params: DeleteCallAnalyticsCategoryRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a call analytics category using its name.

deleteCallAnalyticsJob(params: DeleteCallAnalyticsJobRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a call analytics job using its name.

deleteLanguageModel(params: DeleteLanguageModelRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a custom language model using its name.

deleteMedicalTranscriptionJob(params: DeleteMedicalTranscriptionJobRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a transcription job generated by Amazon Transcribe Medical and any related information.

deleteMedicalVocabulary(params: DeleteMedicalVocabularyRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a vocabulary from Amazon Transcribe Medical.

deleteTranscriptionJob(params: DeleteTranscriptionJobRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.

deleteVocabulary(params: DeleteVocabularyRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a vocabulary from Amazon Transcribe.

deleteVocabularyFilter(params: DeleteVocabularyFilterRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes a vocabulary filter.

describeLanguageModel(params: DescribeLanguageModelRequest, opts?: client.RequestOptions): Promise<DescribeLanguageModelResponse>

[src]

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.

getCallAnalyticsCategory(params: GetCallAnalyticsCategoryRequest, opts?: client.RequestOptions): Promise<GetCallAnalyticsCategoryResponse>

[src]

Retrieves information about a call analytics category.

getCallAnalyticsJob(params: GetCallAnalyticsJobRequest, opts?: client.RequestOptions): Promise<GetCallAnalyticsJobResponse>

[src]

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.

getMedicalTranscriptionJob(params: GetMedicalTranscriptionJobRequest, opts?: client.RequestOptions): Promise<GetMedicalTranscriptionJobResponse>

[src]

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.

getMedicalVocabulary(params: GetMedicalVocabularyRequest, opts?: client.RequestOptions): Promise<GetMedicalVocabularyResponse>

[src]

Retrieves information about a medical vocabulary.

getTranscriptionJob(params: GetTranscriptionJobRequest, opts?: client.RequestOptions): Promise<GetTranscriptionJobResponse>

[src]

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.

getVocabulary(params: GetVocabularyRequest, opts?: client.RequestOptions): Promise<GetVocabularyResponse>

[src]

Gets information about a vocabulary.

getVocabularyFilter(params: GetVocabularyFilterRequest, opts?: client.RequestOptions): Promise<GetVocabularyFilterResponse>

[src]

Returns information about a vocabulary filter.

listCallAnalyticsCategories(params?: ListCallAnalyticsCategoriesRequest, opts?: client.RequestOptions): Promise<ListCallAnalyticsCategoriesResponse>

[src]

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.

listCallAnalyticsJobs(params?: ListCallAnalyticsJobsRequest, opts?: client.RequestOptions): Promise<ListCallAnalyticsJobsResponse>

[src]

List call analytics jobs with a specified status or substring that matches their names.

listLanguageModels(params?: ListLanguageModelsRequest, opts?: client.RequestOptions): Promise<ListLanguageModelsResponse>

[src]

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.

listMedicalTranscriptionJobs(params?: ListMedicalTranscriptionJobsRequest, opts?: client.RequestOptions): Promise<ListMedicalTranscriptionJobsResponse>

[src]

Lists medical transcription jobs with a specified status or substring that matches their names.

listMedicalVocabularies(params?: ListMedicalVocabulariesRequest, opts?: client.RequestOptions): Promise<ListMedicalVocabulariesResponse>

[src]

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.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists all tags associated with a given transcription job, vocabulary, or resource.

listTranscriptionJobs(params?: ListTranscriptionJobsRequest, opts?: client.RequestOptions): Promise<ListTranscriptionJobsResponse>

[src]

Lists transcription jobs with the specified status.

listVocabularies(params?: ListVocabulariesRequest, opts?: client.RequestOptions): Promise<ListVocabulariesResponse>

[src]

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.

listVocabularyFilters(params?: ListVocabularyFiltersRequest, opts?: client.RequestOptions): Promise<ListVocabularyFiltersResponse>

[src]

Gets information about vocabulary filters.

startCallAnalyticsJob(params: StartCallAnalyticsJobRequest, opts?: client.RequestOptions): Promise<StartCallAnalyticsJobResponse>

[src]

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.

startMedicalTranscriptionJob(params: StartMedicalTranscriptionJobRequest, opts?: client.RequestOptions): Promise<StartMedicalTranscriptionJobResponse>

[src]

Starts a batch job to transcribe medical speech to text.

startTranscriptionJob(params: StartTranscriptionJobRequest, opts?: client.RequestOptions): Promise<StartTranscriptionJobResponse>

[src]

Starts an asynchronous job to transcribe speech to text.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Tags an Amazon Transcribe resource with the given list of tags.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes specified tags from a specified Amazon Transcribe resource.

updateCallAnalyticsCategory(params: UpdateCallAnalyticsCategoryRequest, opts?: client.RequestOptions): Promise<UpdateCallAnalyticsCategoryResponse>

[src]

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.

updateMedicalVocabulary(params: UpdateMedicalVocabularyRequest, opts?: client.RequestOptions): Promise<UpdateMedicalVocabularyResponse>

[src]

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.

updateVocabulary(params: UpdateVocabularyRequest, opts?: client.RequestOptions): Promise<UpdateVocabularyResponse>

[src]

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.

updateVocabularyFilter(params: UpdateVocabularyFilterRequest, opts?: client.RequestOptions): Promise<UpdateVocabularyFilterResponse>

[src]

Updates a vocabulary filter with a new list of filtered words.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]