The resources.Search class provides methods to perform searches.

Related quickstart notebook

Methods

Make a search request

Description: This method performs a search across a specific index based on the provided parameters and returns the first page of results.

Function signature and example:

1
def query(
2
    self,
3
    index_id: str,
4
    options: List[Literal["visual", "audio"]],
5
    *,
6
    query_text: str = None,
7
    query_media_type: Literal["image"] = None,
8
    query_media_file: Union[str, BinaryIO, None] = None,
9
    query_media_url: str = None,
10
    group_by: Optional[Literal["video", "clip"]] = None,
11
    threshold: Optional[Literal["high", "medium", "low", "none"]] = None,
12
    operator: Optional[Literal["or", "and"]] = None,
13
    filter: Optional[Dict[str, Any]] = None,
14
    page_limit: Optional[int] = None,
15
    sort_option: Optional[Literal["score", "clip_count"]] = None,
16
    adjust_confidence_level: Optional[float] = None,
17
    **kwargs
18
) -> models.SearchResult

Parameters:

Return value: Returns a models.SearchResult object containing the search results.

API Reference: For a detailed description of each field in the request and response, see the Any-to-video search page.

Related guides:

• Search.
• Pagination > Search results.
• Sorting > Search results
• Filtering > Search results
• Grouping and ungrouping.

Retrieve a specific page of search results

Description: This method retrieves a specific page of search results. This method provides direct pagination. Choose it mainly when the total number of items is manageable, or you must fetch a single page of results.

Function signature and example:

1
def by_page_token(self, page_token: str, **kwargs) -> models.SearchResult

Parameters:

Return value: Returns a models.SearchResult object containing the search results.

API Reference: For a description of each field in the request and response, see the Retrieve a specific page of search results page.

Related guides:

• Search.
• Pagination > Search results.
• Sorting > Search results
• Filtering > Search results
• Grouping and ungrouping.

Iterative pagination

If your application must retrieve a large number of items, use iterative pagination. To retrieve the first page of results, invoke the query method of the search object. To retrieve subsequent pages of results, use the iterator protocol.

1
from twelvelabs.models.search import SearchData, GroupByVideoSearchData
2
3
def print_search_data(data: SearchData):
4
    print(f"  Score: {data.score}")
5
    print(f"  Start: {data.start}")
6
    print(f"  End: {data.end}")
7
    print(f"  Video ID: {data.video_id}")
8
    print(f"  Confidence: {data.confidence}")
9
    print(f"  Thumbnail URL: {data.thumbnail_url}")
10
11
def print_page(result):
12
    # Print the search results
13
    print("Search Results:")
14
    for item in getattr(result, 'data', result):
15
        if isinstance(item, GroupByVideoSearchData):
16
            print(f"Video ID: {item.id}")
17
            if item.clips:
18
                for clip in item.clips:
19
                    print_search_data(clip)
20
        else:
21
            print_search_data(item)
22
23
24
# Initial query
25
search_results = client.search.query(
26
    index_id="<YOUR_INDEX_ID>",
27
    options=["visual", "audio"],
28
    query_text="man laughing",
29
    group_by="clip",
30
    # threshold="medium",
31
    operator="or",
32
    # filter={"category": "nature"},
33
    page_limit=2,
34
    sort_option="score",
35
    # adjust_confidence_level=0.5
36
)
37
38
# Print the search pool information
39
print("Search pool:")
40
print(f"  Total count: {search_results.pool.total_count}")
41
print(f"  Total duration: {search_results.pool.total_duration}")
42
print(f"  Index ID: {search_results.pool.index_id}")
43
44
# Print the first page
45
print_page(search_results)
46
47
# Print subsequent pages using the iterator protocol
48
page_number = 2
49
while True:
50
    try:
51
        print(f"Page {page_number}")
52
        print_page(next(search_results))
53
        page_number += 1
54
    except StopIteration:
55
        break
56
57
print("No more results.")

Error codes

This section lists the most common error messages you may encounter while using the search.

• search_option_not_supported
  • Search option {search_option} is not supported for index {index_id}. Please use one of the following search options: {supported_search_option}.
• search_option_combination_not_supported
  • Search option {search_option} is not supported with {other_combination}.
• search_filter_invalid
  • Filter used in search is invalid. Please use the valid filter syntax by following filtering documentation.
• search_page_token_expired
  • The token that identifies the page to be retrieved is expired or invalid. You must make a new search request. Token: {next_page_token}.
• index_not_supported_for_search:
  • You can only perform search requests on indexes with an engine from the Marengo family enabled.

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