feat(findAnswers): implement the new method (experimental) (#1219)

* feat(searchForAnswers): implement the new method

- adds searchForAnswers to node / browser (not lite for now)
- fix small typo in SearchOptions
- add an integration test

* make test pass

* chore: Rename to findAnswers

* fix(test): Remove superfluous newline in url

* chore: Order keys after renaming [ci skip]

* add newline

* restructure tests

* update bundlesize

* chore: don't omit any search parameters for now

Co-authored-by: Paul-Louis NECH <[email protected]>
Co-authored-by: Eunjae Lee <[email protected]>

Author: 3 people

package.json

@@ -98,7 +98,7 @@
   "bundlesize": [
     {
       "path": "packages/algoliasearch/dist/algoliasearch.umd.js",
-      "maxSize": "7.57KB"
+      "maxSize": "7.65KB"
     },
     {
       "path": "packages/algoliasearch/dist/algoliasearch-lite.umd.js",

packages/algoliasearch/src/builds/browser.ts

@@ -68,6 +68,9 @@ import {
   deleteSynonym,
   DeleteSynonymOptions,
   exists,
+  findAnswers,
+  FindAnswersOptions,
+  FindAnswersResponse,
   findObject,
   FindObjectOptions,
   FindObjectResponse,
@@ -237,6 +240,7 @@ export default function algoliasearch(
           methods: {
             batch,
             delete: deleteIndex,
+            findAnswers,
             getObject,
             getObjects,
             saveObject,
@@ -345,6 +349,11 @@ export type SearchIndex = BaseSearchIndex & {
     query: string,
     requestOptions?: RequestOptions & SearchOptions
   ) => Readonly<Promise<SearchResponse<TObject>>>;
+  readonly findAnswers: (
+    query: string,
+    queryLanguages: readonly string[],
+    requestOptions?: RequestOptions & FindAnswersOptions
+  ) => Readonly<Promise<FindAnswersResponse>>;
   readonly searchForFacetValues: (
     facetName: string,
     facetQuery: string,

packages/algoliasearch/src/builds/node.ts

@@ -67,6 +67,9 @@ import {
   deleteSynonym,
   DeleteSynonymOptions,
   exists,
+  findAnswers,
+  FindAnswersOptions,
+  FindAnswersResponse,
   findObject,
   FindObjectOptions,
   FindObjectResponse,
@@ -240,6 +243,7 @@ export default function algoliasearch(
           methods: {
             batch,
             delete: deleteIndex,
+            findAnswers,
             getObject,
             getObjects,
             saveObject,
@@ -353,6 +357,11 @@ export type SearchIndex = BaseSearchIndex & {
     facetQuery: string,
     requestOptions?: RequestOptions & SearchOptions
   ) => Readonly<Promise<SearchForFacetValuesResponse>>;
+  readonly findAnswers: (
+    query: string,
+    queryLanguages: readonly string[],
+    requestOptions?: RequestOptions & FindAnswersOptions
+  ) => Readonly<Promise<FindAnswersResponse>>;
   readonly batch: (
     requests: readonly BatchRequest[],
     requestOptions?: RequestOptions

packages/client-search/src/methods/index/findAnswers.ts

@@ -0,0 +1,26 @@
+import { encode } from '@algolia/client-common';
+import { MethodEnum } from '@algolia/requester-common';
+import { RequestOptions } from '@algolia/transporter';
+
+import { FindAnswersOptions, FindAnswersResponse, SearchIndex } from '../..';
+
+export const findAnswers = (base: SearchIndex) => {
+  return <TObject>(
+    query: string,
+    queryLanguages: readonly string[],
+    requestOptions?: RequestOptions & FindAnswersOptions
+  ): Readonly<Promise<FindAnswersResponse<TObject>>> => {
+    return base.transporter.read(
+      {
+        method: MethodEnum.Post,
+        path: encode('1/answers/%s/prediction', base.indexName),
+        data: {
+          query,
+          queryLanguages,
+        },
+        cacheable: true,
+      },
+      requestOptions
+    );
+  };
+};

packages/client-search/src/methods/index/index.ts

@@ -17,6 +17,7 @@ export * from './deleteObjects';
 export * from './deleteRule';
 export * from './deleteSynonym';
 export * from './exists';
+export * from './findAnswers';
 export * from './findObject';
 export * from './getObject';
 export * from './getObjectPosition';

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

@@ -0,0 +1,8 @@
+import { SearchOptions } from './SearchOptions';
+
+export type FindAnswersOptions = {
+  readonly attributesForPrediction?: readonly string[];
+  readonly nbHits?: number;
+  readonly threshold?: number;
+  readonly params?: SearchOptions;
+};

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

@@ -0,0 +1,21 @@
+import { Hit } from './Hit';
+import { SearchResponse } from './SearchResponse';
+
+export type FindAnswersResponse<TObject = {}> = SearchResponse<TObject> & {
+  /**
+   * The hits returned by the search.
+   *
+   * Hits are ordered according to the ranking or sorting of the index being queried.
+   */
+  hits: Array<
+    Hit<
+      TObject & {
+        _answer?: {
+          extract: string;
+          score: number;
+          extractAttribute: string;
+        };
+      }
+    >
+  >;
+};

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

@@ -312,7 +312,7 @@ export type SearchOptions = {
   /**
    * List of supported languages with their associated language ISO code.
    *
-   * Apply a set of natural language best practices such asignorePlurals,
+   * Apply a set of natural language best practices such as ignorePlurals,
    * removeStopWords, removeWordsIfNoResults, analyticsTags and ruleContexts.
    */
   readonly naturalLanguages?: readonly string[];

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

@@ -25,6 +25,8 @@ export * from './DeleteByFiltersOptions';
 export * from './DeleteResponse';
 export * from './DeleteSynonymOptions';
 export * from './FacetHit';
+export * from './FindAnswersOptions';
+export * from './FindAnswersResponse';
 export * from './FindObjectOptions';
 export * from './FindObjectResponse';
 export * from './GetApiKeyResponse';

specs/.prettierrc

@@ -0,0 +1,3 @@
+{
+  "singleQuote": false
+}