Query - VideoDB Documentation

Endpoints

POST /video/{video_id}/query
POST /collection/{collection_id}/query

Use query() when you know the exact index and filter fields.

Request body

Field	Type	Required	Description
`index_name`	string	no	Optional index name to query.
`index_id`	string	no	Optional index ID to query.
`filter`	list/object	no	Explicit filter spec. A top-level list is an implicit AND.
`limit`	integer	no	Maximum returned rows/moments. Defaults to `100`.
`sort`	list/string/object	no	Sort field and direction.
`return_fields`	string/list/dict	no	Select indexes to hydrate under `shot.metadata["indexes"]`.

Do not pass index_names or index_ids to query().

Example

results = collection.query(
    index_name="objects",
    filter=[
        {"field": "label", "op": "contains", "value": "cell phone"},
    ],
    limit=100,
    sort=[("max_score", "desc")],
    return_fields=["objects"],
)

Response

Returns a SearchResult containing Shot objects.