Class VocabularyService

AWS Transcribe Custom Vocabulary service.

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

Custom vocabularies improve transcription accuracy for domain-specific terms. Vocabularies can be created from a list of phrases or an S3 text file.

Constructors

| Edit this page View Source

VocabularyService(AwsClient)

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

Methods

| Edit this page View Source

CreateAsync(CreateVocabularyRequest, RequestOptions)

Creates a new custom vocabulary.

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

Vocabulary creation parameters.
RequestOptions options

Optional REST request options.
Returns
Type Description
UniTask<VocabularyFileUri>

Vocabulary creation response with initial state (PENDING).
| Edit this page View Source

DeleteAsync(string, RequestOptions)

Deletes a custom vocabulary.

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

Name of the vocabulary to delete (case-sensitive).
RequestOptions options

Optional REST request options.
Returns
Type Description
UniTask<bool>

True if deletion succeeded.
| Edit this page View Source

GetAsync(string, RequestOptions)

Retrieves information about a specific custom vocabulary.

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

Name of the vocabulary (case-sensitive).
RequestOptions options

Optional REST request options.
Returns
Type Description
UniTask<VocabularyFileUri>

Vocabulary details including download URI and state.
| Edit this page View Source

ListAsync(TranscribeListRequest, RequestOptions)

Lists custom vocabularies matching specified criteria.

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

List filter parameters (optional).
RequestOptions options

Optional REST request options.
Returns
Type Description
UniTask<VocabularyList>

List of vocabularies with pagination support.
| Edit this page View Source

UpdateAsync(UpdateVocabularyRequest, RequestOptions)

Updates an existing custom vocabulary. This overwrites all existing information.

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

Vocabulary update parameters.
RequestOptions options

Optional REST request options.
Returns
Type Description
UniTask<VocabularyFileUri>

Vocabulary update response.

Implements

Extension Methods