@algolia/recommend 5.0.0-alpha.73 → 5.0.0-alpha.75

package/model/baseSearchParamsWithoutQuery.ts

@@ -9,12 +9,12 @@ import type { TagFilters } from './tagFilters';
 
 export type BaseSearchParamsWithoutQuery = {
   /**
-   * Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results.
+   * Overrides the query parameter and performs a more generic search.
    */
   similarQuery?: string;
 
   /**
-   * Filter the query with numeric, facet and/or tag filters.
+   * [Filter](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) the query with numeric, facet, or tag filters.
    */
   filters?: string;
 
@@ -27,22 +27,22 @@ export type BaseSearchParamsWithoutQuery = {
   tagFilters?: TagFilters;
 
   /**
-   * Determines how to calculate the total score for filtering.
+   * Determines how to calculate [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores). If `false`, maximum score is kept. If `true`, score is summed.
    */
   sumOrFiltersScores?: boolean;
 
   /**
-   * Retrieve facets and their facet values.
+   * Returns [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts), their facet values, and the number of matching facet values.
    */
   facets?: string[];
 
   /**
-   * Maximum number of facet values to return for each facet during a regular search.
+   * Maximum number of facet values to return for each facet.
    */
   maxValuesPerFacet?: number;
 
   /**
-   * Force faceting to be applied after de-duplication (via the Distinct setting).
+   * Forces faceting to be applied after [de-duplication](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/) (with the distinct feature). Alternatively, the `afterDistinct` [modifier](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/#modifiers) of `attributesForFaceting` allows for more granular control.
    */
   facetingAfterDistinct?: boolean;
 
@@ -52,89 +52,89 @@ export type BaseSearchParamsWithoutQuery = {
   sortFacetValuesBy?: string;
 
   /**
-   * Specify the page to retrieve.
+   * Page to retrieve (the first page is `0`, not `1`).
    */
   page?: number;
 
   /**
-   * Specify the offset of the first hit to return.
+   * Specifies the offset of the first hit to return. > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length).
    */
   offset?: number;
 
   /**
-   * Set the number of hits to retrieve (used only with offset).
+   * Sets the number of hits to retrieve (for use with `offset`). > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length).
    */
   length?: number;
 
   /**
-   * Search for entries around a central geolocation, enabling a geo search within a circular area.
+   * Search for entries [around a central location](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filter-around-a-central-point), enabling a geographical search within a circular area.
    */
   aroundLatLng?: string;
 
   /**
-   * Search for entries around a given location automatically computed from the requester\'s IP address.
+   * Search for entries around a location. The location is automatically computed from the requester\'s IP address.
    */
   aroundLatLngViaIP?: boolean;
 
   aroundRadius?: AroundRadius;
 
   /**
-   * Precision of geo search (in meters), to add grouping by geo location to the ranking formula.
+   * Precision of a geographical search (in meters), to [group results that are more or less the same distance from a central point](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/in-depth/geo-ranking-precision/).
    */
   aroundPrecision?: number;
 
   /**
-   * Minimum radius (in meters) used for a geo search when aroundRadius is not set.
+   * Minimum radius (in meters) used for a geographical search when `aroundRadius` isn\'t set.
    */
   minimumAroundRadius?: number;
 
   /**
-   * Search inside a rectangular area (in geo coordinates).
+   * Search inside a [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
    */
   insideBoundingBox?: number[];
 
   /**
-   * Search inside a polygon (in geo coordinates).
+   * Search inside a [polygon](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
    */
   insidePolygon?: number[];
 
   /**
-   * This parameter changes the default values of certain parameters and settings that work best for a natural language query, such as ignorePlurals, removeStopWords, removeWordsIfNoResults, analyticsTags and ruleContexts. These parameters and settings work well together when the query is formatted in natural language instead of keywords, for example when your user performs a voice search.
+   * Changes the default values of parameters that work best for a natural language query, such as `ignorePlurals`, `removeStopWords`, `removeWordsIfNoResults`, `analyticsTags`, and `ruleContexts`. These parameters work well together when the query consists of fuller natural language strings instead of keywords, for example when processing voice search queries.
    */
   naturalLanguages?: string[];
 
   /**
-   * Enables contextual rules.
+   * Assigns [rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) to search queries.
    */
   ruleContexts?: string[];
 
   /**
-   * Define the impact of the Personalization feature.
+   * Defines how much [Personalization affects results](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
    */
   personalizationImpact?: number;
 
   /**
-   * Associates a certain user token with the current search.
+   * Associates a [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/) with the current search.
    */
   userToken?: string;
 
   /**
-   * Retrieve detailed ranking information.
+   * Incidates whether the search response includes [detailed ranking information](https://www.algolia.com/doc/guides/building-search-ui/going-further/backend-search/in-depth/understanding-the-api-response/#ranking-information).
    */
   getRankingInfo?: boolean;
 
   /**
-   * Enable the Click Analytics feature.
+   * Indicates whether a query ID parameter is included in the search response. This is required for [tracking click and conversion events](https://www.algolia.com/doc/guides/sending-events/concepts/event-types/#events-related-to-algolia-requests).
    */
   clickAnalytics?: boolean;
 
   /**
-   * Whether the current query will be taken into account in the Analytics.
+   * Indicates whether this query will be included in [analytics](https://www.algolia.com/doc/guides/search-analytics/guides/exclude-queries/).
    */
   analytics?: boolean;
 
   /**
-   * List of tags to apply to the query for analytics purposes.
+   * Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
   analyticsTags?: string[];
 
@@ -144,12 +144,12 @@ export type BaseSearchParamsWithoutQuery = {
   percentileComputation?: boolean;
 
   /**
-   * Whether this search should participate in running AB tests.
+   * Incidates whether this search will be considered in A/B testing.
    */
   enableABTest?: boolean;
 
   /**
-   * Whether this search should use AI Re-Ranking.
+   * Indicates whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).
    */
   enableReRanking?: boolean;
 

package/model/baseSearchResponse.ts

@@ -6,42 +6,42 @@ 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.
+   * A/B test ID. This is only included in the response for indices that are part of an A/B test.
    */
   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).
+   * Variant ID. This is only included in the response for indices that are part of an A/B test.
    */
   abTestVariantID?: number;
 
   /**
-   * The computed geo location.
+   * Computed geographical location.
    */
   aroundLatLng?: string;
 
   /**
-   * The automatically computed radius. For legacy reasons, this parameter is a string and not an integer.
+   * Automatically-computed radius.
    */
   automaticRadius?: string;
 
   /**
-   * Whether the facet count is exhaustive or approximate.
+   * Indicates whether the facet count is exhaustive (exact) or approximate.
    */
   exhaustiveFacetsCount?: boolean;
 
   /**
-   * Indicate if the nbHits count was exhaustive or approximate.
+   * Indicates whether the number of hits `nbHits` is exhaustive (exact) or approximate.
    */
   exhaustiveNbHits: boolean;
 
   /**
-   * Indicate if the typo-tolerance search was exhaustive or approximate (only included when typo-tolerance is enabled).
+   * Indicates whether the search for typos was exhaustive (exact) or approximate.
    */
   exhaustiveTypo?: boolean;
 
   /**
-   * A mapping of each facet name to the corresponding facet counts.
+   * Mapping of each facet name to the corresponding facet counts.
    */
   facets?: Record<string, Record<string, number>>;
 
@@ -51,7 +51,7 @@ export type BaseSearchResponse = {
   facets_stats?: Record<string, FacetsStats>;
 
   /**
-   * Set the number of hits per page.
+   * Number of hits per page.
    */
   hitsPerPage: number;
 
@@ -61,44 +61,44 @@ export type BaseSearchResponse = {
   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.
+   * Index name used for the query. During A/B testing, the targeted index isn\'t always the index used by the query.
    */
   indexUsed?: string;
 
   /**
-   * Used to return warnings about the query.
+   * Warnings about the query.
    */
   message?: string;
 
   /**
-   * Number of hits that the search query matched.
+   * Number of hits the search query matched.
    */
   nbHits: number;
 
   /**
-   * Number of pages available for the current query.
+   * Number of pages of results for the current query.
    */
   nbPages: number;
 
   /**
-   * The number of hits selected and sorted by the relevant sort algorithm.
+   * Number of hits selected and sorted by the relevant sort algorithm.
    */
   nbSortedHits?: number;
 
   /**
-   * Specify the page to retrieve.
+   * Page to retrieve (the first page is `0`, not `1`).
    */
   page: number;
 
   /**
-   * A url-encoded string of all search parameters.
+   * URL-encoded string of all search parameters.
    */
   params: string;
 
   redirect?: BaseSearchResponseRedirect;
 
   /**
-   * The query string that will be searched, after normalization.
+   * Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
    */
   parsedQuery?: string;
 
@@ -108,17 +108,17 @@ export type BaseSearchResponse = {
   processingTimeMS: number;
 
   /**
-   * The text to search in the index.
+   * Text to search for in an 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.
+   * Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
    */
   queryAfterRemoval?: string;
 
   /**
-   * Actual host name of the server that processed the request.
+   * Host name of the server that processed the request.
    */
   serverUsed?: string;
 

package/model/baseSearchResponseRedirect.ts

@@ -3,7 +3,7 @@
 import type { RedirectRuleIndexMetadata } from './redirectRuleIndexMetadata';
 
 /**
- * This parameter is for internal use only.
+ * [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/).
  */
 export type BaseSearchResponseRedirect = {
   index?: RedirectRuleIndexMetadata[];

package/model/baseTrendingRequest.ts

@@ -6,12 +6,12 @@ export type BaseTrendingRequest = {
   model: TrendingModels;
 
   /**
-   * The facet name to use for trending models.
+   * Facet name for trending models.
    */
   facetName?: string;
 
   /**
-   * The facet value to use for trending models.
+   * Facet value for trending models.
    */
   facetValue?: string;
 };

package/model/clientMethodProps.ts

@@ -1,47 +1,104 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
+import type { RecommendModels } from './recommendModels';
+import type { SearchRecommendRulesParams } from './searchRecommendRulesParams';
+
 /**
  * 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 of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
 };
 
+/**
+ * Properties for the `deleteRecommendRule` method.
+ */
+export type DeleteRecommendRuleProps = {
+  /**
+   * Index on which to perform the request.
+   */
+  indexName: string;
+  /**
+   * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+   */
+  model: RecommendModels;
+  /**
+   * Unique record (object) identifier.
+   */
+  objectID: string;
+};
+
 /**
  * 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 of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
 };
 
+/**
+ * Properties for the `getRecommendRule` method.
+ */
+export type GetRecommendRuleProps = {
+  /**
+   * Index on which to perform the request.
+   */
+  indexName: string;
+  /**
+   * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+   */
+  model: RecommendModels;
+  /**
+   * Unique record (object) identifier.
+   */
+  objectID: string;
+};
+
+/**
+ * Properties for the `getRecommendStatus` method.
+ */
+export type GetRecommendStatusProps = {
+  /**
+   * Index on which to perform the request.
+   */
+  indexName: string;
+  /**
+   * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+   */
+  model: RecommendModels;
+  /**
+   * Unique identifier of a task. Numeric value (up to 64bits).
+   */
+  taskID: number;
+};
+
 /**
  * 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 of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
   /**
-   * The parameters to send with the custom request.
+   * Parameters to send with the custom request.
    */
   body?: Record<string, any>;
 };
@@ -51,15 +108,30 @@ export type PostProps = {
  */
 export type PutProps = {
   /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
   /**
-   * The parameters to send with the custom request.
+   * Parameters to send with the custom request.
    */
   body?: Record<string, any>;
 };
+
+/**
+ * Properties for the `searchRecommendRules` method.
+ */
+export type SearchRecommendRulesProps = {
+  /**
+   * Index on which to perform the request.
+   */
+  indexName: string;
+  /**
+   * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+   */
+  model: RecommendModels;
+  searchRecommendRulesParams?: SearchRecommendRulesParams;
+};

package/model/condition.ts

@@ -0,0 +1,22 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { Anchoring } from './anchoring';
+
+export type Condition = {
+  /**
+   * Query pattern syntax.
+   */
+  pattern?: string;
+
+  anchoring?: Anchoring;
+
+  /**
+   * Whether the pattern matches on plurals, synonyms, and typos.
+   */
+  alternatives?: boolean;
+
+  /**
+   * Rule context format: [A-Za-z0-9_-]+).
+   */
+  context?: string;
+};

package/model/consequence.ts

@@ -0,0 +1,32 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { ConsequenceHide } from './consequenceHide';
+import type { ConsequenceParams } from './consequenceParams';
+import type { Promote } from './promote';
+
+/**
+ * [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences) of a rule.
+ */
+export type Consequence = {
+  params?: ConsequenceParams;
+
+  /**
+   * Records to promote.
+   */
+  promote?: Promote[];
+
+  /**
+   * Only use in combination with the `promote` consequence. When `true`, promoted results will be restricted to match the filters of the current search. When `false`, the promoted results will show up regardless of the filters.
+   */
+  filterPromotes?: boolean;
+
+  /**
+   * Records to hide. By default, you can hide up to 50 records per rule.
+   */
+  hide?: ConsequenceHide[];
+
+  /**
+   * Custom JSON object that will be appended to the userData array in the response. This object isn\'t interpreted by the API. It\'s limited to 1kB of minified JSON.
+   */
+  userData?: Record<string, any>;
+};

package/model/consequenceHide.ts

@@ -0,0 +1,11 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+/**
+ * Unique identifier of the record to hide.
+ */
+export type ConsequenceHide = {
+  /**
+   * Unique object identifier.
+   */
+  objectID: string;
+};

package/model/consequenceParams.ts

@@ -0,0 +1,9 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
+import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+import type { Params } from './params';
+
+export type ConsequenceParams = BaseSearchParamsWithoutQuery &
+  IndexSettingsAsSearchParams &
+  Params;

package/model/consequenceQuery.ts

@@ -0,0 +1,8 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { ConsequenceQueryObject } from './consequenceQueryObject';
+
+/**
+ * When providing a string, it replaces the entire query string. When providing an object, it describes incremental edits to be made to the query string (but you can\'t do both).
+ */
+export type ConsequenceQuery = ConsequenceQueryObject | string;

package/model/consequenceQueryObject.ts

@@ -0,0 +1,15 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { Edit } from './edit';
+
+export type ConsequenceQueryObject = {
+  /**
+   * Words to remove.
+   */
+  remove?: string[];
+
+  /**
+   * Edits to apply.
+   */
+  edits?: Edit[];
+};

package/model/deletedAtResponse.ts

@@ -0,0 +1,16 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+/**
+ * Response, taskID, and deletion timestamp.
+ */
+export type DeletedAtResponse = {
+  /**
+   * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the `task` operation and this `taskID`.
+   */
+  taskID: number;
+
+  /**
+   * Timestamp of deletion in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+   */
+  deletedAt: string;
+};

package/model/distinct.ts

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Enables de-duplication or grouping of results.
+ * Enables [deduplication or grouping of results (Algolia\'s _distinct_ feature](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature)).
  */
 export type Distinct = boolean | number;

package/model/edit.ts

@@ -0,0 +1,17 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { EditType } from './editType';
+
+export type Edit = {
+  type?: EditType;
+
+  /**
+   * Text or patterns to remove from the query string.
+   */
+  delete?: string;
+
+  /**
+   * Text that should be inserted in place of the removed text inside the query string.
+   */
+  insert?: string;
+};

package/model/editType.ts

@@ -0,0 +1,6 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+/**
+ * Type of edit.
+ */
+export type EditType = 'remove' | 'replace';

package/model/exactOnSingleWordQuery.ts

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Controls how the exact ranking criterion is computed when the query contains only one word.
+ * Determines how 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) is computed when the query contains only one word.
  */
 export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';

package/model/facetFilters.ts

@@ -3,6 +3,6 @@
 import type { MixedSearchFilters } from './mixedSearchFilters';
 
 /**
- * Filter hits by facet value.
+ * [Filter hits by facet value](https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/).
  */
 export type FacetFilters = MixedSearchFilters[] | string;