Grouping

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.

1
search_pager = client.search.query(
2
    index_id="<YOUR_INDEX_ID>",
3
    query_text="<YOUR_QUERY>",
4
    search_options=["visual"],
5
    group_by="video",
6
)
7
for group in search_pager:
8
    if group.clips is None:
9
        continue
10
    print(f"  Video ID: {group.id}")
11
    for clip in group.clips:
12
        print(
13
            f"  rank={clip.rank} start={clip.start} end={clip.end}"
14
        )