@algolia/recommend 4.14.1 → 5.0.0-alpha.2

package/model/baseSearchResponse.ts

@@ -0,0 +1,104 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { FacetsStats } from './facetsStats';
+import type { RenderingContent } from './renderingContent';
+
+export type BaseSearchResponse = {
+  /**
+   * If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID.
+   */
+  abTestID?: number;
+  /**
+   * If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used (starting at 1).
+   */
+  abTestVariantID?: number;
+  /**
+   * The computed geo location.
+   */
+  aroundLatLng?: string;
+  /**
+   * The automatically computed radius. For legacy reasons, this parameter is a string and not an integer.
+   */
+  automaticRadius?: string;
+  /**
+   * Whether the facet count is exhaustive or approximate.
+   */
+  exhaustiveFacetsCount?: boolean;
+  /**
+   * Indicate if the nbHits count was exhaustive or approximate.
+   */
+  exhaustiveNbHits: boolean;
+  /**
+   * Indicate if the typo-tolerance search was exhaustive or approximate (only included when typo-tolerance is enabled).
+   */
+  exhaustiveTypo: boolean;
+  /**
+   * A mapping of each facet name to the corresponding facet counts.
+   */
+  facets?: Record<string, Record<string, number>>;
+  /**
+   * Statistics for numerical facets.
+   */
+  facets_stats?: Record<string, FacetsStats>;
+  /**
+   * Set the number of hits per page.
+   */
+  hitsPerPage: number;
+  /**
+   * Index name used for the query.
+   */
+  index?: string;
+  /**
+   * Index name used for the query. In the case of an A/B test, the targeted index isn\'t always the index used by the query.
+   */
+  indexUsed?: string;
+  /**
+   * Used to return warnings about the query.
+   */
+  message?: string;
+  /**
+   * Number of hits that the search query matched.
+   */
+  nbHits: number;
+  /**
+   * Number of pages available for the current query.
+   */
+  nbPages: number;
+  /**
+   * The number of hits selected and sorted by the relevant sort algorithm.
+   */
+  nbSortedHits?: number;
+  /**
+   * Specify the page to retrieve.
+   */
+  page: number;
+  /**
+   * A url-encoded string of all search parameters.
+   */
+  params: string;
+  /**
+   * The query string that will be searched, after normalization.
+   */
+  parsedQuery?: string;
+  /**
+   * Time the server took to process the request, in milliseconds.
+   */
+  processingTimeMS: number;
+  /**
+   * The text to search in the index.
+   */
+  query: string;
+  /**
+   * A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set.
+   */
+  queryAfterRemoval?: string;
+  /**
+   * Actual host name of the server that processed the request.
+   */
+  serverUsed?: string;
+  /**
+   * Lets you store custom data in your indices.
+   */
+  userData?: Record<string, any>;
+  renderingContent?: RenderingContent;
+};

package/model/baseTrendingRequest.ts

@@ -0,0 +1,15 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { TrendingModels } from './trendingModels';
+
+export type BaseTrendingRequest = {
+  model: TrendingModels;
+  /**
+   * The facet name to use for trending models.
+   */
+  facetName?: string;
+  /**
+   * The facet value to use for trending models.
+   */
+  facetValue?: string;
+};

package/model/clientMethodProps.ts

@@ -0,0 +1,65 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Properties for the `del` method.
+ */
+export type DelProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+};
+
+/**
+ * Properties for the `get` method.
+ */
+export type GetProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+};
+
+/**
+ * Properties for the `post` method.
+ */
+export type PostProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * The parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
+};
+
+/**
+ * Properties for the `put` method.
+ */
+export type PutProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * The parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
+};

package/model/errorBase.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Error.
+ */
+export type ErrorBase = Record<string, any> & {
+  message?: string;
+};

package/model/exactOnSingleWordQuery.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Controls how the exact ranking criterion is computed when the query contains only one word.
+ */
+export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';

package/model/facetFilters.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { MixedSearchFilters } from './mixedSearchFilters';
+
+/**
+ * Filter hits by facet value.
+ */
+export type FacetFilters = MixedSearchFilters[] | string;

package/model/facetOrdering.ts

@@ -0,0 +1,15 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { Facets } from './facets';
+import type { Value } from './value';
+
+/**
+ * Defining how facets should be ordered.
+ */
+export type FacetOrdering = {
+  facets?: Facets;
+  /**
+   * The ordering of facet values, within an individual list.
+   */
+  values?: Record<string, Value>;
+};

package/model/facets.ts

@@ -0,0 +1,11 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * The ordering of facets (widgets).
+ */
+export type Facets = {
+  /**
+   * Pinned order of facet lists.
+   */
+  order?: string[];
+};

package/model/facetsStats.ts

@@ -0,0 +1,20 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type FacetsStats = {
+  /**
+   * The minimum value in the result set.
+   */
+  min?: number;
+  /**
+   * The maximum value in the result set.
+   */
+  max?: number;
+  /**
+   * The average facet value in the result set.
+   */
+  avg?: number;
+  /**
+   * The sum of all values in the result set.
+   */
+  sum?: number;
+};

package/model/getRecommendationsParams.ts

@@ -0,0 +1,13 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { RecommendationsRequest } from './recommendationsRequest';
+
+/**
+ * The `getRecommendations` parameters.
+ */
+export type GetRecommendationsParams = {
+  /**
+   * The `getRecommendations` requests.
+   */
+  requests: RecommendationsRequest[];
+};

package/model/getRecommendationsResponse.ts

@@ -0,0 +1,7 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { RecommendationsResponse } from './recommendationsResponse';
+
+export type GetRecommendationsResponse = {
+  results?: RecommendationsResponse[];
+};

package/model/highlightResult.ts

@@ -0,0 +1,5 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { HighlightResultOption } from './highlightResultOption';
+
+export type HighlightResult = HighlightResultOption | HighlightResultOption[];

package/model/highlightResultOption.ts

@@ -0,0 +1,22 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { MatchLevel } from './matchLevel';
+
+/**
+ * Show highlighted section and words matched on a query.
+ */
+export type HighlightResultOption = {
+  /**
+   * Markup text with occurrences highlighted.
+   */
+  value: string;
+  matchLevel: MatchLevel;
+  /**
+   * List of words from the query that matched the object.
+   */
+  matchedWords: string[];
+  /**
+   * Whether the entire attribute value is highlighted.
+   */
+  fullyHighlighted?: boolean;
+};

package/model/ignorePlurals.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Treats singular, plurals, and other forms of declensions as matching terms. IgnorePlurals is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the ignore plurals functionality, where singulars and plurals are considered equivalent (foot = feet). The languages supported here are either every language (this is the default, see list of languages below), or those set by queryLanguages. False: disables ignore plurals, where singulars and plurals are not considered the same for matching purposes (foot will not find feet).
+ */
+export type IgnorePlurals = string[] | boolean;

package/model/index.ts

@@ -0,0 +1,54 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export * from './advancedSyntaxFeatures';
+export * from './alternativesAsExact';
+export * from './aroundRadius';
+export * from './aroundRadiusAll';
+export * from './baseRecommendRequest';
+export * from './baseRecommendationRequest';
+export * from './baseSearchParams';
+export * from './baseSearchParamsWithoutQuery';
+export * from './baseSearchResponse';
+export * from './baseTrendingRequest';
+export * from './errorBase';
+export * from './exactOnSingleWordQuery';
+export * from './facetFilters';
+export * from './facetOrdering';
+export * from './facets';
+export * from './facetsStats';
+export * from './getRecommendationsParams';
+export * from './getRecommendationsResponse';
+export * from './highlightResult';
+export * from './highlightResultOption';
+export * from './ignorePlurals';
+export * from './indexSettingsAsSearchParams';
+export * from './matchLevel';
+export * from './matchedGeoLocation';
+export * from './mixedSearchFilters';
+export * from './numericFilters';
+export * from './optionalFilters';
+export * from './personalization';
+export * from './queryType';
+export * from './rankingInfo';
+export * from './reRankingApplyFilter';
+export * from './recommendHit';
+export * from './recommendHits';
+export * from './recommendationModels';
+export * from './recommendationRequest';
+export * from './recommendationsRequest';
+export * from './recommendationsResponse';
+export * from './removeStopWords';
+export * from './removeWordsIfNoResults';
+export * from './renderingContent';
+export * from './searchParamsObject';
+export * from './searchParamsQuery';
+export * from './snippetResult';
+export * from './snippetResultOption';
+export * from './sortRemainingBy';
+export * from './tagFilters';
+export * from './trendingModels';
+export * from './trendingRequest';
+export * from './typoTolerance';
+export * from './typoToleranceEnum';
+export * from './value';
+export * from './clientMethodProps';

package/model/indexSettingsAsSearchParams.ts

@@ -0,0 +1,161 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { AdvancedSyntaxFeatures } from './advancedSyntaxFeatures';
+import type { AlternativesAsExact } from './alternativesAsExact';
+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[];
+  /**
+   * 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[];
+  /**
+   * Enables de-duplication or grouping of results.
+   */
+  distinct?: number;
+  /**
+   * 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;
+};

package/model/matchLevel.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Indicates how well the attribute matched the search query.
+ */
+export type MatchLevel = 'full' | 'none' | 'partial';

package/model/matchedGeoLocation.ts

@@ -0,0 +1,16 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+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;
+};

package/model/mixedSearchFilters.ts

@@ -0,0 +1,3 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type MixedSearchFilters = string[] | string;

package/model/numericFilters.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { MixedSearchFilters } from './mixedSearchFilters';
+
+/**
+ * Filter on numeric attributes.
+ */
+export type NumericFilters = MixedSearchFilters[] | string;

package/model/optionalFilters.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+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;

package/model/personalization.ts

@@ -0,0 +1,16 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type Personalization = {
+  /**
+   * The score of the filters.
+   */
+  filtersScore?: number;
+  /**
+   * The score of the ranking.
+   */
+  rankingScore?: number;
+  /**
+   * The score of the event.
+   */
+  score?: number;
+};

package/model/queryType.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Controls if and how query words are interpreted as prefixes.
+ */
+export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';

package/model/rankingInfo.ts

@@ -0,0 +1,53 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+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;
+};