Amazon Transcribe Service

2019/03/25 - Amazon Transcribe Service - 2 updated api methods

Changes  Amazon Transcribe - With this release Amazon Transcribe enhances the custom vocabulary feature to improve accuracy by providing customization on pronunciations and output formatting.

CreateVocabulary (updated) Link ¶
Changes (request) 
{'VocabularyFileUri': 'string'}

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

See also: AWS API Documentation

Request Syntax

client.create_vocabulary(
    VocabularyName='string',
    LanguageCode='en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR',
    Phrases=[
        'string',
    ],
    VocabularyFileUri='string'
)
type VocabularyName

string

param VocabularyName

[REQUIRED]

The name of the vocabulary. The name must be unique within an AWS account. The name is case-sensitive.

type LanguageCode

string

param LanguageCode

[REQUIRED]

The language code of the vocabulary entries.

type Phrases

list

param Phrases

An array of strings that contains the vocabulary entries.

  • (string) --

type VocabularyFileUri

string

param VocabularyFileUri

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

https://s3-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>

For example:

https://s3-us-east-1.amazonaws.com/examplebucket/vocab.txt

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.

rtype

dict

returns

Response Syntax

{
    'VocabularyName': 'string',
    'LanguageCode': 'en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR',
    'VocabularyState': 'PENDING'|'READY'|'FAILED',
    'LastModifiedTime': datetime(2015, 1, 1),
    'FailureReason': 'string'
}

Response Structure

  • (dict) --

    • VocabularyName (string) --

      The name of the vocabulary.

    • LanguageCode (string) --

      The language code of the vocabulary entries.

    • VocabularyState (string) --

      The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request.

    • LastModifiedTime (datetime) --

      The date and time that the vocabulary was created.

    • FailureReason (string) --

      If the VocabularyState field is FAILED , this field contains information about why the job failed.

UpdateVocabulary (updated) Link ¶
Changes (request) 
{'VocabularyFileUri': 'string'}

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.

See also: AWS API Documentation

Request Syntax

client.update_vocabulary(
    VocabularyName='string',
    LanguageCode='en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR',
    Phrases=[
        'string',
    ],
    VocabularyFileUri='string'
)
type VocabularyName

string

param VocabularyName

[REQUIRED]

The name of the vocabulary to update. The name is case-sensitive.

type LanguageCode

string

param LanguageCode

[REQUIRED]

The language code of the vocabulary entries.

type Phrases

list

param Phrases

An array of strings containing the vocabulary entries.

  • (string) --

type VocabularyFileUri

string

param VocabularyFileUri

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

https://s3-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>

For example:

https://s3-us-east-1.amazonaws.com/examplebucket/vocab.txt

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.

rtype

dict

returns

Response Syntax

{
    'VocabularyName': 'string',
    'LanguageCode': 'en-US'|'es-US'|'en-AU'|'fr-CA'|'en-GB'|'de-DE'|'pt-BR'|'fr-FR'|'it-IT'|'ko-KR',
    'LastModifiedTime': datetime(2015, 1, 1),
    'VocabularyState': 'PENDING'|'READY'|'FAILED'
}

Response Structure

  • (dict) --

    • VocabularyName (string) --

      The name of the vocabulary that was updated.

    • LanguageCode (string) --

      The language code of the vocabulary entries.

    • LastModifiedTime (datetime) --

      The date and time that the vocabulary was updated.

    • VocabularyState (string) --

      The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request.