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

package/dist/model/indexSettingsAsSearchParams.d.ts

@@ -1,161 +1,167 @@
-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 { QueryType } from './queryType';
-import type { RemoveStopWords } from './removeStopWords';
-import type { RemoveWordsIfNoResults } from './removeWordsIfNoResults';
-import type { RenderingContent } from './renderingContent';
-import type { TypoTolerance } from './typoTolerance';
-export declare type IndexSettingsAsSearchParams = {
-    /**
-     * The complete list of attributes that will be used for faceting.
-     */
-    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.
-     */
-    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.
-     */
-    ranking?: string[];
-    /**
-     * Specifies the custom ranking criterion.
-     */
-    customRanking?: string[];
-    /**
-     * Controls the relevancy threshold below which less relevant results aren\'t included in the results.
-     */
-    relevancyStrictness?: number;
-    /**
-     * List of attributes to highlight.
-     */
-    attributesToHighlight?: string[];
-    /**
-     * List of attributes to snippet, with an optional maximum number of words to snippet.
-     */
-    attributesToSnippet?: string[];
-    /**
-     * The 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.
-     */
-    highlightPostTag?: string;
-    /**
-     * String used as an ellipsis indicator when a snippet is truncated.
-     */
-    snippetEllipsisText?: string;
-    /**
-     * Restrict highlighting and snippeting to items that matched the query.
-     */
-    restrictHighlightAndSnippetArrays?: boolean;
-    /**
-     * Set the 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.
-     */
-    minWordSizefor1Typo?: number;
-    /**
-     * Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
-     */
-    minWordSizefor2Typos?: number;
-    typoTolerance?: TypoTolerance;
-    /**
-     * Whether to allow typos on numbers (\"numeric tokens\") in the query string.
-     */
-    allowTyposOnNumericTokens?: boolean;
-    /**
-     * List of attributes on which you want to disable typo tolerance.
-     */
-    disableTypoToleranceOnAttributes?: string[];
-    ignorePlurals?: IgnorePlurals;
-    removeStopWords?: RemoveStopWords;
-    /**
-     * List of characters that the engine shouldn\'t automatically normalize.
-     */
-    keepDiacriticsOnCharacters?: string;
-    /**
-     * Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
-     */
-    queryLanguages?: string[];
-    /**
-     * Splits compound words into their composing atoms in the query.
-     */
-    decompoundQuery?: boolean;
-    /**
-     * Whether Rules should be globally enabled.
-     */
-    enableRules?: boolean;
-    /**
-     * Enable the Personalization feature.
-     */
-    enablePersonalization?: boolean;
-    queryType?: QueryType;
-    removeWordsIfNoResults?: RemoveWordsIfNoResults;
-    /**
-     * Enables the advanced query syntax.
-     */
-    advancedSyntax?: boolean;
-    /**
-     * A list of words that should be considered as optional when found in the query.
-     */
-    optionalWords?: string[];
-    /**
-     * List of attributes on which you want to disable the exact ranking criterion.
-     */
-    disableExactOnAttributes?: string[];
-    exactOnSingleWordQuery?: ExactOnSingleWordQuery;
-    /**
-     * List of alternatives that should be considered an exact match by the exact ranking criterion.
-     */
-    alternativesAsExact?: AlternativesAsExact[];
-    /**
-     * 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.
-     */
-    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.
-     */
-    minProximity?: number;
-    /**
-     * Choose which fields to return in the API response. This parameters applies to 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.
-     */
-    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.
-     */
-    attributeCriteriaComputedByMinProximity?: boolean;
-    renderingContent?: RenderingContent;
-};
+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 = {
+    /**
+     * 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[];
+    /**
+     * 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[];
+    /**
+     * 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](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[];
+    /**
+     * Relevancy threshold below which less relevant results aren\'t included in the results.
+     */
+    relevancyStrictness?: number;
+    /**
+     * 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[];
+    /**
+     * 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[];
+    /**
+     * HTML string to insert before the highlighted parts in all highlight and snippet results.
+     */
+    highlightPreTag?: string;
+    /**
+     * HTML string to insert after the highlighted parts in all highlight and snippet results.
+     */
+    highlightPostTag?: string;
+    /**
+     * String used as an ellipsis indicator when a snippet is truncated.
+     */
+    snippetEllipsisText?: string;
+    /**
+     * Restrict highlighting and snippeting to items that matched the query.
+     */
+    restrictHighlightAndSnippetArrays?: boolean;
+    /**
+     * Number of hits per page.
+     */
+    hitsPerPage?: number;
+    /**
+     * 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 [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;
+    typoTolerance?: TypoTolerance;
+    /**
+     * Whether to allow typos on numbers (\"numeric tokens\") in the query string.
+     */
+    allowTyposOnNumericTokens?: boolean;
+    /**
+     * 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[];
+    ignorePlurals?: IgnorePlurals;
+    removeStopWords?: RemoveStopWords;
+    /**
+     * 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 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](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;
+    /**
+     * Incidates whether [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/) are enabled.
+     */
+    enableRules?: boolean;
+    /**
+     * Incidates whether [Personalization](https://www.algolia.com/doc/guides/personalization/what-is-personalization/) is enabled.
+     */
+    enablePersonalization?: boolean;
+    queryType?: QueryType;
+    removeWordsIfNoResults?: RemoveWordsIfNoResults;
+    mode?: Mode;
+    semanticSearch?: SemanticSearch;
+    /**
+     * Enables the [advanced query syntax](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#advanced-syntax).
+     */
+    advancedSyntax?: boolean;
+    /**
+     * 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[];
+    /**
+     * 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;
+    /**
+     * 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.
+     */
+    advancedSyntaxFeatures?: AdvancedSyntaxFeatures[];
+    distinct?: Distinct;
+    /**
+     * 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 highlight and snippet the original word that matches the synonym or the synonym itself.
+     */
+    replaceSynonymsInHighlight?: boolean;
+    /**
+     * Precision of the [proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity).
+     */
+    minProximity?: number;
+    /**
+     * Attributes to include in the API response for search and browse queries.
+     */
+    responseFields?: string[];
+    /**
+     * 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;
+    /**
+     * 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;
+};
 //# sourceMappingURL=indexSettingsAsSearchParams.d.ts.map

package/dist/model/indexSettingsAsSearchParams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"indexSettingsAsSearchParams.d.ts","sourceRoot":"","sources":["../../model/indexSettingsAsSearchParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,oBAAY,2BAA2B,GAAG;IACxC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;OAEG;IACH,4BAA4B,CAAC,EAAE,MAAM,EAAE,CAAC;IAExC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,iCAAiC,CAAC,EAAE,OAAO,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,gCAAgC,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5C,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAEhD;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpC,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAEhD;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAE5C;;OAEG;IACH,sBAAsB,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAElD,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,uCAAuC,CAAC,EAAE,OAAO,CAAC;IAElD,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAC"}
+{"version":3,"file":"indexSettingsAsSearchParams.d.ts","sourceRoot":"","sources":["../../model/indexSettingsAsSearchParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,iCAAiC,CAAC,EAAE,OAAO,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,gCAAgC,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5C,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAEhD,IAAI,CAAC,EAAE,IAAI,CAAC;IAEZ,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpC,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAEhD;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAE5C;;OAEG;IACH,sBAAsB,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAElD,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,uCAAuC,CAAC,EAAE,OAAO,CAAC;IAElD,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,oBAAoB,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;CACpD,CAAC"}

package/dist/model/languages.d.ts

@@ -1,10 +1,10 @@
-import type { DictionaryLanguage } from './dictionaryLanguage';
-/**
- * A dictionary language.
- */
-export declare type Languages = {
-    plurals: DictionaryLanguage | null;
-    stopwords: DictionaryLanguage | null;
-    compounds: DictionaryLanguage | null;
-};
+import type { DictionaryLanguage } from './dictionaryLanguage';
+/**
+ * Dictionary language.
+ */
+export type Languages = {
+    plurals: DictionaryLanguage | null;
+    stopwords: DictionaryLanguage | null;
+    compounds: DictionaryLanguage | null;
+};
 //# sourceMappingURL=languages.d.ts.map

package/dist/model/languages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"languages.d.ts","sourceRoot":"","sources":["../../model/languages.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,oBAAY,SAAS,GAAG;IACtB,OAAO,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEnC,SAAS,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAErC,SAAS,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACtC,CAAC"}
+{"version":3,"file":"languages.d.ts","sourceRoot":"","sources":["../../model/languages.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,OAAO,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEnC,SAAS,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAErC,SAAS,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACtC,CAAC"}

package/dist/model/listApiKeysResponse.d.ts

@@ -1,8 +1,8 @@
-import type { GetApiKeyResponse } from './getApiKeyResponse';
-export declare type ListApiKeysResponse = {
-    /**
-     * List of api keys.
-     */
-    keys: GetApiKeyResponse[];
-};
+import type { GetApiKeyResponse } from './getApiKeyResponse';
+export type ListApiKeysResponse = {
+    /**
+     * API keys.
+     */
+    keys: GetApiKeyResponse[];
+};
 //# sourceMappingURL=listApiKeysResponse.d.ts.map

package/dist/model/listApiKeysResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"listApiKeysResponse.d.ts","sourceRoot":"","sources":["../../model/listApiKeysResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,iBAAiB,EAAE,CAAC;CAC3B,CAAC"}
+{"version":3,"file":"listApiKeysResponse.d.ts","sourceRoot":"","sources":["../../model/listApiKeysResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,iBAAiB,EAAE,CAAC;CAC3B,CAAC"}

package/dist/model/listClustersResponse.d.ts

@@ -1,10 +1,10 @@
-/**
- * Array of clusters.
- */
-export declare type ListClustersResponse = {
-    /**
-     * Mapping of cluster names to top users.
-     */
-    topUsers: string[];
-};
+/**
+ * Clusters.
+ */
+export type ListClustersResponse = {
+    /**
+     * Key-value pairs with cluster names as keys and lists of users with the highest number of records per cluster as values.
+     */
+    topUsers: string[];
+};
 //# sourceMappingURL=listClustersResponse.d.ts.map

package/dist/model/listClustersResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"listClustersResponse.d.ts","sourceRoot":"","sources":["../../model/listClustersResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,oBAAoB,GAAG;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC"}
+{"version":3,"file":"listClustersResponse.d.ts","sourceRoot":"","sources":["../../model/listClustersResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC"}

package/dist/model/listIndicesResponse.d.ts

@@ -1,12 +1,12 @@
-import type { FetchedIndex } from './fetchedIndex';
-export declare type ListIndicesResponse = {
-    /**
-     * List of the fetched indices.
-     */
-    items: FetchedIndex[];
-    /**
-     * Number of pages.
-     */
-    nbPages?: number;
-};
+import type { FetchedIndex } from './fetchedIndex';
+export type ListIndicesResponse = {
+    /**
+     * All indices in your Algolia application.
+     */
+    items: FetchedIndex[];
+    /**
+     * Number of pages.
+     */
+    nbPages?: number;
+};
 //# sourceMappingURL=listIndicesResponse.d.ts.map

package/dist/model/listIndicesResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"listIndicesResponse.d.ts","sourceRoot":"","sources":["../../model/listIndicesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,YAAY,EAAE,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
+{"version":3,"file":"listIndicesResponse.d.ts","sourceRoot":"","sources":["../../model/listIndicesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,YAAY,EAAE,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/model/listUserIdsResponse.d.ts

@@ -1,11 +1,11 @@
-import type { UserId } from './userId';
-/**
- * UserIDs data.
- */
-export declare type ListUserIdsResponse = {
-    /**
-     * List of userIDs.
-     */
-    userIDs: UserId[];
-};
+import type { UserId } from './userId';
+/**
+ * User ID data.
+ */
+export type ListUserIdsResponse = {
+    /**
+     * User IDs.
+     */
+    userIDs: UserId[];
+};
 //# sourceMappingURL=listUserIdsResponse.d.ts.map

package/dist/model/listUserIdsResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"listUserIdsResponse.d.ts","sourceRoot":"","sources":["../../model/listUserIdsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC;;GAEG;AACH,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}
+{"version":3,"file":"listUserIdsResponse.d.ts","sourceRoot":"","sources":["../../model/listUserIdsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}

package/dist/model/log.d.ts

@@ -1,64 +1,64 @@
-import type { LogQuery } from './logQuery';
-export declare type Log = {
-    /**
-     * Timestamp in ISO-8601 format.
-     */
-    timestamp: string;
-    /**
-     * HTTP method of the performed request.
-     */
-    method: string;
-    /**
-     * HTTP response code.
-     */
-    answer_code: string;
-    /**
-     * Request body. Truncated after 1000 characters.
-     */
-    query_body: string;
-    /**
-     * Answer body. Truncated after 1000 characters.
-     */
-    answer: string;
-    /**
-     * Request URL.
-     */
-    url: string;
-    /**
-     * IP of the client which performed the request.
-     */
-    ip: string;
-    /**
-     * Request Headers (API Key is obfuscated).
-     */
-    query_headers: string;
-    /**
-     * SHA1 signature of the log entry.
-     */
-    sha1: string;
-    /**
-     * Number of API calls.
-     */
-    nb_api_calls: string;
-    /**
-     * Processing time for the query. It doesn\'t include network time.
-     */
-    processing_time_ms: string;
-    /**
-     * Index targeted by the query.
-     */
-    index?: string;
-    /**
-     * Query parameters sent with the request.
-     */
-    query_params?: string;
-    /**
-     * Number of hits returned for the query.
-     */
-    query_nb_hits?: string;
-    /**
-     * Array of all performed queries for the given request.
-     */
-    inner_queries?: LogQuery[];
-};
+import type { LogQuery } from './logQuery';
+export type Log = {
+    /**
+     * Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     */
+    timestamp: string;
+    /**
+     * HTTP method of the performed request.
+     */
+    method: string;
+    /**
+     * HTTP response code.
+     */
+    answer_code: string;
+    /**
+     * Request body. Truncated after 1,000 characters.
+     */
+    query_body: string;
+    /**
+     * Answer body. Truncated after 1,000 characters.
+     */
+    answer: string;
+    /**
+     * Request URL.
+     */
+    url: string;
+    /**
+     * IP address of the client that performed the request.
+     */
+    ip: string;
+    /**
+     * Request headers (API key is obfuscated).
+     */
+    query_headers: string;
+    /**
+     * SHA1 signature of the log entry.
+     */
+    sha1: string;
+    /**
+     * Number of API calls.
+     */
+    nb_api_calls: string;
+    /**
+     * Processing time for the query. Doesn\'t include network time.
+     */
+    processing_time_ms: string;
+    /**
+     * Index targeted by the query.
+     */
+    index?: string;
+    /**
+     * Query parameters sent with the request.
+     */
+    query_params?: string;
+    /**
+     * Number of hits returned for the query.
+     */
+    query_nb_hits?: string;
+    /**
+     * Performed queries for the given request.
+     */
+    inner_queries?: LogQuery[];
+};
 //# sourceMappingURL=log.d.ts.map

package/dist/model/log.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../model/log.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,oBAAY,GAAG,GAAG;IAChB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,QAAQ,EAAE,CAAC;CAC5B,CAAC"}
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../model/log.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,MAAM,MAAM,GAAG,GAAG;IAChB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,QAAQ,EAAE,CAAC;CAC5B,CAAC"}