Class VocabularyFilterService

AWS Transcribe Custom Vocabulary Filter service.

Inheritance
object
CrudServiceBase<AwsClient>
VocabularyFilterService
Implements
Inherited Members
Namespace: Glitch9.AIDevKit.AmazonAws.Transcribe.Services
Assembly: Glitch9.AIDevKit.Provider.AmazonAws.dll
Syntax
public sealed class VocabularyFilterService : CrudServiceBase<AwsClient>, ICrudService
Remarks

Custom vocabulary filters mask, delete, or flag specific words in transcripts. Commonly used to filter profanity or sensitive information.

Constructors

| Edit this page View Source

VocabularyFilterService(AwsClient)

Declaration
public VocabularyFilterService(AwsClient client)
Parameters
Type Name Description
AwsClient client

Methods

| Edit this page View Source

CreateAsync(CreateVocabularyFilterRequest, RequestOptions)

Creates a custom vocabulary filter.

Declaration
public UniTask<VocabularyFilterFileUri> CreateAsync(CreateVocabularyFilterRequest request, RequestOptions options = null)
Parameters
Type Name Description
CreateVocabularyFilterRequest request

Must include VocabularyFilterName and LanguageCode. Provide either Words array or VocabularyFilterFileUri (mutually exclusive).
RequestOptions options
Returns
Type Description
UniTask<VocabularyFilterFileUri>

VocabularyFilterResponse with filter details.
| Edit this page View Source

DeleteAsync(string, RequestOptions)

Deletes a vocabulary filter.

Declaration
public UniTask<bool> DeleteAsync(string vocabularyFilterName, RequestOptions options = null)
Parameters
Type Name Description
string vocabularyFilterName

The name of the filter to delete.
RequestOptions options
Returns
Type Description
UniTask<bool>

True if deletion was successful.
| Edit this page View Source

GetAsync(string, RequestOptions)

Retrieves details about a vocabulary filter.

Declaration
public UniTask<VocabularyFilterFileUri> GetAsync(string vocabularyFilterName, RequestOptions options = null)
Parameters
Type Name Description
string vocabularyFilterName

The name of the filter to retrieve.
RequestOptions options
Returns
Type Description
UniTask<VocabularyFilterFileUri>

VocabularyFilterResponse with filter details including DownloadUri.
| Edit this page View Source

ListAsync(TranscribeListRequest, RequestOptions)

Lists vocabulary filters matching the specified criteria.

Declaration
public UniTask<VocabularyFilterList> ListAsync(TranscribeListRequest request = null, RequestOptions options = null)
Parameters
Type Name Description
TranscribeListRequest request

Optional filters: NameContains, MaxResults (1-100), NextToken for pagination.
RequestOptions options
Returns
Type Description
UniTask<VocabularyFilterList>

ListVocabularyFiltersResponse with filter list and optional NextToken.
| Edit this page View Source

UpdateAsync(UpdateVocabularyFilterRequest, RequestOptions)

Updates an existing vocabulary filter.

Declaration
public UniTask<VocabularyFilterFileUri> UpdateAsync(UpdateVocabularyFilterRequest request, RequestOptions options = null)
Parameters
Type Name Description
UpdateVocabularyFilterRequest request

The new list overwrites all previous entries. Provide either Words array or VocabularyFilterFileUri (mutually exclusive).
RequestOptions options
Returns
Type Description
UniTask<VocabularyFilterFileUri>

VocabularyFilterResponse with updated filter details.

Implements

Extension Methods