@algolia/recommend 5.0.0-alpha.52 → 5.0.0-alpha.54

package/dist/model/indexSettingsAsSearchParams.d.ts

@@ -1,157 +1,157 @@
-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 type IndexSettingsAsSearchParams = {
-    /**
-     * The complete list of attributes that will be used for faceting.
-     */
-    attributesForFaceting?: 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 { QueryType } from './queryType';
+import type { RemoveStopWords } from './removeStopWords';
+import type { RemoveWordsIfNoResults } from './removeWordsIfNoResults';
+import type { RenderingContent } from './renderingContent';
+import type { TypoTolerance } from './typoTolerance';
+export type IndexSettingsAsSearchParams = {
+    /**
+     * The complete list of attributes that will be used for faceting.
+     */
+    attributesForFaceting?: 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;
+};
 //# sourceMappingURL=indexSettingsAsSearchParams.d.ts.map

package/dist/model/matchLevel.d.ts

@@ -1,5 +1,5 @@
-/**
- * Indicates how well the attribute matched the search query.
- */
-export 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/matchedGeoLocation.d.ts

@@ -1,15 +1,15 @@
-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;
-};
+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/mixedSearchFilters.d.ts

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

package/dist/model/numericFilters.d.ts

@@ -1,6 +1,6 @@
-import type { MixedSearchFilters } from './mixedSearchFilters';
-/**
- * Filter on numeric attributes.
- */
-export type NumericFilters = MixedSearchFilters[] | string;
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * Filter on numeric attributes.
+ */
+export type NumericFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=numericFilters.d.ts.map

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 type OptionalFilters = MixedSearchFilters[] | string;
+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 type OptionalFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=optionalFilters.d.ts.map

package/dist/model/personalization.d.ts

@@ -1,15 +1,15 @@
-export 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/queryType.d.ts

@@ -1,5 +1,5 @@
-/**
- * Controls if and how query words are interpreted as prefixes.
- */
-export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
+/**
+ * Controls if and how query words are interpreted as prefixes.
+ */
+export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
 //# sourceMappingURL=queryType.d.ts.map

package/dist/model/rankingInfo.d.ts

@@ -1,51 +1,51 @@
-import type { MatchedGeoLocation } from './matchedGeoLocation';
-import type { Personalization } from './personalization';
-export type RankingInfo = {
-    /**
-     * This field is reserved for advanced usage.
-     */
-    filters: number;
-    /**
-     * Position of the most important matched attribute in the attributes to index list.
-     */
-    firstMatchedWord: number;
-    /**
-     * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
-     */
-    geoDistance: number;
-    /**
-     * Precision used when computing the geo distance, in meters.
-     */
-    geoPrecision?: number;
-    matchedGeoLocation?: MatchedGeoLocation;
-    personalization?: Personalization;
-    /**
-     * Number of exactly matched words.
-     */
-    nbExactWords: number;
-    /**
-     * Number of typos encountered when matching the record.
-     */
-    nbTypos: number;
-    /**
-     * Present and set to true if a Rule promoted the hit.
-     */
-    promoted: boolean;
-    /**
-     * When the query contains more than one word, the sum of the distances between matched words (in meters).
-     */
-    proximityDistance?: number;
-    /**
-     * Custom ranking for the object, expressed as a single integer value.
-     */
-    userScore: number;
-    /**
-     * Number of matched words, including prefixes and typos.
-     */
-    words: number;
-    /**
-     * Wether the record are promoted by the re-ranking strategy.
-     */
-    promotedByReRanking?: boolean;
-};
+import type { MatchedGeoLocation } from './matchedGeoLocation';
+import type { Personalization } from './personalization';
+export type RankingInfo = {
+    /**
+     * This field is reserved for advanced usage.
+     */
+    filters: number;
+    /**
+     * Position of the most important matched attribute in the attributes to index list.
+     */
+    firstMatchedWord: number;
+    /**
+     * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
+     */
+    geoDistance: number;
+    /**
+     * Precision used when computing the geo distance, in meters.
+     */
+    geoPrecision?: number;
+    matchedGeoLocation?: MatchedGeoLocation;
+    personalization?: Personalization;
+    /**
+     * Number of exactly matched words.
+     */
+    nbExactWords: number;
+    /**
+     * Number of typos encountered when matching the record.
+     */
+    nbTypos: number;
+    /**
+     * Present and set to true if a Rule promoted the hit.
+     */
+    promoted: boolean;
+    /**
+     * When the query contains more than one word, the sum of the distances between matched words (in meters).
+     */
+    proximityDistance?: number;
+    /**
+     * Custom ranking for the object, expressed as a single integer value.
+     */
+    userScore: number;
+    /**
+     * Number of matched words, including prefixes and typos.
+     */
+    words: number;
+    /**
+     * Wether the record are promoted by the re-ranking strategy.
+     */
+    promotedByReRanking?: boolean;
+};
 //# sourceMappingURL=rankingInfo.d.ts.map

package/dist/model/reRankingApplyFilter.d.ts

@@ -1,6 +1,6 @@
-import type { MixedSearchFilters } from './mixedSearchFilters';
-/**
- * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
- */
-export type ReRankingApplyFilter = MixedSearchFilters[] | string;
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
+ */
+export type ReRankingApplyFilter = MixedSearchFilters[] | string;
 //# sourceMappingURL=reRankingApplyFilter.d.ts.map

package/dist/model/recommendHit.d.ts

@@ -1,27 +1,27 @@
-import type { HighlightResult } from './highlightResult';
-import type { RankingInfo } from './rankingInfo';
-import type { SnippetResult } from './snippetResult';
-/**
- * A Recommend hit.
- */
-export type RecommendHit = Record<string, any> & {
-    /**
-     * Unique identifier of the object.
-     */
-    objectID: string;
-    /**
-     * Show highlighted section and words matched on a query.
-     */
-    _highlightResult?: Record<string, HighlightResult>;
-    /**
-     * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
-     */
-    _snippetResult?: Record<string, SnippetResult>;
-    _rankingInfo?: RankingInfo;
-    _distinctSeqID?: number;
-    /**
-     * The recommendation score.
-     */
-    _score: number;
-};
+import type { HighlightResult } from './highlightResult';
+import type { RankingInfo } from './rankingInfo';
+import type { SnippetResult } from './snippetResult';
+/**
+ * A Recommend hit.
+ */
+export type RecommendHit = Record<string, any> & {
+    /**
+     * Unique identifier of the object.
+     */
+    objectID: string;
+    /**
+     * Show highlighted section and words matched on a query.
+     */
+    _highlightResult?: Record<string, HighlightResult>;
+    /**
+     * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+     */
+    _snippetResult?: Record<string, SnippetResult>;
+    _rankingInfo?: RankingInfo;
+    _distinctSeqID?: number;
+    /**
+     * The recommendation score.
+     */
+    _score: number;
+};
 //# sourceMappingURL=recommendHit.d.ts.map

package/dist/model/recommendHits.d.ts

@@ -1,5 +1,5 @@
-import type { RecommendHit } from './recommendHit';
-export type RecommendHits = {
-    hits: RecommendHit[];
-};
+import type { RecommendHit } from './recommendHit';
+export type RecommendHits = {
+    hits: RecommendHit[];
+};
 //# sourceMappingURL=recommendHits.d.ts.map

package/dist/model/recommendationModels.d.ts

@@ -1,5 +1,5 @@
-/**
- * The recommendation model to use.
- */
-export type RecommendationModels = 'bought-together' | 'related-products';
+/**
+ * The recommendation model to use.
+ */
+export type RecommendationModels = 'bought-together' | 'related-products';
 //# sourceMappingURL=recommendationModels.d.ts.map

package/dist/model/recommendationRequest.d.ts

@@ -1,4 +1,4 @@
-import type { BaseRecommendRequest } from './baseRecommendRequest';
-import type { BaseRecommendationRequest } from './baseRecommendationRequest';
-export type RecommendationRequest = BaseRecommendationRequest & BaseRecommendRequest;
+import type { BaseRecommendRequest } from './baseRecommendRequest';
+import type { BaseRecommendationRequest } from './baseRecommendationRequest';
+export type RecommendationRequest = BaseRecommendationRequest & BaseRecommendRequest;
 //# sourceMappingURL=recommendationRequest.d.ts.map

package/dist/model/recommendationsRequest.d.ts

@@ -1,4 +1,4 @@
-import type { RecommendationRequest } from './recommendationRequest';
-import type { TrendingRequest } from './trendingRequest';
-export type RecommendationsRequest = RecommendationRequest | TrendingRequest;
+import type { RecommendationRequest } from './recommendationRequest';
+import type { TrendingRequest } from './trendingRequest';
+export type RecommendationsRequest = RecommendationRequest | TrendingRequest;
 //# sourceMappingURL=recommendationsRequest.d.ts.map

package/dist/model/recommendationsResponse.d.ts

@@ -1,4 +1,4 @@
-import type { BaseSearchResponse } from './baseSearchResponse';
-import type { RecommendHits } from './recommendHits';
-export type RecommendationsResponse = BaseSearchResponse & RecommendHits;
+import type { BaseSearchResponse } from './baseSearchResponse';
+import type { RecommendHits } from './recommendHits';
+export type RecommendationsResponse = BaseSearchResponse & RecommendHits;
 //# sourceMappingURL=recommendationsResponse.d.ts.map