algoliasearch 5.0.0-alpha.73 → 5.0.0-alpha.76

package/lite/model/baseSearchResponse.ts

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

package/lite/model/baseSearchResponseRedirect.ts

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

package/lite/model/builtInOperation.ts

@@ -9,7 +9,7 @@ export type BuiltInOperation = {
   _operation: BuiltInOperationType;
 
   /**
-   * The right-hand side argument to the operation, for example, increment or decrement step, value to add or remove.
+   * Value that corresponds to the operation, for example an `Increment` or `Decrement` step, `Add` or `Remove` value.
    */
   value: string;
 };

package/lite/model/builtInOperationType.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.
 
 /**
- * The operation to apply on the attribute.
+ * Operation to apply to the attribute.
  */
 export type BuiltInOperationType =
   | 'Add'

package/lite/model/clientMethodProps.ts

@@ -9,15 +9,15 @@ import type { SearchParamsObject } from './searchParamsObject';
  */
 export type PostProps = {
   /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
   /**
-   * The parameters to send with the custom request.
+   * Parameters to send with the custom request.
    */
   body?: Record<string, any>;
 };

package/lite/model/consequence.ts

@@ -5,23 +5,23 @@ import type { ConsequenceParams } from './consequenceParams';
 import type { Promote } from './promote';
 
 /**
- * Consequence of the Rule.
+ * [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences) of a rule.
  */
 export type Consequence = {
   params?: ConsequenceParams;
 
   /**
-   * Objects to promote as hits.
+   * Records to promote.
    */
   promote?: Promote[];
 
   /**
-   * Only use in combination with the promote consequence. When true, promoted results will be restricted to match the filters of the current search. When false, the promoted results will show up regardless of the filters.
+   * Only use in combination with the `promote` consequence. When `true`, promoted results will be restricted to match the filters of the current search. When `false`, the promoted results will show up regardless of the filters.
    */
   filterPromotes?: boolean;
 
   /**
-   * Objects to hide from hits. Each object must contain an objectID field. By default, you can hide up to 50 items per rule.
+   * Records to hide. By default, you can hide up to 50 records per rule.
    */
   hide?: ConsequenceHide[];
 

package/lite/model/consequenceHide.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.
 
 /**
- * Unique identifier of the object to hide.
+ * Unique identifier of the record to hide.
  */
 export type ConsequenceHide = {
   /**
-   * Unique identifier of the object.
+   * Unique object identifier.
    */
   objectID: string;
 };

package/lite/model/cursor.ts

@@ -2,7 +2,7 @@
 
 export type Cursor = {
   /**
-   * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
+   * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call. Pass this value to the subsequent browse call to get the next page of results. When the end of the index has been reached, `cursor` is absent from the response.
    */
   cursor?: string;
 };

package/lite/model/deleteByParams.ts

@@ -9,7 +9,7 @@ export type DeleteByParams = {
   facetFilters?: FacetFilters;
 
   /**
-   * Filter the query with numeric, facet and/or tag filters.
+   * [Filter](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) the query with numeric, facet, or tag filters.
    */
   filters?: string;
 
@@ -18,19 +18,19 @@ export type DeleteByParams = {
   tagFilters?: TagFilters;
 
   /**
-   * Search for entries around a central geolocation, enabling a geo search within a circular area.
+   * Search for entries [around a central location](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filter-around-a-central-point), enabling a geographical search within a circular area.
    */
   aroundLatLng?: string;
 
   aroundRadius?: AroundRadius;
 
   /**
-   * Search inside a rectangular area (in geo coordinates).
+   * Search inside a [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
    */
   insideBoundingBox?: number[];
 
   /**
-   * Search inside a polygon (in geo coordinates).
+   * Search inside a [polygon](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
    */
   insidePolygon?: number[];
 };

package/lite/model/dictionaryEntry.ts

@@ -3,31 +3,31 @@
 import type { DictionaryEntryState } from './dictionaryEntryState';
 
 /**
- * A dictionary entry.
+ * Dictionary entry.
  */
 export type DictionaryEntry = Record<string, any> & {
   /**
-   * Unique identifier of the object.
+   * Unique identifier for a dictionary object.
    */
   objectID: string;
 
   /**
-   * 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;
 
   /**
-   * The word of the dictionary entry.
+   * Dictionary entry word. Usage depends on the type of dictionary entry. **`stopwordEntry`** The stop word you want to add or update. If the entry already exists in Algolia\'s standard dictionary, you can override its behavior by adding it to the custom dictionary and setting its `state` to `disabled`. **`compoundEntry`** When `decomposition` is empty: adds `word` as a compound atom. For example, atom “kino” decomposes the query “kopfkino” into \"kopf\" and \"kino\". When `decomposition` isn\'t empty: creates a decomposition exception. For example, when decomposition is set to the [\"hund\", \"hutte\"] exception, \"hundehutte\" decomposes into “hund” and “hutte”, discarding the linking \"e\".
    */
   word?: string;
 
   /**
-   * The words of the dictionary entry.
+   * Compound dictionary [word declensions](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/). If the entry already exists in Algolia\'s standard dictionary, you can override its behavior by adding it to the custom dictionary and setting its `state` to `disabled`.
    */
   words?: string[];
 
   /**
-   * A decomposition of the word of the dictionary entry.
+   * For compound entries, governs the behavior of the `word` parameter.
    */
   decomposition?: string[];
 

package/lite/model/dictionaryEntryState.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 state of the dictionary entry.
+ * Indicates whether a dictionary entry is active (`enabled`) or inactive (`disabled`).
  */
 export type DictionaryEntryState = 'disabled' | 'enabled';

package/lite/model/dictionaryLanguage.ts

@@ -5,7 +5,7 @@
  */
 export type DictionaryLanguage = {
   /**
-   * When nbCustomEntries is set to 0, the user didn\'t customize the dictionary. The dictionary is still supported with standard, Algolia-provided entries.
+   * If `0`, the dictionary hasn\'t been customized and only contains standard entries provided by Algolia. If `null`, that feature isn\'t available or isn\'t supported for that language.
    */
-  nbCustomEntires?: number;
+  nbCustomEntries?: number;
 };

package/lite/model/distinct.ts

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

package/lite/model/exactOnSingleWordQuery.ts

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Controls how the exact ranking criterion is computed when the query contains only one word.
+ * Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the query contains only one word.
  */
 export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';

package/lite/model/facetFilters.ts

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

package/lite/model/facetHits.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.
+
+export type FacetHits = {
+  /**
+   * Facet value.
+   */
+  value: string;
+
+  /**
+   * Markup text with `facetQuery` matches highlighted.
+   */
+  highlighted: string;
+
+  /**
+   * Number of records containing this facet value. This takes into account the extra search parameters specified in the query. Like for a regular search query, the [counts may not be exhaustive](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
+   */
+  count: number;
+};

package/lite/model/facetOrdering.ts

@@ -4,13 +4,13 @@ import type { Facets } from './facets';
 import type { Value } from './value';
 
 /**
- * Defining how facets should be ordered.
+ * Defines the ordering of facets (widgets).
  */
 export type FacetOrdering = {
   facets?: Facets;
 
   /**
-   * The ordering of facet values, within an individual list.
+   * Ordering of facet values within an individual facet.
    */
   values?: Record<string, Value>;
 };

package/lite/model/facets.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.
 
 /**
- * The ordering of facets (widgets).
+ * Ordering of facets (widgets).
  */
 export type Facets = {
   /**

package/lite/model/facetsStats.ts

@@ -2,22 +2,22 @@
 
 export type FacetsStats = {
   /**
-   * The minimum value in the result set.
+   * Minimum value in the results.
    */
   min?: number;
 
   /**
-   * The maximum value in the result set.
+   * Maximum value in the results.
    */
   max?: number;
 
   /**
-   * The average facet value in the result set.
+   * Average facet value in the results.
    */
   avg?: number;
 
   /**
-   * The sum of all values in the result set.
+   * Sum of all values in the results.
    */
   sum?: number;
 };

package/lite/model/fetchedIndex.ts

@@ -12,7 +12,7 @@ export type FetchedIndex = {
   createdAt: string;
 
   /**
-   * 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/lite/model/highlightResultOption.ts

@@ -7,7 +7,7 @@ import type { MatchLevel } from './matchLevel';
  */
 export type HighlightResultOption = {
   /**
-   * Markup text with occurrences highlighted.
+   * Markup text with `facetQuery` matches highlighted.
    */
   value: string;
 

package/lite/model/hit.ts

@@ -9,7 +9,7 @@ import type { SnippetResult } from './snippetResult';
  */
 export type Hit<T = Record<string, any>> = T & {
   /**
-   * Unique identifier of the object.
+   * Unique object identifier.
    */
   objectID: string;
 

package/lite/model/ignorePlurals.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.
 
 /**
- * Treats singular, plurals, and other forms of declensions as matching terms. IgnorePlurals 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 ignore plurals functionality, where singulars and plurals are considered equivalent (foot = feet). The languages supported here are either every language (this is the default, see list of languages below), or those set by queryLanguages. False: disables ignore plurals, where singulars and plurals are not considered the same for matching purposes (foot will not find feet).
+ * Treats singular, plurals, and other forms of declensions as matching terms. `ignorePlurals` 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 ignore plurals feature, where singulars and plurals are considered equivalent (\"foot\" = \"feet\"). 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 ignore plurals feature, so that singulars and plurals aren\'t considered to be the same (\"foot\" will not find \"feet\").
  */
 export type IgnorePlurals = string[] | boolean;

package/lite/model/index.ts

@@ -42,6 +42,7 @@ export * from './editType';
 export * from './errorBase';
 export * from './exactOnSingleWordQuery';
 export * from './facetFilters';
+export * from './facetHits';
 export * from './facetOrdering';
 export * from './facets';
 export * from './facetsStats';
@@ -79,6 +80,7 @@ export * from './removeWordsIfNoResults';
 export * from './renderingContent';
 export * from './rule';
 export * from './scopeType';
+export * from './searchForFacetValuesResponse';
 export * from './searchForFacets';
 export * from './searchForFacetsOptions';
 export * from './searchForHits';
@@ -92,6 +94,7 @@ export * from './searchParamsString';
 export * from './searchQuery';
 export * from './searchResponse';
 export * from './searchResponses';
+export * from './searchResult';
 export * from './searchStrategy';
 export * from './searchSynonymsResponse';
 export * from './searchTypeDefault';

package/lite/model/indexSettings.ts

@@ -4,6 +4,6 @@ import type { BaseIndexSettings } from './baseIndexSettings';
 import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
 
 /**
- * The Algolia index settings.
+ * Algolia index settings.
  */
 export type IndexSettings = BaseIndexSettings & IndexSettingsAsSearchParams;