An index is a basic unit for organizing and storing your video data (video embeddings and metadata). Indexes facilitate information retrieval and processing.

You can use indexes to group related videos. For example, if you want to upload multiple videos from a car race, Twelve Labs recommends you create a single index and upload all the videos to it.

You can manage your indexes from the Indexes page:

1. Create an Index: Opens a modal to create a new index.

2. Index information: Displays the following information about each index:

   1. A thumbnail of the first video

   2. Three dots button, allowing you to rename or remove this index

   3. The number of videos in this index

   4. (Optional) When videos are being indexed, the Playground displays the progress of the indexing process.

   5. Index name

   6. The video understanding engine that is enabled for this index:

      • Marengo, for searching and classifying videos, is represented by the following icon:
        

      • Pegasus, for generating text from videos, is represented by the following icon:
        

3. Quick actions: Provides quick access to commonly used actions that you can perform on an index.

4. Subscription details: Shows the total duration of the videos you have indexed on the Free plan.

The following sections describe the most common actions you can perform on the Indexes page.

Create an index

1. From the Indexes page, select the Create an Index tile.

2. Enter a descriptive name for your index.

3. Select the appropriate video understanding engine based on your needs:

   • For search and classification, use Marengo.
   • For generating text from video, use Pegasus.

4. Depending on your previous selection, choose the engine options you want to enable. The engine options determine how videos in the index are processed. Note that once set, these settings cannot be changed.

   • For Marengo, choose one or more of the following engine options: visual, conversation, text in video, or logo.

     

   • For Pegasus, choose one or both of the following engine options: visual or conversation.

     

5. When you've finished, select the Create button.

Rename an index

1. From the Indexes page, find the index that you want to rename, and select the three dots button located at the top-right corner of the tile.
2. Select Rename Index.
3. Enter the desired name.
4. When you've finished, select the Save button.

Delete an index

📘

Notes:

• Deleting an index removes all the information about it.
• This action cannot be undone.

1. From the Indexes page, find the index that you want to delete, and select the three dots button located at the top-right corner of the tile.
2. Select Delete Index.
3. Review the information displayed in the modal, and select the Delete Index button.