Manage engines

The resources.Engine class provides methods to manage the video understanding engines available in your account.

Methods

Retrieve an engine

Description: This method retrieves an engine.

Function signature and example:

1retrieve(self, id: str, **kwargs) -> models.Engine

Parameters:

NameTypeRequiredDescription
idstrYesThe unique identifier of the engine to retrieve.
**kwargs**dictNoAdditional keyword arguments for the request.

Return value: Returns a models.Engine object representing the retrieved video understanding engine.

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

List engines

Description: This method lists all the video understanding engines that are available in your account.

Function signature and example:

1def list(self, **kwargs) -> RootModelList[models.Engine]

Parameters:

NameTypeRequiredDescription
**kwargs[dict]NoAdditional keyword arguments for the request.

Return value: Returns a RootModelList containing models.Engine objects.

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

Built with