Skip to content

Commit 9e662b8

Browse files
committed
feat(client-search): Updating searchoptions type to include explain attribute
1 parent 407e949 commit 9e662b8

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

packages/client-search/src/types/SearchOptions.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -373,4 +373,11 @@ export type SearchOptions = {
373373
* Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
374374
*/
375375
readonly queryLanguages?: readonly string[];
376+
377+
/**
378+
* Enriches the API’s response with meta-information as to how the query was processed. This attirbute powers the 'Query Alternatives' explanation.
379+
* There is currently no official documentation on the API for this attribute.
380+
* @link RFC: https://docs.google.com/document/d/1Z58mZks5EiF1z0tbswLpKMSw-rRngRpESdBqGoAAzDo
381+
*/
382+
readonly explain?: readonly string[];
376383
};

0 commit comments

Comments
 (0)