Grouping | TwelveLabs

Grouping and ungrouping allow you to organize search results in different ways. The platform organizes matching clips under their respective videos when you group them by video. This helps when building a user interface, because it allows your users to better understand and navigate the search results. When you ungroup, the platform presents all matching clips in a flat list, which is useful for a simple view of all results.

Python

Node.js

When you set group_by to “video”, the response contains an array of objects, each object corresponding to a video that matches your query and includes the following fields:

id: The unique identifier of the video.
clips: An array that groups the information about all the matching video clips in that video.

Python

1 search_results = client.search.query(
2 index_id="<YOUR_INDEX_ID>, 
3 query_text="<YOUR_QUERY>, 
4 options=["visual"],
5 group_by="video"
6 )
7 
8 def print_page(page):
9     for video in page:
10         print(f"Video id: {video.id}")
11         for clip in video.clips:
12             print(clip)
13             print(
14                 f"\tscore={clip.score} start={clip.start} end={clip.end} confidence={clip.confidence}"
15             )
16 
17 print_page(search_results.data)
18 
19 while True:
20     try:
21         print_page(next(search_results))
22     except StopIteration:
23         break