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 IndexesClient class provides methods to manage your indexes.

Properties

Methods

Create an index

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

Function signature and example:

1
def create(
2
    self,
3
    *,
4
    index_name: str,
5
    models: typing.Sequence[IndexesCreateRequestModelsItem],
6
    addons: typing.Optional[typing.Sequence[str]] = OMIT,
7
    request_options: typing.Optional[RequestOptions] = None,
8
) -> IndexesCreateResponse:

Parameters

The IndexesCreateRequestModelsItem class defines the model configuration for your index:

Return value

Returns an IndexesCreateResponse object containing a field named id representing the unique identifier of the newly created index.

API Reference

Create an index.

Related guide

Indexes.

Retrieve an index

Description: This method retrieves details of a specific index.

Function signature and example:

1
def retrieve(self, index_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> IndexSchema

Parameters

Return value

Returns an IndexSchema object representing the retrieved index.

The IndexSchema class contains the following properties:

The IndexModelsItem class contains the following properties:

API Reference

Retrieve an index.

List indexes

Description: This method retrieves a paginated list of indexes based on the provided parameters. 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
def list(
2
    self,
3
    *,
4
    page: typing.Optional[int] = None,
5
    page_limit: typing.Optional[int] = None,
6
    sort_by: typing.Optional[str] = None,
7
    sort_option: typing.Optional[str] = None,
8
    index_name: typing.Optional[str] = None,
9
    model_options: typing.Optional[str] = None,
10
    model_family: typing.Optional[str] = None,
11
    created_at: typing.Optional[str] = None,
12
    updated_at: typing.Optional[str] = None,
13
    request_options: typing.Optional[RequestOptions] = None,
14
) -> SyncPager[IndexSchema]

Parameters

Return value

Returns a SyncPager[IndexSchema] object containing a paginated list of IndexSchema objects, representing the indexes that match the specified criteria. See the Retrieve an index section above for complete property details.

The SyncPager[T] class contains the following properties and methods:

API Reference

List indexes.

Update an index

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

Function signature and example:

1
def update(
2
    self, index_id: str, *, index_name: str, request_options: typing.Optional[RequestOptions] = None
3
) -> None

Parameters

Return Value

None. 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:

1
def delete(self, index_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None

Parameters

Return value

None. This method doesn’t return any data upon successful completion.

API Reference

Delete an index

Error codes

This section lists the most common error messages you may encounter while managing indexes.

• index_option_cannot_be_changed
  • Index option cannot be changed. Please remove index_options parameter and try again. If you want to change index option, please create new index.
• index_engine_cannot_be_changed
  • Index engine cannot be changed. Please remove engine_id parameter and try again. If you want to change engine, please create new index.
• index_name_already_exists
  • Index name {index_name} already exists. Please use another unique name and try again.

For a list of general errors that apply to all endpoints, see the Error codes page.