@algolia/client-search 5.0.0-alpha.8 → 5.0.0-alpha.81

package/model/index.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 * from './acl';
 export * from './action';
@@ -7,6 +7,8 @@ export * from './advancedSyntaxFeatures';
 export * from './alternativesAsExact';
 export * from './anchoring';
 export * from './apiKey';
+export * from './aroundPrecision';
+export * from './aroundPrecisionFromValueInner';
 export * from './aroundRadius';
 export * from './aroundRadiusAll';
 export * from './assignUserIdParams';
@@ -18,6 +20,7 @@ export * from './baseIndexSettings';
 export * from './baseSearchParams';
 export * from './baseSearchParamsWithoutQuery';
 export * from './baseSearchResponse';
+export * from './baseSearchResponseRedirect';
 export * from './batchAssignUserIdsParams';
 export * from './batchDictionaryEntriesParams';
 export * from './batchDictionaryEntriesRequest';
@@ -39,6 +42,7 @@ export * from './consequenceQueryObject';
 export * from './createdAtResponse';
 export * from './cursor';
 export * from './deleteApiKeyResponse';
+export * from './deleteByParams';
 export * from './deleteSourceResponse';
 export * from './deletedAtResponse';
 export * from './dictionaryAction';
@@ -84,6 +88,7 @@ export * from './logType';
 export * from './matchLevel';
 export * from './matchedGeoLocation';
 export * from './mixedSearchFilters';
+export * from './mode';
 export * from './multipleBatchRequest';
 export * from './multipleBatchResponse';
 export * from './numericFilters';
@@ -98,6 +103,8 @@ export * from './promoteObjectIDs';
 export * from './queryType';
 export * from './rankingInfo';
 export * from './reRankingApplyFilter';
+export * from './redirectRuleIndexMetadata';
+export * from './redirectRuleIndexMetadataData';
 export * from './removeStopWords';
 export * from './removeUserIdResponse';
 export * from './removeWordsIfNoResults';
@@ -123,6 +130,7 @@ export * from './searchParamsString';
 export * from './searchQuery';
 export * from './searchResponse';
 export * from './searchResponses';
+export * from './searchResult';
 export * from './searchRulesParams';
 export * from './searchRulesResponse';
 export * from './searchStrategy';
@@ -132,13 +140,13 @@ export * from './searchTypeDefault';
 export * from './searchTypeFacet';
 export * from './searchUserIdsParams';
 export * from './searchUserIdsResponse';
+export * from './semanticSearch';
 export * from './snippetResult';
 export * from './snippetResultOption';
 export * from './sortRemainingBy';
 export * from './source';
 export * from './standardEntries';
 export * from './synonymHit';
-export * from './synonymHitHighlightResult';
 export * from './synonymType';
 export * from './tagFilters';
 export * from './taskStatus';

package/model/indexSettings.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 { BaseIndexSettings } from './baseIndexSettings';
 import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
 
 /**
- * The Algolia index settings.
+ * Algolia index settings.
  */
 export type IndexSettings = BaseIndexSettings & IndexSettingsAsSearchParams;

package/model/indexSettingsAsSearchParams.ts

@@ -1,69 +1,62 @@
-// 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 { AdvancedSyntaxFeatures } from './advancedSyntaxFeatures';
 import type { AlternativesAsExact } from './alternativesAsExact';
 import type { Distinct } from './distinct';
 import type { ExactOnSingleWordQuery } from './exactOnSingleWordQuery';
 import type { IgnorePlurals } from './ignorePlurals';
+import type { Mode } from './mode';
 import type { QueryType } from './queryType';
+import type { ReRankingApplyFilter } from './reRankingApplyFilter';
 import type { RemoveStopWords } from './removeStopWords';
 import type { RemoveWordsIfNoResults } from './removeWordsIfNoResults';
 import type { RenderingContent } from './renderingContent';
+import type { SemanticSearch } from './semanticSearch';
 import type { TypoTolerance } from './typoTolerance';
 
 export type IndexSettingsAsSearchParams = {
   /**
-   * The complete list of attributes that will be used for faceting.
+   * Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/) and the [modifiers](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/#modifiers) that can be applied: `filterOnly`, `searchable`, and `afterDistinct`.
    */
   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.
+   * Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. By default, the response includes all attributes.
    */
   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.
+   * Determines the order in which Algolia [returns your results](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/).
    */
   ranking?: string[];
 
   /**
-   * Specifies the custom ranking criterion.
+   * Specifies the [Custom ranking criterion](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Use the `asc` and `desc` modifiers to specify the ranking order: ascending or descending.
    */
   customRanking?: string[];
 
   /**
-   * Controls the relevancy threshold below which less relevant results aren\'t included in the results.
+   * Relevancy threshold below which less relevant results aren\'t included in the results.
    */
   relevancyStrictness?: number;
 
   /**
-   * List of attributes to highlight.
+   * Attributes to highlight. Strings that match the search query in the attributes are highlighted by surrounding them with HTML tags (`highlightPreTag` and `highlightPostTag`).
    */
   attributesToHighlight?: string[];
 
   /**
-   * List of attributes to snippet, with an optional maximum number of words to snippet.
+   * Attributes to _snippet_. \'Snippeting\' is shortening the attribute to a certain number of words. If not specified, the attribute is shortened to the 10 words around the matching string but you can specify the number. For example: `body:20`.
    */
   attributesToSnippet?: string[];
 
   /**
-   * The HTML string to insert before the highlighted parts in all highlight and snippet results.
+   * 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.
+   * HTML string to insert after the highlighted parts in all highlight and snippet results.
    */
   highlightPostTag?: string;
 
@@ -78,17 +71,17 @@ export type IndexSettingsAsSearchParams = {
   restrictHighlightAndSnippetArrays?: boolean;
 
   /**
-   * Set the number of hits per page.
+   * 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.
+   * Minimum number of characters a word in the query string must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
    */
   minWordSizefor1Typo?: number;
 
   /**
-   * Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
+   * Minimum number of characters a word in the query string must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
    */
   minWordSizefor2Typos?: number;
 
@@ -100,7 +93,7 @@ export type IndexSettingsAsSearchParams = {
   allowTyposOnNumericTokens?: boolean;
 
   /**
-   * List of attributes on which you want to disable typo tolerance.
+   * Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).
    */
   disableTypoToleranceOnAttributes?: string[];
 
@@ -109,27 +102,27 @@ export type IndexSettingsAsSearchParams = {
   removeStopWords?: RemoveStopWords;
 
   /**
-   * List of characters that the engine shouldn\'t automatically normalize.
+   * Characters that the engine shouldn\'t automatically [normalize](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
    */
   keepDiacriticsOnCharacters?: string;
 
   /**
-   * Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
+   * Sets your user\'s search language. This adjusts language-specific settings and features such as `ignorePlurals`, `removeStopWords`, and [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) word detection.
    */
   queryLanguages?: string[];
 
   /**
-   * Splits compound words into their composing atoms in the query.
+   * [Splits compound words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words) into their component word parts in the query.
    */
   decompoundQuery?: boolean;
 
   /**
-   * Whether Rules should be globally enabled.
+   * Incidates whether [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/) are enabled.
    */
   enableRules?: boolean;
 
   /**
-   * Enable the Personalization feature.
+   * Incidates whether [Personalization](https://www.algolia.com/doc/guides/personalization/what-is-personalization/) is enabled.
    */
   enablePersonalization?: boolean;
 
@@ -137,69 +130,85 @@ export type IndexSettingsAsSearchParams = {
 
   removeWordsIfNoResults?: RemoveWordsIfNoResults;
 
+  mode?: Mode;
+
+  semanticSearch?: SemanticSearch;
+
   /**
-   * Enables the advanced query syntax.
+   * Enables the [advanced query syntax](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#advanced-syntax).
    */
   advancedSyntax?: boolean;
 
   /**
-   * A list of words that should be considered as optional when found in the query.
+   * Words which should be considered [optional](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words) when found in a query.
    */
   optionalWords?: string[];
 
   /**
-   * List of attributes on which you want to disable the exact ranking criterion.
+   * Attributes for which you want to [turn off 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).
    */
   disableExactOnAttributes?: string[];
 
   exactOnSingleWordQuery?: ExactOnSingleWordQuery;
 
   /**
-   * List of alternatives that should be considered an exact match by the exact ranking criterion.
+   * Alternatives that should be considered an exact match by [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).
    */
   alternativesAsExact?: AlternativesAsExact[];
 
   /**
-   * Allows you to specify which advanced syntax features are active when ‘advancedSyntax\' is enabled.
+   * Allows you to specify which advanced syntax features are active when `advancedSyntax` is enabled.
    */
   advancedSyntaxFeatures?: AdvancedSyntaxFeatures[];
 
   distinct?: Distinct;
 
   /**
-   * Name of the de-duplication attribute to be used with the distinct feature.
+   * Name of the deduplication attribute to be used with Algolia\'s [_distinct_ feature](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).
    */
   attributeForDistinct?: string;
 
-  /**
-   * Whether to take into account an index\'s synonyms for a particular search.
-   */
-  synonyms?: boolean;
-
   /**
    * Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
    */
   replaceSynonymsInHighlight?: boolean;
 
   /**
-   * Precision of the proximity ranking criterion.
+   * Precision of the [proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity).
    */
   minProximity?: number;
 
   /**
-   * Choose which fields to return in the API response. This parameters applies to search and browse queries.
+   * Attributes to include in the API response for 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.
+   * 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;
 
   /**
-   * 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.
+   * Maximum number of facet values to return for each facet.
+   */
+  maxValuesPerFacet?: number;
+
+  /**
+   * Controls how facet values are fetched.
+   */
+  sortFacetValuesBy?: string;
+
+  /**
+   * When the [Attribute criterion is ranked above Proximity](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute-and-proximity-combinations) in your ranking formula, Proximity is used to select which searchable attribute is matched in the Attribute ranking stage.
    */
   attributeCriteriaComputedByMinProximity?: boolean;
 
   renderingContent?: RenderingContent;
+
+  /**
+   * Indicates whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).
+   */
+  enableReRanking?: boolean;
+
+  reRankingApplyFilter?: ReRankingApplyFilter | null;
 };

package/model/languages.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 { DictionaryLanguage } from './dictionaryLanguage';
 
 /**
- * A dictionary language.
+ * Dictionary language.
  */
 export type Languages = {
   plurals: DictionaryLanguage | null;

package/model/listApiKeysResponse.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 { GetApiKeyResponse } from './getApiKeyResponse';
 
 export type ListApiKeysResponse = {
   /**
-   * List of api keys.
+   * API keys.
    */
   keys: GetApiKeyResponse[];
 };

package/model/listClustersResponse.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.
 
 /**
- * Array of clusters.
+ * Clusters.
  */
 export type ListClustersResponse = {
   /**
-   * Mapping of cluster names to top users.
+   * Key-value pairs with cluster names as keys and lists of users with the highest number of records per cluster as values.
    */
   topUsers: string[];
 };

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

@@ -1,13 +1,13 @@
-// 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 { UserId } from './userId';
 
 /**
- * UserIDs data.
+ * User ID data.
  */
 export type ListUserIdsResponse = {
   /**
-   * List of userIDs.
+   * User IDs.
    */
   userIDs: UserId[];
 };

package/model/log.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 { LogQuery } from './logQuery';
 
 export type Log = {
   /**
-   * Timestamp in ISO-8601 format.
+   * Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   timestamp: string;
 
@@ -19,12 +19,12 @@ export type Log = {
   answer_code: string;
 
   /**
-   * Request body. Truncated after 1000 characters.
+   * Request body. Truncated after 1,000 characters.
    */
   query_body: string;
 
   /**
-   * Answer body. Truncated after 1000 characters.
+   * Answer body. Truncated after 1,000 characters.
    */
   answer: string;
 
@@ -34,12 +34,12 @@ export type Log = {
   url: string;
 
   /**
-   * IP of the client which performed the request.
+   * IP address of the client that performed the request.
    */
   ip: string;
 
   /**
-   * Request Headers (API Key is obfuscated).
+   * Request headers (API key is obfuscated).
    */
   query_headers: string;
 
@@ -54,7 +54,7 @@ export type Log = {
   nb_api_calls: string;
 
   /**
-   * Processing time for the query. It doesn\'t include network time.
+   * Processing time for the query. Doesn\'t include network time.
    */
   processing_time_ms: string;
 
@@ -74,7 +74,7 @@ export type Log = {
   query_nb_hits?: string;
 
   /**
-   * Array of all performed queries for the given request.
+   * Performed queries for the given request.
    */
   inner_queries?: LogQuery[];
 };

package/model/logQuery.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 LogQuery = {
   /**
@@ -12,7 +12,7 @@ export type LogQuery = {
   user_token?: string;
 
   /**
-   * QueryID for the given query.
+   * Unique query identifier.
    */
   query_id?: string;
 };

package/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/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/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/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/multipleBatchRequest.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 { Action } from './action';
 
@@ -6,7 +6,7 @@ export type MultipleBatchRequest = {
   action: Action;
 
   /**
-   * Arguments to the operation (depends on the type of the operation).
+   * Operation arguments (varies with specified `action`).
    */
   body: Record<string, any>;
 

package/model/multipleBatchResponse.ts

@@ -1,13 +1,13 @@
-// 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 MultipleBatchResponse = {
   /**
-   * List of tasksIDs per index.
+   * TaskIDs per index.
    */
   taskID: Record<string, number>;
 
   /**
-   * List of objectID.
+   * Unique object (record) identifiers.
    */
   objectIDs: string[];
 };

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/operationIndexParams.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 { OperationType } from './operationType';
 import type { ScopeType } from './scopeType';
@@ -7,12 +7,12 @@ export type OperationIndexParams = {
   operation: OperationType;
 
   /**
-   * The Algolia index name.
+   * Algolia index name.
    */
   destination: string;
 
   /**
-   * Scope of the data to copy. When absent, a full copy is performed. When present, only the selected scopes are copied.
+   * **This only applies to the _copy_ operation.**  If you omit `scope`, the copy command copies all records, settings, synonyms, and rules.  If you specify `scope`, only the specified scopes are copied.
    */
   scope?: ScopeType[];
 };

package/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/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

@@ -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/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 = {
   /**