@algolia/recommend 5.0.0-alpha.8 → 5.0.0-alpha.81

package/dist/model/indexSettingsAsSearchParams.d.ts

@@ -1,161 +1,167 @@
-import type { AdvancedSyntaxFeatures } from './advancedSyntaxFeatures';
-import type { AlternativesAsExact } from './alternativesAsExact';
-import type { Distinct } from './distinct';
-import type { ExactOnSingleWordQuery } from './exactOnSingleWordQuery';
-import type { IgnorePlurals } from './ignorePlurals';
-import type { QueryType } from './queryType';
-import type { RemoveStopWords } from './removeStopWords';
-import type { RemoveWordsIfNoResults } from './removeWordsIfNoResults';
-import type { RenderingContent } from './renderingContent';
-import type { TypoTolerance } from './typoTolerance';
-export declare type IndexSettingsAsSearchParams = {
-    /**
-     * The complete list of attributes that will be used for faceting.
-     */
-    attributesForFaceting?: string[];
-    /**
-     * List of attributes that can\'t be retrieved at query time.
-     */
-    unretrievableAttributes?: string[];
-    /**
-     * This parameter controls which attributes to retrieve and which not to retrieve.
-     */
-    attributesToRetrieve?: string[];
-    /**
-     * Restricts a given query to look in only a subset of your searchable attributes.
-     */
-    restrictSearchableAttributes?: string[];
-    /**
-     * Controls how Algolia should sort your results.
-     */
-    ranking?: string[];
-    /**
-     * Specifies the custom ranking criterion.
-     */
-    customRanking?: string[];
-    /**
-     * Controls the relevancy threshold below which less relevant results aren\'t included in the results.
-     */
-    relevancyStrictness?: number;
-    /**
-     * List of attributes to highlight.
-     */
-    attributesToHighlight?: string[];
-    /**
-     * List of attributes to snippet, with an optional maximum number of words to snippet.
-     */
-    attributesToSnippet?: string[];
-    /**
-     * The HTML string to insert before the highlighted parts in all highlight and snippet results.
-     */
-    highlightPreTag?: string;
-    /**
-     * The HTML string to insert after the highlighted parts in all highlight and snippet results.
-     */
-    highlightPostTag?: string;
-    /**
-     * String used as an ellipsis indicator when a snippet is truncated.
-     */
-    snippetEllipsisText?: string;
-    /**
-     * Restrict highlighting and snippeting to items that matched the query.
-     */
-    restrictHighlightAndSnippetArrays?: boolean;
-    /**
-     * Set the number of hits per page.
-     */
-    hitsPerPage?: number;
-    /**
-     * Minimum number of characters a word in the query string must contain to accept matches with 1 typo.
-     */
-    minWordSizefor1Typo?: number;
-    /**
-     * Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
-     */
-    minWordSizefor2Typos?: number;
-    typoTolerance?: TypoTolerance;
-    /**
-     * Whether to allow typos on numbers (\"numeric tokens\") in the query string.
-     */
-    allowTyposOnNumericTokens?: boolean;
-    /**
-     * List of attributes on which you want to disable typo tolerance.
-     */
-    disableTypoToleranceOnAttributes?: string[];
-    ignorePlurals?: IgnorePlurals;
-    removeStopWords?: RemoveStopWords;
-    /**
-     * List of characters that the engine shouldn\'t automatically normalize.
-     */
-    keepDiacriticsOnCharacters?: string;
-    /**
-     * Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
-     */
-    queryLanguages?: string[];
-    /**
-     * Splits compound words into their composing atoms in the query.
-     */
-    decompoundQuery?: boolean;
-    /**
-     * Whether Rules should be globally enabled.
-     */
-    enableRules?: boolean;
-    /**
-     * Enable the Personalization feature.
-     */
-    enablePersonalization?: boolean;
-    queryType?: QueryType;
-    removeWordsIfNoResults?: RemoveWordsIfNoResults;
-    /**
-     * Enables the advanced query syntax.
-     */
-    advancedSyntax?: boolean;
-    /**
-     * A list of words that should be considered as optional when found in the query.
-     */
-    optionalWords?: string[];
-    /**
-     * List of attributes on which you want to disable the exact ranking criterion.
-     */
-    disableExactOnAttributes?: string[];
-    exactOnSingleWordQuery?: ExactOnSingleWordQuery;
-    /**
-     * List of alternatives that should be considered an exact match by the exact ranking criterion.
-     */
-    alternativesAsExact?: AlternativesAsExact[];
-    /**
-     * Allows you to specify which advanced syntax features are active when ‘advancedSyntax\' is enabled.
-     */
-    advancedSyntaxFeatures?: AdvancedSyntaxFeatures[];
-    distinct?: Distinct;
-    /**
-     * Name of the de-duplication attribute to be used with the distinct feature.
-     */
-    attributeForDistinct?: string;
-    /**
-     * Whether to take into account an index\'s synonyms for a particular search.
-     */
-    synonyms?: boolean;
-    /**
-     * Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
-     */
-    replaceSynonymsInHighlight?: boolean;
-    /**
-     * Precision of the proximity ranking criterion.
-     */
-    minProximity?: number;
-    /**
-     * Choose which fields to return in the API response. This parameters applies to search and browse queries.
-     */
-    responseFields?: string[];
-    /**
-     * Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.
-     */
-    maxFacetHits?: number;
-    /**
-     * When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage.
-     */
-    attributeCriteriaComputedByMinProximity?: boolean;
-    renderingContent?: RenderingContent;
-};
+import type { AdvancedSyntaxFeatures } from './advancedSyntaxFeatures';
+import type { AlternativesAsExact } from './alternativesAsExact';
+import type { Distinct } from './distinct';
+import type { ExactOnSingleWordQuery } from './exactOnSingleWordQuery';
+import type { IgnorePlurals } from './ignorePlurals';
+import type { Mode } from './mode';
+import type { QueryType } from './queryType';
+import type { ReRankingApplyFilter } from './reRankingApplyFilter';
+import type { RemoveStopWords } from './removeStopWords';
+import type { RemoveWordsIfNoResults } from './removeWordsIfNoResults';
+import type { RenderingContent } from './renderingContent';
+import type { SemanticSearch } from './semanticSearch';
+import type { TypoTolerance } from './typoTolerance';
+export type IndexSettingsAsSearchParams = {
+    /**
+     * Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/) and the [modifiers](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/#modifiers) that can be applied: `filterOnly`, `searchable`, and `afterDistinct`.
+     */
+    attributesForFaceting?: string[];
+    /**
+     * Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. By default, the response includes all attributes.
+     */
+    attributesToRetrieve?: string[];
+    /**
+     * Determines the order in which Algolia [returns your results](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/).
+     */
+    ranking?: string[];
+    /**
+     * Specifies the [Custom ranking criterion](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Use the `asc` and `desc` modifiers to specify the ranking order: ascending or descending.
+     */
+    customRanking?: string[];
+    /**
+     * Relevancy threshold below which less relevant results aren\'t included in the results.
+     */
+    relevancyStrictness?: number;
+    /**
+     * Attributes to highlight. Strings that match the search query in the attributes are highlighted by surrounding them with HTML tags (`highlightPreTag` and `highlightPostTag`).
+     */
+    attributesToHighlight?: string[];
+    /**
+     * Attributes to _snippet_. \'Snippeting\' is shortening the attribute to a certain number of words. If not specified, the attribute is shortened to the 10 words around the matching string but you can specify the number. For example: `body:20`.
+     */
+    attributesToSnippet?: string[];
+    /**
+     * HTML string to insert before the highlighted parts in all highlight and snippet results.
+     */
+    highlightPreTag?: string;
+    /**
+     * HTML string to insert after the highlighted parts in all highlight and snippet results.
+     */
+    highlightPostTag?: string;
+    /**
+     * String used as an ellipsis indicator when a snippet is truncated.
+     */
+    snippetEllipsisText?: string;
+    /**
+     * Restrict highlighting and snippeting to items that matched the query.
+     */
+    restrictHighlightAndSnippetArrays?: boolean;
+    /**
+     * Number of hits per page.
+     */
+    hitsPerPage?: number;
+    /**
+     * Minimum number of characters a word in the query string must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
+     */
+    minWordSizefor1Typo?: number;
+    /**
+     * Minimum number of characters a word in the query string must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
+     */
+    minWordSizefor2Typos?: number;
+    typoTolerance?: TypoTolerance;
+    /**
+     * Whether to allow typos on numbers (\"numeric tokens\") in the query string.
+     */
+    allowTyposOnNumericTokens?: boolean;
+    /**
+     * Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).
+     */
+    disableTypoToleranceOnAttributes?: string[];
+    ignorePlurals?: IgnorePlurals;
+    removeStopWords?: RemoveStopWords;
+    /**
+     * Characters that the engine shouldn\'t automatically [normalize](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
+     */
+    keepDiacriticsOnCharacters?: string;
+    /**
+     * Sets your user\'s search language. This adjusts language-specific settings and features such as `ignorePlurals`, `removeStopWords`, and [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) word detection.
+     */
+    queryLanguages?: string[];
+    /**
+     * [Splits compound words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words) into their component word parts in the query.
+     */
+    decompoundQuery?: boolean;
+    /**
+     * Incidates whether [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/) are enabled.
+     */
+    enableRules?: boolean;
+    /**
+     * Incidates whether [Personalization](https://www.algolia.com/doc/guides/personalization/what-is-personalization/) is enabled.
+     */
+    enablePersonalization?: boolean;
+    queryType?: QueryType;
+    removeWordsIfNoResults?: RemoveWordsIfNoResults;
+    mode?: Mode;
+    semanticSearch?: SemanticSearch;
+    /**
+     * Enables the [advanced query syntax](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#advanced-syntax).
+     */
+    advancedSyntax?: boolean;
+    /**
+     * Words which should be considered [optional](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words) when found in a query.
+     */
+    optionalWords?: string[];
+    /**
+     * Attributes for which you want to [turn off the exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes).
+     */
+    disableExactOnAttributes?: string[];
+    exactOnSingleWordQuery?: ExactOnSingleWordQuery;
+    /**
+     * Alternatives that should be considered an exact match by [the exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes).
+     */
+    alternativesAsExact?: AlternativesAsExact[];
+    /**
+     * Allows you to specify which advanced syntax features are active when `advancedSyntax` is enabled.
+     */
+    advancedSyntaxFeatures?: AdvancedSyntaxFeatures[];
+    distinct?: Distinct;
+    /**
+     * Name of the deduplication attribute to be used with Algolia\'s [_distinct_ feature](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).
+     */
+    attributeForDistinct?: string;
+    /**
+     * Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
+     */
+    replaceSynonymsInHighlight?: boolean;
+    /**
+     * Precision of the [proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity).
+     */
+    minProximity?: number;
+    /**
+     * Attributes to include in the API response for search and browse queries.
+     */
+    responseFields?: string[];
+    /**
+     * Maximum number of facet hits to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+     */
+    maxFacetHits?: number;
+    /**
+     * Maximum number of facet values to return for each facet.
+     */
+    maxValuesPerFacet?: number;
+    /**
+     * Controls how facet values are fetched.
+     */
+    sortFacetValuesBy?: string;
+    /**
+     * When the [Attribute criterion is ranked above Proximity](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute-and-proximity-combinations) in your ranking formula, Proximity is used to select which searchable attribute is matched in the Attribute ranking stage.
+     */
+    attributeCriteriaComputedByMinProximity?: boolean;
+    renderingContent?: RenderingContent;
+    /**
+     * Indicates whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).
+     */
+    enableReRanking?: boolean;
+    reRankingApplyFilter?: ReRankingApplyFilter | null;
+};
 //# sourceMappingURL=indexSettingsAsSearchParams.d.ts.map

package/dist/model/indexSettingsAsSearchParams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"indexSettingsAsSearchParams.d.ts","sourceRoot":"","sources":["../../model/indexSettingsAsSearchParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,oBAAY,2BAA2B,GAAG;IACxC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;OAEG;IACH,4BAA4B,CAAC,EAAE,MAAM,EAAE,CAAC;IAExC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,iCAAiC,CAAC,EAAE,OAAO,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,gCAAgC,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5C,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAEhD;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpC,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAEhD;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAE5C;;OAEG;IACH,sBAAsB,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAElD,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,uCAAuC,CAAC,EAAE,OAAO,CAAC;IAElD,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAC"}
+{"version":3,"file":"indexSettingsAsSearchParams.d.ts","sourceRoot":"","sources":["../../model/indexSettingsAsSearchParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,iCAAiC,CAAC,EAAE,OAAO,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,gCAAgC,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5C,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAEhD,IAAI,CAAC,EAAE,IAAI,CAAC;IAEZ,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpC,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAEhD;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAE5C;;OAEG;IACH,sBAAsB,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAElD,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,uCAAuC,CAAC,EAAE,OAAO,CAAC;IAElD,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,oBAAoB,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;CACpD,CAAC"}

package/dist/model/matchLevel.d.ts

@@ -1,5 +1,5 @@
-/**
- * Indicates how well the attribute matched the search query.
- */
-export declare type MatchLevel = 'full' | 'none' | 'partial';
+/**
+ * Indicates how well the attribute matched the search query.
+ */
+export type MatchLevel = 'full' | 'none' | 'partial';
 //# sourceMappingURL=matchLevel.d.ts.map

package/dist/model/matchLevel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"matchLevel.d.ts","sourceRoot":"","sources":["../../model/matchLevel.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC"}
+{"version":3,"file":"matchLevel.d.ts","sourceRoot":"","sources":["../../model/matchLevel.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC"}

package/dist/model/matchedGeoLocation.d.ts

@@ -1,15 +1,15 @@
-export declare type MatchedGeoLocation = {
-    /**
-     * Latitude of the matched location.
-     */
-    lat?: number;
-    /**
-     * Longitude of the matched location.
-     */
-    lng?: number;
-    /**
-     * Distance between the matched location and the search location (in meters).
-     */
-    distance?: number;
-};
+export type MatchedGeoLocation = {
+    /**
+     * Latitude of the matched location.
+     */
+    lat?: number;
+    /**
+     * Longitude of the matched location.
+     */
+    lng?: number;
+    /**
+     * Distance between the matched location and the search location (in meters).
+     */
+    distance?: number;
+};
 //# sourceMappingURL=matchedGeoLocation.d.ts.map

package/dist/model/matchedGeoLocation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"matchedGeoLocation.d.ts","sourceRoot":"","sources":["../../model/matchedGeoLocation.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"matchedGeoLocation.d.ts","sourceRoot":"","sources":["../../model/matchedGeoLocation.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/mixedSearchFilters.d.ts

@@ -1,2 +1,2 @@
-export declare type MixedSearchFilters = string[] | string;
+export type MixedSearchFilters = string[] | string;
 //# sourceMappingURL=mixedSearchFilters.d.ts.map

package/dist/model/mixedSearchFilters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mixedSearchFilters.d.ts","sourceRoot":"","sources":["../../model/mixedSearchFilters.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC"}
+{"version":3,"file":"mixedSearchFilters.d.ts","sourceRoot":"","sources":["../../model/mixedSearchFilters.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC"}

package/dist/model/mode.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Search mode the index will use to query for results.
+ */
+export type Mode = 'keywordSearch' | 'neuralSearch';
+//# sourceMappingURL=mode.d.ts.map

package/dist/model/mode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mode.d.ts","sourceRoot":"","sources":["../../model/mode.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,eAAe,GAAG,cAAc,CAAC"}

package/dist/model/numericFilters.d.ts

@@ -1,6 +1,6 @@
-import type { MixedSearchFilters } from './mixedSearchFilters';
-/**
- * Filter on numeric attributes.
- */
-export declare type NumericFilters = MixedSearchFilters[] | string;
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * [Filter on numeric attributes](https://www.algolia.com/doc/api-reference/api-parameters/numericFilters/).
+ */
+export type NumericFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=numericFilters.d.ts.map

package/dist/model/numericFilters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"numericFilters.d.ts","sourceRoot":"","sources":["../../model/numericFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,oBAAY,cAAc,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}
+{"version":3,"file":"numericFilters.d.ts","sourceRoot":"","sources":["../../model/numericFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}

package/dist/model/optionalFilters.d.ts

@@ -1,6 +1,6 @@
-import type { MixedSearchFilters } from './mixedSearchFilters';
-/**
- * Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter.
- */
-export declare type OptionalFilters = MixedSearchFilters[] | string;
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * Create filters to boost or demote records.   Records that match the filter are ranked higher for positive and lower for negative optional filters. In contrast to regular filters, records that don\'t match the optional filter are still included in the results, only their ranking is affected.
+ */
+export type OptionalFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=optionalFilters.d.ts.map

package/dist/model/optionalFilters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"optionalFilters.d.ts","sourceRoot":"","sources":["../../model/optionalFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,oBAAY,eAAe,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}
+{"version":3,"file":"optionalFilters.d.ts","sourceRoot":"","sources":["../../model/optionalFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}

package/dist/model/params.d.ts

@@ -0,0 +1,13 @@
+import type { AutomaticFacetFilters } from './automaticFacetFilters';
+import type { ConsequenceQuery } from './consequenceQuery';
+import type { RenderingContent } from './renderingContent';
+/**
+ * Additional search parameters.
+ */
+export type Params = {
+    query?: ConsequenceQuery;
+    automaticFacetFilters?: AutomaticFacetFilters;
+    automaticOptionalFacetFilters?: AutomaticFacetFilters;
+    renderingContent?: RenderingContent;
+};
+//# sourceMappingURL=params.d.ts.map

package/dist/model/params.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"params.d.ts","sourceRoot":"","sources":["../../model/params.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,KAAK,CAAC,EAAE,gBAAgB,CAAC;IAEzB,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAE9C,6BAA6B,CAAC,EAAE,qBAAqB,CAAC;IAEtD,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAC"}

package/dist/model/personalization.d.ts

@@ -1,15 +1,15 @@
-export declare type Personalization = {
-    /**
-     * The score of the filters.
-     */
-    filtersScore?: number;
-    /**
-     * The score of the ranking.
-     */
-    rankingScore?: number;
-    /**
-     * The score of the event.
-     */
-    score?: number;
-};
+export type Personalization = {
+    /**
+     * The score of the filters.
+     */
+    filtersScore?: number;
+    /**
+     * The score of the ranking.
+     */
+    rankingScore?: number;
+    /**
+     * The score of the event.
+     */
+    score?: number;
+};
 //# sourceMappingURL=personalization.d.ts.map

package/dist/model/personalization.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"personalization.d.ts","sourceRoot":"","sources":["../../model/personalization.ts"],"names":[],"mappings":"AAEA,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"personalization.d.ts","sourceRoot":"","sources":["../../model/personalization.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/model/promote.d.ts

@@ -0,0 +1,4 @@
+import type { PromoteObjectID } from './promoteObjectID';
+import type { PromoteObjectIDs } from './promoteObjectIDs';
+export type Promote = PromoteObjectID | PromoteObjectIDs;
+//# sourceMappingURL=promote.d.ts.map

package/dist/model/promote.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promote.d.ts","sourceRoot":"","sources":["../../model/promote.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,MAAM,OAAO,GAAG,eAAe,GAAG,gBAAgB,CAAC"}

package/dist/model/promoteObjectID.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Record to promote.
+ */
+export type PromoteObjectID = {
+    /**
+     * Unique identifier of the record to promote.
+     */
+    objectID: string;
+    /**
+     * The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions.
+     */
+    position: number;
+};
+//# sourceMappingURL=promoteObjectID.d.ts.map

package/dist/model/promoteObjectID.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promoteObjectID.d.ts","sourceRoot":"","sources":["../../model/promoteObjectID.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/model/promoteObjectIDs.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Records to promote.
+ */
+export type PromoteObjectIDs = {
+    /**
+     * Unique identifiers of the records to promote.
+     */
+    objectIDs: string[];
+    /**
+     * The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions.
+     */
+    position: number;
+};
+//# sourceMappingURL=promoteObjectIDs.d.ts.map

package/dist/model/promoteObjectIDs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promoteObjectIDs.d.ts","sourceRoot":"","sources":["../../model/promoteObjectIDs.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/model/queryType.d.ts

@@ -1,5 +1,5 @@
-/**
- * Controls if and how query words are interpreted as prefixes.
- */
-export declare type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
+/**
+ * Determines how query words are [interpreted as prefixes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
+ */
+export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
 //# sourceMappingURL=queryType.d.ts.map

package/dist/model/queryType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryType.d.ts","sourceRoot":"","sources":["../../model/queryType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,SAAS,GAAG,WAAW,GAAG,YAAY,GAAG,YAAY,CAAC"}
+{"version":3,"file":"queryType.d.ts","sourceRoot":"","sources":["../../model/queryType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,WAAW,GAAG,YAAY,GAAG,YAAY,CAAC"}