Manage indexes

An index is a basic unit for organizing and storing video data consisting of video embeddings and metadata. Indexes facilitate information retrieval and processing. The Resources.Index class provides methods to manage your indexes.

Properties

NameTypeDescription
videoVideoResourceUse this property to manage the videos uploaded to this index.

Methods

Create an index

Description: This method creates a new index based on the provided parameters.

Function signature and example:

1async create(
2  { name, models, addons }: CreateIndexParams,
3  options: RequestOptions = {},
4): Promise<Models.Index>

Parameters

NameTypeRequiredDescription
paramsCreateIndexParamsYesParameters for creating the index.
optionsRequestOptionsNoAdditional options for the request. Defaults to {}.

The CreateIndexParams interface has the following properties:

NameTypeRequiredDescription
namestringYesThe name of the new index.
modelsname: 'marengo2.7' | 'pegasus1.2'; options: ('visual' | 'audio')[] }[]YesA list of objects specifying the video understanding models and the model options you want to enable for this index. Each object is a dictionary with two keys: name' and 'options.
addonsstring[]NoA list specifying which add-ons you want to enable.

Return value: Returns a Promise that resolves to a Models.Index instance representing the newly created index.

API Reference: For a description of each field in the request and response, see the Create an index page.

Related guide: Create indexes.

Retrieve an index

Description: This method retrieves details of a specific index.

Function signature and example:

1async retrieve(id: string, options: RequestOptions = {}): Promise<Models.Index>

Parameters

NameTypeRequiredDescription
idstringYesThe unique identifier of the index you want to retrieve.
optionsRequestOptionsNoAdditional options for the request. Defaults to {}.

Return value: Returns a Promise that resolves to a Models.Index instance.

API Reference: For a description of each field in the request and response, see the Retrieve an index page

List indexes with direct pagination

Description: The list method retrieves a paginated list of indexes based on the provided parameters. Choose this method mainly when the total number of items is manageable, or you must fetch a single page of results. By default, the platform returns your indexes sorted by creation date, with the newest at the top of the list.

Function signature and example:

1async list(
2  { id, name, createdAt, updatedAt, ...restParams }: ListIndexParams = {},
3  options: RequestOptions = {},
4): Promise<Models.Index[]>

Parameters

NameTypeRequiredDescription
paramsListIndexParamsNoParameters for retrieving the list of indexes. Defaults to {}.
optionsRequestOptionsNoAdditional options for the request. Defaults to {}.

The ListIndexParams interface extends the PageOptions interface and defines the parameters for listing indexes:

NameTypeRequiredDescription
idstringNoFilter by the unique identifier of an index.
namestringNoFilter by the name of an index.
modelOptionsstring[]NoFilter by model options.
modelFamily'marengo' | 'pegasus'NoFilter by the model family. It must be either ‘marengo’ or ‘pegasus’.
createdAtstring | Record<string, string>NoFilter by the creation date. This parameter can be a string or an object with string keys and string values for range queries.
updatedAtstring | Record<string, string>NoFilter by the last update date. This parameter can be a string or an object with string keys and string values for range queries.

The following properties are inherited from PageOptions:

NameTypeRequiredDescription
pagenumberNoPage number for pagination. Defaults to 1.
pageLimitnumberNoNumber of items per page. Defaults to 10.
sortBy'createdAt' | 'updatedAt'NoField to sort by (“createdAt” or “updatedAt”). Defaults to “createdAt”.
sortOption'asc' | 'desc'NoSort order (“asc” or “desc”). Defaults to “desc”.

Return value: Returns a Promise that resolves to an array of Models.Index instances.

API Reference: For a description of each field in the request and response, see the List indexes page.

Related guides:

List indexes with iterative pagination

Description: This method iterates through a paginated list of indexes based on the provided parameters. Choose this method mainly when your application must retrieve a large number of items. By default, the platform returns your indexes sorted by creation date, with the newest at the top of the list.

Function signature and example:

1  async listPagination(
2    { id, name, createdAt, updatedAt, ...restParams }: ListIndexParams = {},
3    options: RequestOptions = {},
4  ): Promise<Models.IndexListWithPagination>

Parameters

NameTypeRequiredDescription
paramsListIndexParamsNoParameters retrieving the list of indexes. Defaults to .
optionsRequestOptionsNoAdditional options for the request. Defaults to {}.

The ListIndexParams interface extends the PageOptions interface and defines the parameters for listing indexes:

NameTypeRequiredDescription
idstringNoFilter by the unique identifier of an index.
namestringNoFilter by the name of an index.
modelOptionsstring[]NoFilter by the model options.
modelFamily'marengo' | 'pegasus'NoFilter by the model family. It must be either ‘marengo’ or ‘pegasus’.
createdAtstring | Record<string, string>NoFilter by the creation date. This parameter can be a string or an object with string keys and string values for range queries.
updatedAtstring | Record<string, string>NoFilter by the last update date. This parameter can be a string or an object with string keys and string values for range queries.

The following properties are inherited from PageOptions:

NameTypeRequiredDescription
pagenumberNoPage number for pagination. Defaults to 1.
pageLimitnumberNoNumber of items per page. Defaults to 10.
sortBy'createdAt' | 'updatedAt'NoField to sort by (“createdAt” or “updatedAt”). Defaults to “createdAt”.
sortOption'asc' | 'desc'NoSort order (“asc” or “desc”). Defaults to “desc”.

Return value: Returns a Promise that resolves to a Models.IndexListWithPagination instance.

Note

To retrieve subsequent pages of results, use the async iterator protocol:

  1. Invoke the nextmethod of the IndexListWithPagination object.
  2. Repeat this call until the method returns a promise that resolves tonull, indicating no more pages exist.

API Reference: For a description of each field in the request and response, see the List indexes page.

Related guides:

Update an index

Description: This method updates the name of an existing index.

Function signature and example:

1async update(id: string, name: string, options: RequestOptions = {}): Promise<void>

Parameters:

NameTypeRequiredDescription
idstringYesThe unique identifier of the index you want to update.
namestringYesThe new name of the index.
optionsRequestOptionsNoAdditional options for the request. Defaults to {}.

Return value: Returns a Promise that resolves to void. This method doesn’t return any data upon successful completion.

API Reference: Update an index.

Delete an index

Description: This method deletes an existing index.

Function signature and example:

1async delete(id: string, options: RequestOptions = {}): Promise<void>

Parameters:

NameTypeRequiredDescription
idstringYesThe unique identifier of the index to delete.
optionsRequestOptionsNoAdditional options for the request. Defaults to {}.

Return value: Returns a Promise that resolves to void. This method doesn’t return any data upon successful completion.

API Reference: Delete an index.

Built with