algoliasearch 5.0.0-alpha.9 → 5.0.0-alpha.90

package/lite/model/listIndicesResponse.ts

@@ -1,10 +1,10 @@
-// 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 { FetchedIndex } from './fetchedIndex';
 
 export type ListIndicesResponse = {
   /**
-   * List of the fetched indices.
+   * All indices in your Algolia application.
    */
   items: FetchedIndex[];
 

package/lite/model/logType.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 LogType = 'all' | 'build' | 'error' | 'query';

package/lite/model/matchLevel.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.
 
 /**
  * Indicates how well the attribute matched the search query.

package/lite/model/matchedGeoLocation.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.
 
 export type MatchedGeoLocation = {
   /**

package/lite/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/lite/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/lite/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/lite/model/operationType.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.
 
 /**
- * Type of operation to perform (move or copy).
+ * Operation to perform (_move_ or _copy_).
  */
 export type OperationType = 'copy' | 'move';

package/lite/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/lite/model/params.ts

@@ -1,11 +1,11 @@
-// 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 { AutomaticFacetFilters } from './automaticFacetFilters';
 import type { ConsequenceQuery } from './consequenceQuery';
 import type { RenderingContent } from './renderingContent';
 
 /**
- * Additional search parameters. Any valid search parameter is allowed.
+ * Additional search parameters.
  */
 export type Params = {
   query?: ConsequenceQuery;

package/lite/model/personalization.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.
 
 export type Personalization = {
   /**

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

package/lite/model/promoteObjectID.ts

@@ -1,16 +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.
 
 /**
- * Single objectID to promote as hits.
+ * Record to promote.
  */
 export type PromoteObjectID = {
   /**
-   * Unique identifier of the object to promote.
+   * Unique identifier of the record to promote.
    */
   objectID: string;
 
   /**
-   * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
+   * 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/lite/model/promoteObjectIDs.ts

@@ -1,16 +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.
 
 /**
- * Multiple objectIDs to promote as hits.
+ * Records to promote.
  */
 export type PromoteObjectIDs = {
   /**
-   * Array of unique identifiers of the objects to promote.
+   * Unique identifiers of the records to promote.
    */
   objectIDs: string[];
 
   /**
-   * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
+   * 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/lite/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/lite/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';

package/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/model/rule.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 { Condition } from './condition';
 import type { Consequence } from './consequence';
@@ -9,29 +9,29 @@ import type { TimeRange } from './timeRange';
  */
 export type Rule = {
   /**
-   * Unique identifier of the object.
+   * Unique identifier for a rule object.
    */
   objectID: string;
 
   /**
-   * A list of conditions that should apply to activate a Rule. You can use up to 25 conditions per Rule.
+   * [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;
 
   /**
-   * This field is intended for Rule management purposes, in particular to ease searching for Rules and presenting them to human readers. It\'s not interpreted by the API.
+   * Description of the rule\'s purpose. This can be helpful for display in the Algolia dashboard.
    */
   description?: string;
 
   /**
-   * Whether the Rule is enabled. Disabled Rules remain in the index, but aren\'t applied at query time.
+   * Indicates whether to enable the rule. If it isn\'t enabled, it isn\'t applied at query time.
    */
   enabled?: boolean;
 
   /**
-   * By default, Rules are permanently valid. When validity periods are specified, the Rule applies only during those periods; it\'s ignored the rest of the time. The list must not be empty.
+   * If you specify a validity period, the rule _only_ applies only during that period. If specified, the array must not be empty.
    */
   validity?: TimeRange[];
 };

package/lite/model/scopeType.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 ScopeType = 'rules' | 'settings' | 'synonyms';

package/lite/model/searchForFacetValuesResponse.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 { FacetHits } from './facetHits';
+
+export type SearchForFacetValuesResponse = {
+  facetHits: FacetHits[];
+};

package/lite/model/searchForFacets.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 { SearchForFacetsOptions } from './searchForFacetsOptions';
 import type { SearchParams } from './searchParams';

package/lite/model/searchForFacetsOptions.ts

@@ -1,15 +1,15 @@
-// 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 { SearchTypeFacet } from './searchTypeFacet';
 
 export type SearchForFacetsOptions = {
   /**
-   * The `facet` name.
+   * Facet name.
    */
   facet: string;
 
   /**
-   * The Algolia index name.
+   * Algolia index name.
    */
   indexName: string;
 
@@ -19,7 +19,7 @@ export type SearchForFacetsOptions = {
   facetQuery?: 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.
+   * Maximum number of facet hits to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
    */
   maxFacetHits?: number;
 

package/lite/model/searchForHits.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 { SearchForHitsOptions } from './searchForHitsOptions';
 import type { SearchParams } from './searchParams';

package/lite/model/searchForHitsOptions.ts

@@ -1,10 +1,10 @@
-// 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 { SearchTypeDefault } from './searchTypeDefault';
 
 export type SearchForHitsOptions = {
   /**
-   * The Algolia index name.
+   * Algolia index name.
    */
   indexName: string;
 

package/lite/model/searchHits.ts

@@ -1,7 +1,17 @@
-// 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 { Hit } from './hit';
 
-export type SearchHits<T = Record<string, any>> = {
+export type SearchHits<T = Record<string, any>> = Record<string, any> & {
   hits: Array<Hit<T>>;
+
+  /**
+   * Text to search for in an index.
+   */
+  query: T;
+
+  /**
+   * URL-encoded string of all search parameters.
+   */
+  params: T;
 };

package/lite/model/searchMethodParams.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 { SearchQuery } from './searchQuery';
 import type { SearchStrategy } from './searchStrategy';

package/lite/model/searchParams.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 { SearchParamsObject } from './searchParamsObject';
 import type { SearchParamsString } from './searchParamsString';

package/lite/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/lite/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/lite/model/searchParamsString.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 SearchParamsString = {
   /**
-   * Search parameters as URL-encoded query string.
+   * Search parameters as a URL-encoded query string.
    */
   params?: string;
 };

package/lite/model/searchQuery.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 { SearchForFacets } from './searchForFacets';
 import type { SearchForHits } from './searchForHits';

package/lite/model/searchResponse.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 { BaseSearchResponse } from './baseSearchResponse';
 import type { SearchHits } from './searchHits';

package/lite/model/searchResponses.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.
 
-import type { SearchResponse } from './searchResponse';
+import type { SearchResult } from './searchResult';
 
-export type SearchResponses<T = Record<string, any>> = {
-  results: Array<SearchResponse<T>>;
+export type SearchResponses = {
+  results: SearchResult[];
 };

package/lite/model/searchResult.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 { SearchForFacetValuesResponse } from './searchForFacetValuesResponse';
+import type { SearchResponse } from './searchResponse';
+
+export type SearchResult = SearchForFacetValuesResponse | SearchResponse;

package/lite/model/searchStrategy.ts

@@ -1,3 +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.
 
+/**
+ * - `none`: executes all queries. - `stopIfEnoughMatches`: executes queries one by one, stopping further query execution as soon as a query matches at least the `hitsPerPage` number of results.
+ */
 export type SearchStrategy = 'none' | 'stopIfEnoughMatches';

package/lite/model/searchSynonymsResponse.ts

@@ -1,15 +1,15 @@
-// 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 { SynonymHit } from './synonymHit';
 
 export type SearchSynonymsResponse = Record<string, any> & {
   /**
-   * Array of synonym objects.
+   * Synonym objects.
    */
   hits: SynonymHit[];
 
   /**
-   * Number of hits that the search query matched.
+   * Number of hits the search query matched.
    */
   nbHits: number;
 };

package/lite/model/searchTypeDefault.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.
 
 /**
- * Perform a search query with `default`, will search for facet values if `facet` is given.
+ * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
  */
 export type SearchTypeDefault = 'default';

package/lite/model/searchTypeFacet.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.
 
 /**
- * Perform a search query with `default`, will search for facet values if `facet` is given.
+ * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
  */
 export type SearchTypeFacet = 'facet';

package/lite/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/lite/model/snippetResult.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 { SnippetResultOption } from './snippetResultOption';
 

package/lite/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,7 +7,7 @@ import type { MatchLevel } from './matchLevel';
  */
 export type SnippetResultOption = {
   /**
-   * Markup text with occurrences highlighted.
+   * Markup text with `facetQuery` matches highlighted.
    */
   value: string;
 

package/lite/model/sortRemainingBy.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.
 
 /**
- * How to display the remaining items.   - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
+ * How to display the remaining items:    - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
  */
 export type SortRemainingBy = 'alpha' | 'count' | 'hidden';