@algolia/client-search 5.0.0-alpha.11 → 5.0.0-alpha.111

package/model/searchDictionaryEntriesParams.ts

@@ -1,26 +1,25 @@
-// 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 { SupportedLanguage } from './supportedLanguage';
 
 /**
- * The `searchDictionaryEntries` parameters.
+ * Search parameter.
  */
 export type SearchDictionaryEntriesParams = {
   /**
-   * The text to search in the index.
+   * Search query.
    */
   query: string;
 
   /**
-   * Specify the page to retrieve.
+   * Page of search results to retrieve.
    */
   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).
-   */
-  language?: string;
+  language?: SupportedLanguage;
 };

package/model/searchDictionaryEntriesResponse.ts

@@ -0,0 +1,25 @@
+// 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 { DictionaryEntry } from './dictionaryEntry';
+
+export type SearchDictionaryEntriesResponse = {
+  /**
+   * Dictionary entries matching the search criteria.
+   */
+  hits: DictionaryEntry[];
+
+  /**
+   * Requested page of the API response.
+   */
+  page: number;
+
+  /**
+   * Number of results (hits).
+   */
+  nbHits: number;
+
+  /**
+   * Number of pages of results.
+   */
+  nbPages: number;
+};

package/model/searchForFacetValuesRequest.ts

@@ -1,8 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 export type 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 values 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/searchForFacetValuesResponse.ts

@@ -1,7 +1,20 @@
-// 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 { FacetHits } from './facetHits';
 
 export type SearchForFacetValuesResponse = {
+  /**
+   * Matching facet values.
+   */
   facetHits: FacetHits[];
+
+  /**
+   * See the `facetsCount` field of the `exhaustive` object in the response.
+   */
+  exhaustiveFacetsCount: boolean;
+
+  /**
+   * Time the server took to process the request, in milliseconds.
+   */
+  processingTimeMS?: number;
 };

package/model/searchForFacets.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { SearchForFacetsOptions } from './searchForFacetsOptions';
 import type { SearchParams } from './searchParams';

package/model/searchForFacetsOptions.ts

@@ -1,15 +1,15 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { SearchTypeFacet } from './searchTypeFacet';
 
 export type SearchForFacetsOptions = {
   /**
-   * The `facet` name.
+   * Facet name.
    */
   facet: string;
 
   /**
-   * The Algolia index name.
+   * 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 values 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/searchForHits.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { SearchForHitsOptions } from './searchForHitsOptions';
 import type { SearchParams } from './searchParams';

package/model/searchForHitsOptions.ts

@@ -1,10 +1,10 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { SearchTypeDefault } from './searchTypeDefault';
 
 export type SearchForHitsOptions = {
   /**
-   * The Algolia index name.
+   * Index name.
    */
   indexName: string;
 

package/model/searchHits.ts

@@ -1,7 +1,20 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { Hit } from './hit';
 
-export type SearchHits<T = Record<string, any>> = {
+export type SearchHits<T = Record<string, any>> = Record<string, any> & {
+  /**
+   * Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
+   */
   hits: Array<Hit<T>>;
+
+  /**
+   * Search query.
+   */
+  query: string;
+
+  /**
+   * URL-encoded string of all search parameters.
+   */
+  params: string;
 };

package/model/searchMethodParams.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { SearchQuery } from './searchQuery';
 import type { SearchStrategy } from './searchStrategy';

package/model/searchParams.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { SearchParamsObject } from './searchParamsObject';
 import type { SearchParamsString } from './searchParamsString';

package/model/searchParamsObject.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { BaseSearchParams } from './baseSearchParams';
 import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';

package/model/searchParamsQuery.ts

@@ -1,8 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 export type SearchParamsQuery = {
   /**
-   * The text to search in the index.
+   * Search query.
    */
   query?: string;
 };

package/model/searchParamsString.ts

@@ -1,8 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 export type SearchParamsString = {
   /**
-   * Search parameters as URL-encoded query string.
+   * Search parameters as a URL-encoded query string.
    */
   params?: string;
 };

package/model/searchQuery.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { SearchForFacets } from './searchForFacets';
 import type { SearchForHits } from './searchForHits';

package/model/searchResponse.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { BaseSearchResponse } from './baseSearchResponse';
 import type { SearchHits } from './searchHits';

package/model/searchResponses.ts

@@ -1,7 +1,7 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { SearchResponse } from './searchResponse';
+import type { SearchResult } from './searchResult';
 
 export type SearchResponses<T = Record<string, any>> = {
-  results: Array<SearchResponse<T>>;
+  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

@@ -1,40 +1,35 @@
-// 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 { Anchoring } from './anchoring';
 
 /**
- * Parameters for the search.
+ * Rules search parameters.
  */
 export type SearchRulesParams = {
   /**
-   * Full text query.
+   * Search query for rules.
    */
   query?: string;
 
   anchoring?: Anchoring;
 
   /**
-   * Restricts matches to contextual rules with a specific context (exact match).
+   * Only return rules that match the context (exact match).
    */
   context?: string;
 
   /**
-   * Requested page (zero-based).
+   * Requested page of the API response.
    */
   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.
+   * If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned.
    */
-  enabled?: boolean;
-
-  /**
-   * A mapping of requestOptions to send along with the request.
-   */
-  requestOptions?: Array<Record<string, any>>;
+  enabled?: boolean | null;
 };

package/model/searchRulesResponse.ts

@@ -1,15 +1,15 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { Rule } from './rule';
 
 export type SearchRulesResponse = {
   /**
-   * Fetched rules.
+   * Rules that matched the search criteria.
    */
   hits: Rule[];
 
   /**
-   * Number of fetched rules.
+   * Number of rules that matched the search criteria.
    */
   nbHits: number;
 

package/model/searchStrategy.ts

@@ -1,3 +1,6 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
+/**
+ * Strategy for multiple search queries:  - `none`. Run all queries. - `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results.
+ */
 export type SearchStrategy = 'none' | 'stopIfEnoughMatches';

package/model/searchSynonymsParams.ts

@@ -1,8 +1,22 @@
-// 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 { SynonymType } from './synonymType';
 
 export type SearchSynonymsParams = {
   /**
-   * The text to search in the index.
+   * Search query.
    */
   query?: string;
+
+  type?: SynonymType;
+
+  /**
+   * Page of search results to retrieve.
+   */
+  page?: number;
+
+  /**
+   * Number of hits per page.
+   */
+  hitsPerPage?: number;
 };

package/model/searchSynonymsResponse.ts

@@ -1,15 +1,15 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { SynonymHit } from './synonymHit';
 
 export type SearchSynonymsResponse = Record<string, any> & {
   /**
-   * Array of synonym objects.
+   * Matching synonyms.
    */
   hits: SynonymHit[];
 
   /**
-   * Number of hits that the search query matched.
+   * Number of results (hits).
    */
   nbHits: number;
 };

package/model/searchTypeDefault.ts

@@ -1,6 +1,6 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Perform a search query with `default`, will search for facet values if `facet` is given.
+ * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
  */
 export type SearchTypeDefault = 'default';

package/model/searchTypeFacet.ts

@@ -1,6 +1,6 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Perform a search query with `default`, will search for facet values if `facet` is given.
+ * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
  */
 export type SearchTypeFacet = 'facet';

package/model/searchUserIdsParams.ts

@@ -1,26 +1,26 @@
-// 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.
 
 /**
  * OK.
  */
 export type SearchUserIdsParams = {
   /**
-   * Query to search. The search is a prefix search with typoTolerance. Use empty query to retrieve all users.
+   * Query to search. The search is a prefix search with [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) enabled. An empty query will retrieve all users.
    */
   query: string;
 
   /**
-   * Name of the cluster.
+   * Cluster name.
    */
   clusterName?: string;
 
   /**
-   * Specify the page to retrieve.
+   * Page of search results to retrieve.
    */
   page?: number;
 
   /**
-   * Set the number of hits per page.
+   * Number of hits per page.
    */
   hitsPerPage?: number;
 };

package/model/searchUserIdsResponse.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 { UserHit } from './userHit';
 
@@ -7,27 +7,27 @@ import type { UserHit } from './userHit';
  */
 export type SearchUserIdsResponse = {
   /**
-   * List of user object matching the query.
+   * User objects that match the query.
    */
   hits: UserHit[];
 
   /**
-   * Number of hits that the search query matched.
+   * Number of results (hits).
    */
   nbHits: number;
 
   /**
-   * Specify the page to retrieve.
+   * Page of search results to retrieve.
    */
   page: number;
 
   /**
-   * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
+   * Maximum number of hits per page.
    */
   hitsPerPage: number;
 
   /**
-   * Date of last update (ISO-8601 format).
+   * Date and time when the object was updated, in RFC 3339 format.
    */
   updatedAt: string;
 };

package/model/securedAPIKeyRestrictions.ts

@@ -0,0 +1,32 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { SearchParamsObject } from './searchParamsObject';
+
+export type SecuredAPIKeyRestrictions = {
+  searchParams?: SearchParamsObject;
+
+  /**
+   * Filters that apply to every search made with the secured API key. Extra filters added at search time will be combined with `AND`. For example, if you set `group:admin` as fixed filter on your generated API key, and add `groups:visitors` to the search query, the complete set of filters will be `group:admin AND groups:visitors`.
+   */
+  filters?: string;
+
+  /**
+   * Timestamp when the secured API key expires, measured in seconds since the Unix epoch.
+   */
+  validUntil?: number;
+
+  /**
+   * Index names or patterns that this API key can access. By default, an API key can access all indices in the same application.  You can use leading and trailing wildcard characters (`*`):  - `dev_*` matches all indices starting with \"dev_\". - `*_dev` matches all indices ending with \"_dev\". - `*_products_*` matches all indices containing \"_products_\".
+   */
+  restrictIndices?: string[];
+
+  /**
+   * IP network that are allowed to use this key.  You can only add a single source, but you can provide a range of IP addresses. Use this to protect against API key leaking and reuse.
+   */
+  restrictSources?: string;
+
+  /**
+   * Pseudonymous user identifier to restrict usage of this API key to specific users.  By default, rate limits are set based on IP addresses. This can be an issue if many users search from the same IP address. To avoid this, add a user token to each generated API key.
+   */
+  userToken?: string;
+};

package/model/semanticSearch.ts

@@ -0,0 +1,11 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+/**
+ * Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`.
+ */
+export type SemanticSearch = {
+  /**
+   * Indices from which to collect click and conversion events.  If null, the current index and all its replicas are used.
+   */
+  eventSources?: string[] | null;
+};

package/model/snippetResult.ts

@@ -1,5 +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 { SnippetResultOption } from './snippetResultOption';
 
-export type SnippetResult = SnippetResultOption | SnippetResultOption[];
+export type SnippetResult =
+  | Record<string, SnippetResultOption>
+  | SnippetResultOption
+  | SnippetResultOption[];

package/model/snippetResultOption.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 { MatchLevel } from './matchLevel';
 
 /**
- * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+ * Snippets that show the context around a matching search query.
  */
 export type SnippetResultOption = {
   /**
-   * Markup text with occurrences highlighted.
+   * Highlighted attribute value, including HTML tags.
    */
   value: string;
 

package/model/sortRemainingBy.ts

@@ -1,6 +1,6 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * How to display the remaining items.   - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
+ * Order of facet values that aren\'t explicitly positioned with the `order` setting.  - `count`.   Order remaining facet values by decreasing count.   The count is the number of matching records containing this facet value.  - `alpha`.   Sort facet values alphabetically.  - `hidden`.   Don\'t show facet values that aren\'t explicitly positioned.
  */
 export type SortRemainingBy = 'alpha' | 'count' | 'hidden';

package/model/source.ts

@@ -1,16 +1,16 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * The source.
+ * Source.
  */
 export type Source = {
   /**
-   * The IP range of the source.
+   * IP address range of the source.
    */
   source: string;
 
   /**
-   * The description of the source.
+   * Source description.
    */
   description?: string;
 };

package/model/standardEntries.ts

@@ -1,21 +1,21 @@
-// 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.
 
 /**
- * Map of language ISO code supported by the dictionary (e.g., \"en\" for English) to a boolean value.
+ * Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and boolean values.
  */
 export type StandardEntries = {
   /**
-   * Language ISO code.
+   * Key-value pair of a language ISO code and a boolean value.
    */
   plurals?: Record<string, boolean> | null;
 
   /**
-   * Language ISO code.
+   * Key-value pair of a language ISO code and a boolean value.
    */
   stopwords?: Record<string, boolean> | null;
 
   /**
-   * Language ISO code.
+   * Key-value pair of a language ISO code and a boolean value.
    */
   compounds?: Record<string, boolean> | null;
 };