@algolia/recommend 5.0.0-alpha.1 → 5.0.0-alpha.100

package/model/matchedGeoLocation.ts

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

package/model/mixedSearchFilters.ts

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

package/model/mode.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.
+
+/**
+ * Search mode the index will use to query for results.
+ */
+export type Mode = 'keywordSearch' | 'neuralSearch';

package/model/numericFilters.ts

@@ -1,8 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { MixedSearchFilters } from './mixedSearchFilters';
 
 /**
- * Filter on numeric attributes.
+ * [Filter on numeric attributes](https://www.algolia.com/doc/api-reference/api-parameters/numericFilters/).
  */
 export type NumericFilters = MixedSearchFilters[] | string;

package/model/optionalFilters.ts

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

package/model/params.ts

@@ -0,0 +1,18 @@
+// 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 { 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;
+};

package/model/personalization.ts

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

package/model/promote.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.
+
+import type { PromoteObjectID } from './promoteObjectID';
+import type { PromoteObjectIDs } from './promoteObjectIDs';
+
+export type Promote = PromoteObjectID | PromoteObjectIDs;

package/model/promoteObjectID.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.
+
+/**
+ * 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;
+};

package/model/promoteObjectIDs.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.
+
+/**
+ * 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;
+};

package/model/queryType.ts

@@ -1,6 +1,6 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 if and how query words are interpreted as prefixes.
+ * 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';

package/model/rankingInfo.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { MatchedGeoLocation } from './matchedGeoLocation';
 import type { Personalization } from './personalization';
@@ -8,44 +8,56 @@ 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.
    */

package/model/reRankingApplyFilter.ts

@@ -1,8 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { MixedSearchFilters } from './mixedSearchFilters';
 
 /**
- * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
+ * When [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) is enabled, only records that match these filters will be affected by Dynamic Re-Ranking.
  */
 export type ReRankingApplyFilter = MixedSearchFilters[] | string;

package/model/recommendHit.ts

@@ -1,29 +1,34 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { HighlightResult } from './highlightResult';
 import type { RankingInfo } from './rankingInfo';
 import type { SnippetResult } from './snippetResult';
 
 /**
- * A Recommend hit.
+ * Recommend hit.
  */
 export type RecommendHit = Record<string, any> & {
   /**
-   * Unique identifier of the object.
+   * Unique object identifier.
    */
   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.
+   * Recommendation score.
    */
   _score: number;
 };

package/model/recommendModels.ts

@@ -0,0 +1,7 @@
+// 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.
+
+export type RecommendModels =
+  | 'bought-together'
+  | 'related-products'
+  | 'trending-facets'
+  | 'trending-items';

package/model/recommendationModels.ts

@@ -1,6 +1,6 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 /**
- * The recommendation model to use.
+ * Recommendation model.
  */
 export type RecommendationModels = 'bought-together' | 'related-products';

package/model/recommendationsHit.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.
+
+import type { RecommendHit } from './recommendHit';
+import type { TrendingFacetHit } from './trendingFacetHit';
+
+export type RecommendationsHit = RecommendHit | TrendingFacetHit;

package/model/recommendationsHits.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 { RecommendationsHit } from './recommendationsHit';
+
+export type RecommendationsHits = {
+  hits: RecommendationsHit[];
+
+  /**
+   * Text to search for in an index.
+   */
+  query?: string;
+
+  /**
+   * URL-encoded string of all search parameters.
+   */
+  params?: string;
+};

package/model/recommendationsQuery.ts

@@ -0,0 +1,7 @@
+// 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 { BaseRecommendRequest } from './baseRecommendRequest';
+import type { BaseRecommendationsQuery } from './baseRecommendationsQuery';
+
+export type RecommendationsQuery = BaseRecommendationsQuery &
+  BaseRecommendRequest;

package/model/recommendationsRequest.ts

@@ -1,6 +1,12 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { RecommendationRequest } from './recommendationRequest';
-import type { TrendingRequest } from './trendingRequest';
+import type { RecommendationsQuery } from './recommendationsQuery';
+import type { RecommendedForYouQuery } from './recommendedForYouQuery';
+import type { TrendingFacetsQuery } from './trendingFacetsQuery';
+import type { TrendingItemsQuery } from './trendingItemsQuery';
 
-export type RecommendationsRequest = RecommendationRequest | TrendingRequest;
+export type RecommendationsRequest =
+  | RecommendationsQuery
+  | RecommendedForYouQuery
+  | TrendingFacetsQuery
+  | TrendingItemsQuery;

package/model/recommendationsResults.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.
+
+import type { BaseSearchResponse } from './baseSearchResponse';
+import type { RecommendationsHits } from './recommendationsHits';
+
+export type RecommendationsResults = BaseSearchResponse & RecommendationsHits;

package/model/recommendedForYouModel.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.
+
+/**
+ * Recommended for you model.
+ */
+export type RecommendedForYouModel = 'recommended-for-you';

package/model/recommendedForYouQuery.ts

@@ -0,0 +1,7 @@
+// 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 { BaseRecommendRequest } from './baseRecommendRequest';
+import type { BaseRecommendedForYouQuery } from './baseRecommendedForYouQuery';
+
+export type RecommendedForYouQuery = BaseRecommendedForYouQuery &
+  BaseRecommendRequest;

package/model/recommendedForYouQueryParameters.ts

@@ -0,0 +1,7 @@
+// 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 { BaseRecommendedForYouQueryParameters } from './baseRecommendedForYouQueryParameters';
+import type { SearchParamsObject } from './searchParamsObject';
+
+export type RecommendedForYouQueryParameters =
+  BaseRecommendedForYouQueryParameters & SearchParamsObject;

package/model/redirect.ts

@@ -0,0 +1,10 @@
+// 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 { RedirectRuleIndexMetadata } from './redirectRuleIndexMetadata';
+
+/**
+ * [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/).
+ */
+export type Redirect = {
+  index?: RedirectRuleIndexMetadata[];
+};

package/model/redirectRuleIndexMetadata.ts

@@ -0,0 +1,27 @@
+// 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 { RedirectRuleIndexMetadataData } from './redirectRuleIndexMetadataData';
+
+export type RedirectRuleIndexMetadata = {
+  /**
+   * Source index for the redirect rule.
+   */
+  source: string;
+
+  /**
+   * Destination index for the redirect rule.
+   */
+  dest: string;
+
+  /**
+   * Reason for the redirect rule.
+   */
+  reason: string;
+
+  /**
+   * Redirect rule status.
+   */
+  succeed: boolean;
+
+  data: RedirectRuleIndexMetadataData;
+};

package/model/redirectRuleIndexMetadataData.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.
+
+/**
+ * Redirect rule data.
+ */
+export type RedirectRuleIndexMetadataData = {
+  ruleObjectID: string;
+};

package/model/removeStopWords.ts

@@ -1,6 +1,6 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 /**
- * Removes stop (common) words from the query before executing it. RemoveStopWords 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 stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
+ * Removes stop (common) words from the query before executing it. `removeStopWords` is used in conjunction with the `queryLanguages` setting. _list_: language ISO codes for which stop words should be enabled. This list will override any values that you may have set in `queryLanguages`. _true_: enables the stop words feature, ensuring that stop words are removed from consideration in a search. The languages supported here are either [every language](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) (this is the default) or those set by `queryLanguages`. _false_: turns off the stop words feature, allowing stop words to be taken into account in a search.
  */
 export type RemoveStopWords = string[] | boolean;

package/model/removeWordsIfNoResults.ts

@@ -1,7 +1,7 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 /**
- * Selects a strategy to remove words from the query when it doesn\'t match any hits.
+ * Strategy to [remove words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/) from the query when it doesn\'t match any hits.
  */
 export type RemoveWordsIfNoResults =
   | 'allOptional'

package/model/renderingContent.ts

@@ -1,9 +1,9 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { FacetOrdering } from './facetOrdering';
 
 /**
- * Content defining how the search interface should be rendered. Can be set via the settings for a default value and can be overridden via rules.
+ * Extra content for the search UI, for example, to control the [ordering and display of facets](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/merchandising-facets/#merchandise-facets-and-their-values-in-the-manual-editor). You can set a default value and dynamically override it with [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/).
  */
 export type RenderingContent = {
   facetOrdering?: FacetOrdering;

package/model/ruleResponse.ts

@@ -0,0 +1,34 @@
+// 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 { Condition } from './condition';
+import type { Consequence } from './consequence';
+import type { RuleResponseMetadata } from './ruleResponseMetadata';
+
+/**
+ * Rule object.
+ */
+export type RuleResponse = {
+  _metadata?: RuleResponseMetadata;
+
+  /**
+   * Unique identifier for a rule object.
+   */
+  objectID: string;
+
+  /**
+   * [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions) required to activate a rule. You can use up to 25 conditions per rule.
+   */
+  conditions?: Condition[];
+
+  consequence?: Consequence;
+
+  /**
+   * Description of the rule\'s purpose. This can be helpful for display in the Algolia dashboard.
+   */
+  description?: string;
+
+  /**
+   * Indicates whether to enable the rule. If it isn\'t enabled, it isn\'t applied at query time.
+   */
+  enabled?: boolean;
+};

package/model/ruleResponseMetadata.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.
+
+export type RuleResponseMetadata = {
+  /**
+   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+   */
+  lastUpdate?: string;
+};

package/model/searchParamsObject.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { BaseSearchParams } from './baseSearchParams';
 import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';

package/model/searchParamsQuery.ts

@@ -1,8 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 export type SearchParamsQuery = {
   /**
-   * The text to search in the index.
+   * Text to search for in an index.
    */
   query?: string;
 };

package/model/searchRecommendRulesParams.ts

@@ -0,0 +1,31 @@
+// 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.
+
+/**
+ * Recommend rules search parameters.
+ */
+export type SearchRecommendRulesParams = {
+  /**
+   * Full-text query.
+   */
+  query?: string;
+
+  /**
+   * Restricts responses to the specified [contextual rule](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#creating-contextual-rules).
+   */
+  context?: string;
+
+  /**
+   * Requested page (the first page is page 0).
+   */
+  page?: number;
+
+  /**
+   * Maximum number of hits per page.
+   */
+  hitsPerPage?: number;
+
+  /**
+   * Restricts responses to enabled rules. When absent (default), _all_ rules are retrieved.
+   */
+  enabled?: boolean | null;
+};

package/model/searchRecommendRulesResponse.ts

@@ -0,0 +1,25 @@
+// 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 { RuleResponse } from './ruleResponse';
+
+export type SearchRecommendRulesResponse = {
+  /**
+   * Fetched rules.
+   */
+  hits: RuleResponse[];
+
+  /**
+   * Number of hits the search query matched.
+   */
+  nbHits: number;
+
+  /**
+   * Page to retrieve (the first page is `0`, not `1`).
+   */
+  page: number;
+
+  /**
+   * Number of pages of results for the current query.
+   */
+  nbPages: number;
+};

package/model/semanticSearch.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.
+
+/**
+ * Settings for the semantic search part of NeuralSearch. Only used when `mode` is _neuralSearch_.
+ */
+export type SemanticSearch = {
+  /**
+   * Indices from which to collect click and conversion events. If null, the current index and replica group will be used as the event source.
+   */
+  eventSources?: string[] | null;
+};

package/model/snippetResult.ts

@@ -1,5 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { SnippetResultOption } from './snippetResultOption';
 
-export type SnippetResult = SnippetResultOption | SnippetResultOption[];
+export type SnippetResult =
+  | Record<string, SnippetResultOption>
+  | SnippetResultOption
+  | SnippetResultOption[];

package/model/snippetResultOption.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { MatchLevel } from './matchLevel';
 
@@ -7,8 +7,9 @@ import type { MatchLevel } from './matchLevel';
  */
 export type SnippetResultOption = {
   /**
-   * Markup text with occurrences highlighted.
+   * Markup text with `facetQuery` matches highlighted.
    */
   value: string;
+
   matchLevel: MatchLevel;
 };