@algolia/client-search 5.0.0-alpha.73 → 5.0.0-alpha.76

package/model/indexSettingsAsSearchParamsSemanticSearch.ts

@@ -1,11 +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.
 
 /**
- * The settings relevant for configuration of the semantic search engine. These settings are only used when the mode is set to \'neuralSearch\'.
+ * Settings for the semantic search part of NeuralSearch. Only used when `mode` is _neuralSearch_.
  */
 export type IndexSettingsAsSearchParamsSemanticSearch = {
   /**
-   * When null, the current index / replica group will be used as the event source.
+   * 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/languages.ts

@@ -3,7 +3,7 @@
 import type { DictionaryLanguage } from './dictionaryLanguage';
 
 /**
- * A dictionary language.
+ * Dictionary language.
  */
 export type Languages = {
   plurals: DictionaryLanguage | null;

package/model/listApiKeysResponse.ts

@@ -4,7 +4,7 @@ import type { GetApiKeyResponse } from './getApiKeyResponse';
 
 export type ListApiKeysResponse = {
   /**
-   * List of api keys.
+   * API keys.
    */
   keys: GetApiKeyResponse[];
 };

package/model/listClustersResponse.ts

@@ -1,11 +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.
 
 /**
- * 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

@@ -4,7 +4,7 @@ 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

@@ -3,11 +3,11 @@
 import type { UserId } from './userId';
 
 /**
- * UserIDs data.
+ * User ID data.
  */
 export type ListUserIdsResponse = {
   /**
-   * List of userIDs.
+   * User IDs.
    */
   userIDs: UserId[];
 };

package/model/log.ts

@@ -4,7 +4,7 @@ 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

@@ -12,7 +12,7 @@ export type LogQuery = {
   user_token?: string;
 
   /**
-   * QueryID for the given query.
+   * Unique query identifier.
    */
   query_id?: string;
 };

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

package/model/multipleBatchRequest.ts

@@ -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

@@ -2,12 +2,12 @@
 
 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

@@ -3,6 +3,6 @@
 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

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

@@ -3,6 +3,6 @@
 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

@@ -5,7 +5,7 @@ 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/promoteObjectID.ts

@@ -1,16 +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.
 
 /**
- * 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/model/promoteObjectIDs.ts

@@ -1,16 +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.
 
 /**
- * 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/model/queryType.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 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/reRankingApplyFilter.ts

@@ -3,6 +3,6 @@
 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/redirectRuleIndexMetadata.ts

@@ -19,7 +19,7 @@ export type RedirectRuleIndexMetadata = {
   reason: string;
 
   /**
-   * Status for the redirect rule.
+   * Redirect rule status.
    */
   succeed: boolean;
 

package/model/redirectRuleIndexMetadataData.ts

@@ -1,7 +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.
 
 /**
- * Data for the redirect rule.
+ * Redirect rule data.
  */
 export type RedirectRuleIndexMetadataData = {
   ruleObjectID: string;

package/model/removeStopWords.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.
 
 /**
- * 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/removeUserIdResponse.ts

@@ -2,7 +2,7 @@
 
 export type RemoveUserIdResponse = {
   /**
-   * Date of deletion (ISO-8601 format).
+   * Timestamp of deletion in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   deletedAt: string;
 };

package/model/removeWordsIfNoResults.ts

@@ -1,7 +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.
 
 /**
- * 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

@@ -3,7 +3,7 @@
 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/replaceSourceResponse.ts

@@ -2,7 +2,7 @@
 
 export type ReplaceSourceResponse = {
   /**
-   * Date of last update (ISO-8601 format).
+   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   updatedAt: string;
 };

package/model/rule.ts

@@ -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/model/saveObjectResponse.ts

@@ -1,15 +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.
 
 export type SaveObjectResponse = {
+  /**
+   * Date of creation (ISO-8601 format).
+   */
   createdAt: string;
 
   /**
-   * TaskID of the task to wait for.
+   * 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;
 
   /**
-   * Unique identifier of the object.
+   * Unique object identifier.
    */
   objectID?: string;
 };

package/model/saveSynonymResponse.ts

@@ -2,17 +2,17 @@
 
 export type SaveSynonymResponse = {
   /**
-   * TaskID of the task to wait for.
+   * 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;
 
   /**
-   * Date of last update (ISO-8601 format).
+   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   updatedAt: string;
 
   /**
-   * ObjectID of the inserted object.
+   * Unique identifier of a synonym object.
    */
   id: string;
 };

package/model/searchDictionaryEntriesParams.ts

@@ -1,26 +1,26 @@
 // 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 `searchDictionaryEntries` parameters.
+ * `searchDictionaryEntries` parameters.
  */
 export type SearchDictionaryEntriesParams = {
   /**
-   * The text to search in the index.
+   * Text to search for in an index.
    */
   query: string;
 
   /**
-   * Specify the page to retrieve.
+   * Page to retrieve (the first page is `0`, not `1`).
    */
   page?: number;
 
   /**
-   * Set the number of hits per page.
+   * Number of hits per page.
    */
   hitsPerPage?: number;
 
   /**
-   * Language ISO code supported by the dictionary (e.g., \"en\" for English).
+   * [Supported language ISO code](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/).
    */
   language?: string;
 };

package/model/searchForFacetValuesRequest.ts

@@ -2,7 +2,7 @@
 
 export type SearchForFacetValuesRequest = {
   /**
-   * Search parameters as URL-encoded query string.
+   * Search parameters as a URL-encoded query string.
    */
   params?: string;
 
@@ -12,7 +12,7 @@ export type SearchForFacetValuesRequest = {
   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/model/searchForFacetsOptions.ts

@@ -4,12 +4,12 @@ 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/model/searchForHitsOptions.ts

@@ -4,7 +4,7 @@ import type { SearchTypeDefault } from './searchTypeDefault';
 
 export type SearchForHitsOptions = {
   /**
-   * The Algolia index name.
+   * Algolia index name.
    */
   indexName: string;
 

package/model/searchParamsQuery.ts

@@ -2,7 +2,7 @@
 
 export type SearchParamsQuery = {
   /**
-   * The text to search in the index.
+   * Text to search for in an index.
    */
   query?: string;
 };

package/model/searchParamsString.ts

@@ -2,7 +2,7 @@
 
 export type SearchParamsString = {
   /**
-   * Search parameters as URL-encoded query string.
+   * Search parameters as a URL-encoded query string.
    */
   params?: string;
 };

package/model/searchResponses.ts

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

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

package/model/searchRulesParams.ts

@@ -3,38 +3,38 @@
 import type { Anchoring } from './anchoring';
 
 /**
- * Parameters for the search.
+ * Rules search parameters.
  */
 export type SearchRulesParams = {
   /**
-   * Full text query.
+   * Rule object query.
    */
   query?: string;
 
   anchoring?: Anchoring;
 
   /**
-   * Restricts matches to contextual rules with a specific context (exact match).
+   * 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 (zero-based).
+   * Requested page (the first page is page 0).
    */
   page?: number;
 
   /**
-   * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
+   * Maximum number of hits per page.
    */
   hitsPerPage?: number;
 
   /**
-   * When specified, restricts matches to rules with a specific enabled status. When absent (default), all rules are retrieved, regardless of their enabled status.
+   * Restricts responses to enabled rules. When not specified (default), _all_ rules are retrieved.
    */
   enabled?: boolean | null;
 
   /**
-   * A mapping of requestOptions to send along with the request.
+   * Request options to send with the API call.
    */
   requestOptions?: Array<Record<string, any>>;
 };

package/model/searchStrategy.ts

@@ -1,3 +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.
 
+/**
+ * - `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';