Custom Dictionary & Custom Glossary

Navigating to Captions and Audio Settings

The Captions and Audio page allows you to manage your custom dictionary and custom glossary.

Click on the Admin Menu and select Captions and Audio.

Adding Manual Entries

Custom Dictionary

The Custom Dictionary (labeled Text Replacement Dictionary in Studio) allows you to add words and phrases that should be replaced with a different word or phrase.

To add a word or phrase to the custom dictionary, follow the next steps:

1. Click Add and enter your entries in the Edit Text Replacement Dictionary dialog. Each entry pairs an original word or phrase with its replacement:

             
                 original word or phrase → replaced word or phrase
             
           

2. Click Save

   

3. You will see the message Text replacement dictionary updated successfully.

   

Custom Glossary

The Custom Glossary allows you to add words and phrases that should be recognized and kept consistent.

To add a word or phrase to the custom glossary, follow the next steps:

1. Click Edit and enter the word or phrase you want to add to the custom glossary. Add each term separately.
2. Click Save

   

3. You will see the message Captions glossary updated successfully.

   

Adding Bulk Entries

Custom Dictionary

To add entries in bulk, follow the next steps:

1. Click Upload CSV

   

2. Click Browse Files to select your CSV file.

   

3. You will see the message Captions dictionary updated successfully. and the Text Replacement Dictionary section will show your updated entries.

   

Custom Glossary

To add entries in bulk, follow the next steps:

1. Click Upload CSV

   

2. Select and open your file

3. You will see the message Captions glossary updated successfully. and the Glossary section will show your updated entries.

   

Triggering the Custom Dictionary & Custom Glossary

Select Use Dictionary in the Captions section of the Upload dialog to activate the custom dictionary and custom glossary while Generating captions when uploading videos.

Using the API

You can also manage your custom captions dictionary and glossary using the Brightcove Ingest API.

• To retrieve the current custom dictionary and custom glossary entries, send a GET request to:

          https://ingest.api.brightcove.com/v1/accounts/{account_id}/autocaption-dictionary
      

  Sample response with one dictionary entry and one glossary entry:

            {
              "entries": {
                "My website dot com": "mywebsite.com",
                "Schrödinger": ""
              },
              "message": "AI dictionary retrieved successfully"
             }
            

• To add or remove entries, send a PUT request to the same endpoint with a request body such as:

            {
              "add": {
                "hello": "hi",
                "world": "earth",
                "Schrödinger": ""
              },
              "remove": {
                "house": "home"
              }
             }
              

• To use the dictionary and glossary during ingestion, include "use_dictionary": true next to the other transcription parameters in the ingestion request.