Merge pull request #22 from oramasearch/feat/sort-groups

Allow sorting for groups by score

Author: allevo

src/collection.ts

@@ -174,14 +174,21 @@ export class CollectionManager {
 
   public async search<R = AnyObject>(query: SearchParams, init?: ClientRequestInit): Promise<SearchResult<R>> {
     const start = Date.now()
-    const { datasourceIDs, indexes, ...restQuery } = query
+    const { datasourceIDs, indexes, groupBy, ...restQuery } = query
+
+    // Extract sortBy from groupBy (client-side only, not sent to backend)
+    const groupsSortBy = groupBy?.sortBy
+    const groupByForApi = groupBy
+      ? { properties: groupBy.properties, max_results: groupBy.max_results }
+      : undefined
 
     const result = await this.client.request<Omit<SearchResult<R>, 'elapsed'>>({
       path: `/v1/collections/${this.collectionID}/search`,
       body: {
         userID: this.profile?.getUserId() || undefined,
         ...restQuery, // restQuery can override `userID`
         indexes: datasourceIDs || indexes,
+        groupBy: groupByForApi,
       },
       method: 'POST',
       params: undefined,
@@ -190,6 +197,15 @@ export class CollectionManager {
       target: 'reader',
     })
 
+    // Sort groups by score of first element if requested
+    if (groupsSortBy === 'score' && result.groups) {
+      result.groups.sort((a, b) => {
+        const scoreA = a.result[0]?.score ?? 0
+        const scoreB = b.result[0]?.score ?? 0
+        return scoreB - scoreA // Descending order
+      })
+    }
+
     const elapsed = Date.now() - start
 
     return {

src/lib/types.ts

@@ -63,6 +63,8 @@ export type Hook = 'BeforeAnswer' | 'BeforeRetrieval'
 
 export type SearchMode = 'fulltext' | 'vector' | 'hybrid' | 'auto'
 
+export type GroupsSortBy = 'default' | 'score'
+
 export type SearchParams = {
   term: string
   mode?: SearchMode
@@ -79,7 +81,7 @@ export type SearchParams = {
   similarity?: number
   tolerance?: number
   userID?: string
-  groupBy?: { properties: string[]; max_results?: number }
+  groupBy?: { properties: string[]; max_results?: number; sortBy?: GroupsSortBy }
 }
 
 export type CloudSearchParams = Omit<SearchParams, 'indexes'> & { datasourceIDs?: string[] }