Add rankingScore and rankingScoreDetails types (#1537)

* Experimental vector search for MS v1.3.0

* Add vector search error codes

* Use permission as key when enabling the experimental prototype

* Add rankingScore and rankingScoreDetails types

* Use RankingScoreDetails type to type _rankingScoreDetails

Author: bidoubiwa

src/types/types.ts

@@ -109,6 +109,8 @@ export type SearchParams = Query &
     facetName?: string
     facetQuery?: string
     vector?: number[] | null
+    showRankingScore?: boolean
+    showRankingScoreDetails?: boolean
     attributesToSearchOn?: string[] | null
   }
 
@@ -148,6 +150,39 @@ export type MatchesPosition<T> = Partial<
 export type Hit<T = Record<string, any>> = T & {
   _formatted?: Partial<T>
   _matchesPosition?: MatchesPosition<T>
+  _rankingScore?: number
+  _rankingScoreDetails?: RakingScoreDetails
+}
+
+export type RakingScoreDetails = {
+  words?: {
+    order: number
+    matchingWords: number
+    maxMatchingWords: number
+    score: number
+  }
+  typo?: {
+    order: number
+    typoCount: number
+    maxTypoCount: number
+    score: number
+  }
+  proximity?: {
+    order: number
+    score: number
+  }
+  attribute?: {
+    order: number
+    attributes_ranking_order: number
+    attributes_query_word_order: number
+    score: number
+  }
+  exactness?: {
+    order: number
+    matchType: string
+    score: number
+  }
+  [key: string]: Record<string, any> | undefined
 }
 
 export type Hits<T = Record<string, any>> = Array<Hit<T>>

tests/search.test.ts

@@ -257,6 +257,51 @@ describe.each([
     expect(hit.id).toEqual(1)
   })
 
+  test(`${permission} key: search with _showRankingScore enabled`, async () => {
+    const client = await getClient(permission)
+
+    const response = await client.index(index.uid).search('prince', {
+      showRankingScore: true,
+    })
+
+    const hit = response.hits[0]
+
+    expect(response).toHaveProperty('hits', expect.any(Array))
+    expect(response).toHaveProperty('query', 'prince')
+    expect(hit).toHaveProperty('_rankingScore')
+  })
+
+  test(`${permission} key: search with showRankingScoreDetails enabled`, async () => {
+    const client = await getClient(permission)
+    const key = await getKey(permission)
+
+    await fetch(`${HOST}/experimental-features`, {
+      body: JSON.stringify({ scoreDetails: true }),
+      headers: {
+        Authorization: `Bearer ${key}`,
+        'Content-Type': 'application/json',
+      },
+      method: 'PATCH',
+    })
+
+    const response = await client.index(index.uid).search('prince', {
+      showRankingScoreDetails: true,
+    })
+
+    const hit = response.hits[0]
+
+    expect(response).toHaveProperty('hits', expect.any(Array))
+    expect(response).toHaveProperty('query', 'prince')
+    expect(hit).toHaveProperty('_rankingScoreDetails')
+    expect(Object.keys(hit._rankingScoreDetails || {})).toEqual([
+      'words',
+      'typo',
+      'proximity',
+      'attribute',
+      'exactness',
+    ])
+  })
+
   test(`${permission} key: search with array options`, async () => {
     const client = await getClient(permission)