From 2400c4b1e22255c6d0380d4e5dbdf70dbe0e730f Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Thu, 19 Sep 2024 08:51:58 +0000 Subject: [PATCH] fix(specs): remove models from ingestion specs [skip-bc] (generated) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit https://github.com/algolia/api-clients-automation/pull/3774 Co-authored-by: algolia-bot Co-authored-by: Clément Vannicatte --- .../com/algolia/client/api/IngestionClient.kt | 42 --- .../GenerateTransformationCodePayload.kt | 22 -- .../GenerateTransformationCodeResponse.kt | 16 - .../algolia/client/model/ingestion/Model.kt | 28 -- .../model/ingestion/TransformationModels.kt | 16 - .../model/recommend/BoughtTogetherQuery.kt | 2 +- .../client/model/recommend/FacetOrdering.kt | 2 +- .../client/model/recommend/FallbackParams.kt | 106 +++++-- .../{Facets.kt => IndexSettingsFacets.kt} | 2 +- .../model/recommend/LookingSimilarQuery.kt | 2 +- .../algolia/client/model/recommend/Mode.kt | 19 -- ...archParams.kt => RecommendSearchParams.kt} | 110 ++++--- .../model/recommend/RecommendedForYouQuery.kt | 2 +- .../client/model/recommend/RelatedQuery.kt | 2 +- .../model/recommend/SearchParamsObject.kt | 300 ------------------ .../client/model/recommend/SemanticSearch.kt | 17 - .../model/recommend/TrendingFacetsQuery.kt | 2 +- .../model/recommend/TrendingItemsQuery.kt | 4 +- 18 files changed, 155 insertions(+), 539 deletions(-) delete mode 100644 client/src/commonMain/kotlin/com/algolia/client/model/ingestion/GenerateTransformationCodePayload.kt delete mode 100644 client/src/commonMain/kotlin/com/algolia/client/model/ingestion/GenerateTransformationCodeResponse.kt delete mode 100644 client/src/commonMain/kotlin/com/algolia/client/model/ingestion/Model.kt delete mode 100644 client/src/commonMain/kotlin/com/algolia/client/model/ingestion/TransformationModels.kt rename client/src/commonMain/kotlin/com/algolia/client/model/recommend/{Facets.kt => IndexSettingsFacets.kt} (94%) delete mode 100644 client/src/commonMain/kotlin/com/algolia/client/model/recommend/Mode.kt rename client/src/commonMain/kotlin/com/algolia/client/model/recommend/{SearchParams.kt => RecommendSearchParams.kt} (71%) delete mode 100644 client/src/commonMain/kotlin/com/algolia/client/model/recommend/SearchParamsObject.kt delete mode 100644 client/src/commonMain/kotlin/com/algolia/client/model/recommend/SemanticSearch.kt diff --git a/client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt b/client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt index 80040f1a..070001f2 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt @@ -438,28 +438,6 @@ public class IngestionClient( ) } - /** - * Generates code for the selected model based on the given prompt. - * - * Required API Key ACLs: - * - addObject - * - deleteIndex - * - editSettings - * @param generateTransformationCodePayload - * @param requestOptions additional request configuration. - */ - public suspend fun generateTransformationCode(generateTransformationCodePayload: GenerateTransformationCodePayload, requestOptions: RequestOptions? = null): GenerateTransformationCodeResponse { - val requestConfig = RequestConfig( - method = RequestMethod.POST, - path = listOf("1", "transformations", "models"), - body = generateTransformationCodePayload, - ) - return requester.execute( - requestConfig = requestConfig, - requestOptions = requestOptions, - ) - } - /** * Retrieves an authentication resource by its ID. * @@ -900,26 +878,6 @@ public class IngestionClient( ) } - /** - * Retrieves a list of existing LLM transformation helpers. - * - * Required API Key ACLs: - * - addObject - * - deleteIndex - * - editSettings - * @param requestOptions additional request configuration. - */ - public suspend fun listTransformationModels(requestOptions: RequestOptions? = null): TransformationModels { - val requestConfig = RequestConfig( - method = RequestMethod.GET, - path = listOf("1", "transformations", "models"), - ) - return requester.execute( - requestConfig = requestConfig, - requestOptions = requestOptions, - ) - } - /** * Retrieves a list of transformations. * diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/GenerateTransformationCodePayload.kt b/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/GenerateTransformationCodePayload.kt deleted file mode 100644 index 455f4070..00000000 --- a/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/GenerateTransformationCodePayload.kt +++ /dev/null @@ -1,22 +0,0 @@ -/** 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. */ -package com.algolia.client.model.ingestion - -import kotlinx.serialization.* -import kotlinx.serialization.json.* - -/** - * GenerateTransformationCodePayload - * - * @param id - * @param userPrompt - * @param systemPrompt - */ -@Serializable -public data class GenerateTransformationCodePayload( - - @SerialName(value = "id") val id: String, - - @SerialName(value = "userPrompt") val userPrompt: String, - - @SerialName(value = "systemPrompt") val systemPrompt: String? = null, -) diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/GenerateTransformationCodeResponse.kt b/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/GenerateTransformationCodeResponse.kt deleted file mode 100644 index 770c7161..00000000 --- a/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/GenerateTransformationCodeResponse.kt +++ /dev/null @@ -1,16 +0,0 @@ -/** 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. */ -package com.algolia.client.model.ingestion - -import kotlinx.serialization.* -import kotlinx.serialization.json.* - -/** - * GenerateTransformationCodeResponse - * - * @param generatedCode - */ -@Serializable -public data class GenerateTransformationCodeResponse( - - @SerialName(value = "generatedCode") val generatedCode: String? = null, -) diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/Model.kt b/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/Model.kt deleted file mode 100644 index 09d6479a..00000000 --- a/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/Model.kt +++ /dev/null @@ -1,28 +0,0 @@ -/** 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. */ -package com.algolia.client.model.ingestion - -import kotlinx.serialization.* -import kotlinx.serialization.json.* - -/** - * Model - * - * @param fullname - * @param modelName - * @param systemPrompt - * @param id - * @param provider - */ -@Serializable -public data class Model( - - @SerialName(value = "fullname") val fullname: String, - - @SerialName(value = "modelName") val modelName: String, - - @SerialName(value = "systemPrompt") val systemPrompt: String, - - @SerialName(value = "id") val id: String, - - @SerialName(value = "provider") val provider: String, -) diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/TransformationModels.kt b/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/TransformationModels.kt deleted file mode 100644 index 667d18c5..00000000 --- a/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/TransformationModels.kt +++ /dev/null @@ -1,16 +0,0 @@ -/** 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. */ -package com.algolia.client.model.ingestion - -import kotlinx.serialization.* -import kotlinx.serialization.json.* - -/** - * List of available AI models for transformation purposes. - * - * @param llms - */ -@Serializable -public data class TransformationModels( - - @SerialName(value = "llms") val llms: List, -) diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/BoughtTogetherQuery.kt b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/BoughtTogetherQuery.kt index beb42ae4..f30f115d 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/BoughtTogetherQuery.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/BoughtTogetherQuery.kt @@ -31,5 +31,5 @@ public data class BoughtTogetherQuery( /** Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value. */ @SerialName(value = "maxRecommendations") val maxRecommendations: Int? = null, - @SerialName(value = "queryParameters") val queryParameters: SearchParams? = null, + @SerialName(value = "queryParameters") val queryParameters: RecommendSearchParams? = null, ) : RecommendationsRequest diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/FacetOrdering.kt b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/FacetOrdering.kt index 5de26fec..c32442ce 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/FacetOrdering.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/FacetOrdering.kt @@ -13,7 +13,7 @@ import kotlinx.serialization.json.* @Serializable public data class FacetOrdering( - @SerialName(value = "facets") val facets: Facets? = null, + @SerialName(value = "facets") val facets: IndexSettingsFacets? = null, /** Order of facet values. One object for each facet. */ @SerialName(value = "values") val values: Map? = null, diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/FallbackParams.kt b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/FallbackParams.kt index 035848f9..99f1088b 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/FallbackParams.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/FallbackParams.kt @@ -7,7 +7,6 @@ import kotlinx.serialization.json.* /** * FallbackParams * - * @param query Search query. * @param similarQuery Keywords to be used instead of the search query to conduct a more broader search. Using the `similarQuery` parameter changes other settings: - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords`. Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results. * @param filters Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** ` `, where `` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `: TO ` where `` and `` are the lower and upper limits of the range (inclusive). - **Facet filters.** `:` where `` is a facet attribute (case-sensitive) and `` a facet value. - **Tag filters.** `_tags:` or just `` (case-sensitive). - **Boolean filters.** `: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/). * @param facetFilters @@ -18,9 +17,6 @@ import kotlinx.serialization.json.* * @param restrictSearchableAttributes Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive. * @param facets Facets for which to retrieve facet values that match the search criteria and the number of matching facet values. To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts). * @param facetingAfterDistinct Whether faceting should be applied after deduplication with `distinct`. This leads to accurate facet counts when using faceting in combination with `distinct`. It's usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`. - * @param page Page of search results to retrieve. - * @param offset Position of the first hit to retrieve. - * @param length Number of hits to retrieve (used in combination with `offset`). * @param aroundLatLng Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`. * @param aroundLatLngViaIP Whether to obtain the coordinates from the request's IP address. * @param aroundRadius @@ -39,9 +35,26 @@ import kotlinx.serialization.json.* * @param analyticsTags Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). * @param percentileComputation Whether to include this search when calculating processing-time percentiles. * @param enableABTest Whether to enable A/B testing for this search. + * @param query Search query. + * @param attributesForFaceting Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/). Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows using this attribute as a filter, but doesn't evalue the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching for facet values. - `afterDistinct(\"ATTRIBUTE\")`. Evaluates the facet count _after_ deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`. + * @param replicas Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/). Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you'll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer by synced with the primary index. **Modifier** - `virtual(\"REPLICA\")`. Create a virtual replica, Virtual replicas don't increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/). + * @param paginationLimitedTo Maximum number of search results that can be obtained through pagination. Higher pagination limits might slow down your search. For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can't be guaranteed. + * @param unretrievableAttributes Attributes that can't be retrieved at query time. This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/), but don't want to include it in the search results. Attribute names are case-sensitive. + * @param disableTypoToleranceOnWords Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. + * @param attributesToTransliterate Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead). Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive. + * @param camelCaseAttributes Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive. + * @param decompoundedAttributes Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding). Attribute names are case-sensitive. Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`). Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308). + * @param indexLanguages Languages for language-specific processing steps, such as word detection and dictionary settings. **You should always specify an indexing language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/). + * @param disablePrefixOnAttributes Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). Attribute names are case-sensitive. + * @param allowCompressionOfIntegerArray Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered. + * @param numericAttributesForFiltering Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). Attribute names are case-sensitive. By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes. If you want to turn off filtering for all numeric attributes, specifiy an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`. + * @param separatorsToIndex Controls which separators are indexed. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches. + * @param searchableAttributes Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered. For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/). **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute. Without modifier, matches at the beginning of an attribute rank higer than matches at the end. + * @param userData An object with custom data. You can store up to 32kB as custom data. + * @param customNormalization Characters and their normalized replacements. This overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/). + * @param attributeForDistinct Attribute that should be used to establish groups of results. Attribute names are case-sensitive. All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results. If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting _after_ deduplication, which will result in accurate facet counts. * @param attributesToRetrieve Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive. - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included. * @param ranking Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/). - * @param customRanking Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied. * @param relevancyStrictness Relevancy threshold below which less relevant results aren't included in the results. You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results. * @param attributesToHighlight Attributes to highlight. By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive. With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI. For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/). * @param attributesToSnippet Attributes for which to enable snippets. Attribute names are case-sensitive. Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted. @@ -49,7 +62,6 @@ import kotlinx.serialization.json.* * @param highlightPostTag HTML tag to insert after the highlighted parts in all highlighted results and snippets. * @param snippetEllipsisText String used as an ellipsis indicator when a snippet is truncated. * @param restrictHighlightAndSnippetArrays Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted. - * @param hitsPerPage Number of hits per page. * @param minWordSizefor1Typo Minimum number of characters a word in the search query 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). * @param minWordSizefor2Typos Minimum number of characters a word in the search query 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). * @param typoTolerance @@ -57,15 +69,12 @@ import kotlinx.serialization.json.* * @param disableTypoToleranceOnAttributes Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive. Returning only exact matches can help when: - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/). - Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions. Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos. * @param ignorePlurals * @param removeStopWords - * @param keepDiacriticsOnCharacters Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics. * @param queryLanguages Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [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) languages. To support this, you must place the CJK language **first**. **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/). * @param decompoundQuery Whether to split compound words in the query into their building blocks. For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308). * @param enableRules Whether to enable rules. * @param enablePersonalization Whether to enable Personalization. * @param queryType * @param removeWordsIfNoResults - * @param mode - * @param semanticSearch * @param advancedSyntax Whether to support phrase matching and excluding words from search queries. Use the `advancedSyntaxFeatures` parameter to control which feature is supported. * @param optionalWords Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words dividied by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words). * @param disableExactOnAttributes Searchable 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). Attribute names are case-sensitive. This can be useful for attributes with long values, where the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking. @@ -87,9 +96,6 @@ import kotlinx.serialization.json.* @Serializable public data class FallbackParams( - /** Search query. */ - @SerialName(value = "query") val query: String? = null, - /** Keywords to be used instead of the search query to conduct a more broader search. Using the `similarQuery` parameter changes other settings: - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords`. Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results. */ @SerialName(value = "similarQuery") val similarQuery: String? = null, @@ -116,15 +122,6 @@ public data class FallbackParams( /** Whether faceting should be applied after deduplication with `distinct`. This leads to accurate facet counts when using faceting in combination with `distinct`. It's usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`. */ @SerialName(value = "facetingAfterDistinct") val facetingAfterDistinct: Boolean? = null, - /** Page of search results to retrieve. */ - @SerialName(value = "page") val page: Int? = null, - - /** Position of the first hit to retrieve. */ - @SerialName(value = "offset") val offset: Int? = null, - - /** Number of hits to retrieve (used in combination with `offset`). */ - @SerialName(value = "length") val length: Int? = null, - /** Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`. */ @SerialName(value = "aroundLatLng") val aroundLatLng: String? = null, @@ -177,15 +174,66 @@ public data class FallbackParams( /** Whether to enable A/B testing for this search. */ @SerialName(value = "enableABTest") val enableABTest: Boolean? = null, + /** Search query. */ + @SerialName(value = "query") val query: String? = null, + + /** Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/). Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows using this attribute as a filter, but doesn't evalue the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching for facet values. - `afterDistinct(\"ATTRIBUTE\")`. Evaluates the facet count _after_ deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`. */ + @SerialName(value = "attributesForFaceting") val attributesForFaceting: List? = null, + + /** Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/). Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you'll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer by synced with the primary index. **Modifier** - `virtual(\"REPLICA\")`. Create a virtual replica, Virtual replicas don't increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/). */ + @SerialName(value = "replicas") val replicas: List? = null, + + /** Maximum number of search results that can be obtained through pagination. Higher pagination limits might slow down your search. For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can't be guaranteed. */ + @SerialName(value = "paginationLimitedTo") val paginationLimitedTo: Int? = null, + + /** Attributes that can't be retrieved at query time. This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/), but don't want to include it in the search results. Attribute names are case-sensitive. */ + @SerialName(value = "unretrievableAttributes") val unretrievableAttributes: List? = null, + + /** Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. */ + @SerialName(value = "disableTypoToleranceOnWords") val disableTypoToleranceOnWords: List? = null, + + /** Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead). Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive. */ + @SerialName(value = "attributesToTransliterate") val attributesToTransliterate: List? = null, + + /** Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive. */ + @SerialName(value = "camelCaseAttributes") val camelCaseAttributes: List? = null, + + /** Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding). Attribute names are case-sensitive. Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`). Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308). */ + @SerialName(value = "decompoundedAttributes") val decompoundedAttributes: JsonObject? = null, + + /** Languages for language-specific processing steps, such as word detection and dictionary settings. **You should always specify an indexing language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/). */ + @SerialName(value = "indexLanguages") val indexLanguages: List? = null, + + /** Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). Attribute names are case-sensitive. */ + @SerialName(value = "disablePrefixOnAttributes") val disablePrefixOnAttributes: List? = null, + + /** Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered. */ + @SerialName(value = "allowCompressionOfIntegerArray") val allowCompressionOfIntegerArray: Boolean? = null, + + /** Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). Attribute names are case-sensitive. By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes. If you want to turn off filtering for all numeric attributes, specifiy an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`. */ + @SerialName(value = "numericAttributesForFiltering") val numericAttributesForFiltering: List? = null, + + /** Controls which separators are indexed. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches. */ + @SerialName(value = "separatorsToIndex") val separatorsToIndex: String? = null, + + /** Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered. For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/). **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute. Without modifier, matches at the beginning of an attribute rank higer than matches at the end. */ + @SerialName(value = "searchableAttributes") val searchableAttributes: List? = null, + + /** An object with custom data. You can store up to 32kB as custom data. */ + @SerialName(value = "userData") val userData: JsonObject? = null, + + /** Characters and their normalized replacements. This overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/). */ + @SerialName(value = "customNormalization") val customNormalization: Map>? = null, + + /** Attribute that should be used to establish groups of results. Attribute names are case-sensitive. All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results. If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting _after_ deduplication, which will result in accurate facet counts. */ + @SerialName(value = "attributeForDistinct") val attributeForDistinct: String? = null, + /** Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive. - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included. */ @SerialName(value = "attributesToRetrieve") val attributesToRetrieve: List? = null, /** Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/). */ @SerialName(value = "ranking") val ranking: List? = null, - /** Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied. */ - @SerialName(value = "customRanking") val customRanking: List? = null, - /** Relevancy threshold below which less relevant results aren't included in the results. You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results. */ @SerialName(value = "relevancyStrictness") val relevancyStrictness: Int? = null, @@ -207,9 +255,6 @@ public data class FallbackParams( /** Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted. */ @SerialName(value = "restrictHighlightAndSnippetArrays") val restrictHighlightAndSnippetArrays: Boolean? = null, - /** Number of hits per page. */ - @SerialName(value = "hitsPerPage") val hitsPerPage: Int? = null, - /** Minimum number of characters a word in the search query 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). */ @SerialName(value = "minWordSizefor1Typo") val minWordSizefor1Typo: Int? = null, @@ -228,9 +273,6 @@ public data class FallbackParams( @SerialName(value = "removeStopWords") val removeStopWords: RemoveStopWords? = null, - /** Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics. */ - @SerialName(value = "keepDiacriticsOnCharacters") val keepDiacriticsOnCharacters: String? = null, - /** Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [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) languages. To support this, you must place the CJK language **first**. **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/). */ @SerialName(value = "queryLanguages") val queryLanguages: List? = null, @@ -247,10 +289,6 @@ public data class FallbackParams( @SerialName(value = "removeWordsIfNoResults") val removeWordsIfNoResults: RemoveWordsIfNoResults? = null, - @SerialName(value = "mode") val mode: Mode? = null, - - @SerialName(value = "semanticSearch") val semanticSearch: SemanticSearch? = null, - /** Whether to support phrase matching and excluding words from search queries. Use the `advancedSyntaxFeatures` parameter to control which feature is supported. */ @SerialName(value = "advancedSyntax") val advancedSyntax: Boolean? = null, diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/Facets.kt b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/IndexSettingsFacets.kt similarity index 94% rename from client/src/commonMain/kotlin/com/algolia/client/model/recommend/Facets.kt rename to client/src/commonMain/kotlin/com/algolia/client/model/recommend/IndexSettingsFacets.kt index 64a7598d..4162c428 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/Facets.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/IndexSettingsFacets.kt @@ -10,7 +10,7 @@ import kotlinx.serialization.json.* * @param order Explicit order of facets or facet values. This setting lets you always show specific facets or facet values at the top of the list. */ @Serializable -public data class Facets( +public data class IndexSettingsFacets( /** Explicit order of facets or facet values. This setting lets you always show specific facets or facet values at the top of the list. */ @SerialName(value = "order") val order: List? = null, diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/LookingSimilarQuery.kt b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/LookingSimilarQuery.kt index 004e13d6..c7c62757 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/LookingSimilarQuery.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/LookingSimilarQuery.kt @@ -32,7 +32,7 @@ public data class LookingSimilarQuery( /** Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value. */ @SerialName(value = "maxRecommendations") val maxRecommendations: Int? = null, - @SerialName(value = "queryParameters") val queryParameters: SearchParams? = null, + @SerialName(value = "queryParameters") val queryParameters: RecommendSearchParams? = null, @SerialName(value = "fallbackParameters") val fallbackParameters: FallbackParams? = null, ) : RecommendationsRequest diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/Mode.kt b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/Mode.kt deleted file mode 100644 index f56842d2..00000000 --- a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/Mode.kt +++ /dev/null @@ -1,19 +0,0 @@ -/** 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. */ -package com.algolia.client.model.recommend - -import kotlinx.serialization.* - -/** - * Search mode the index will use to query for results. This setting only applies to indices, for which Algolia enabled NeuralSearch for you. - */ -@Serializable -public enum class Mode(public val value: kotlin.String) { - - @SerialName(value = "neuralSearch") - NeuralSearch("neuralSearch"), - - @SerialName(value = "keywordSearch") - KeywordSearch("keywordSearch"); - - override fun toString(): kotlin.String = value -} diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/SearchParams.kt b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/RecommendSearchParams.kt similarity index 71% rename from client/src/commonMain/kotlin/com/algolia/client/model/recommend/SearchParams.kt rename to client/src/commonMain/kotlin/com/algolia/client/model/recommend/RecommendSearchParams.kt index d084c873..3e11baa2 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/SearchParams.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/RecommendSearchParams.kt @@ -5,9 +5,8 @@ import kotlinx.serialization.* import kotlinx.serialization.json.* /** - * SearchParams + * Search parameters for filtering the recommendations. * - * @param query Search query. * @param similarQuery Keywords to be used instead of the search query to conduct a more broader search. Using the `similarQuery` parameter changes other settings: - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords`. Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results. * @param filters Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** ` `, where `` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `: TO ` where `` and `` are the lower and upper limits of the range (inclusive). - **Facet filters.** `:` where `` is a facet attribute (case-sensitive) and `` a facet value. - **Tag filters.** `_tags:` or just `` (case-sensitive). - **Boolean filters.** `: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/). * @param facetFilters @@ -18,9 +17,6 @@ import kotlinx.serialization.json.* * @param restrictSearchableAttributes Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive. * @param facets Facets for which to retrieve facet values that match the search criteria and the number of matching facet values. To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts). * @param facetingAfterDistinct Whether faceting should be applied after deduplication with `distinct`. This leads to accurate facet counts when using faceting in combination with `distinct`. It's usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`. - * @param page Page of search results to retrieve. - * @param offset Position of the first hit to retrieve. - * @param length Number of hits to retrieve (used in combination with `offset`). * @param aroundLatLng Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`. * @param aroundLatLngViaIP Whether to obtain the coordinates from the request's IP address. * @param aroundRadius @@ -39,9 +35,26 @@ import kotlinx.serialization.json.* * @param analyticsTags Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). * @param percentileComputation Whether to include this search when calculating processing-time percentiles. * @param enableABTest Whether to enable A/B testing for this search. + * @param query Search query. + * @param attributesForFaceting Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/). Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows using this attribute as a filter, but doesn't evalue the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching for facet values. - `afterDistinct(\"ATTRIBUTE\")`. Evaluates the facet count _after_ deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`. + * @param replicas Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/). Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you'll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer by synced with the primary index. **Modifier** - `virtual(\"REPLICA\")`. Create a virtual replica, Virtual replicas don't increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/). + * @param paginationLimitedTo Maximum number of search results that can be obtained through pagination. Higher pagination limits might slow down your search. For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can't be guaranteed. + * @param unretrievableAttributes Attributes that can't be retrieved at query time. This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/), but don't want to include it in the search results. Attribute names are case-sensitive. + * @param disableTypoToleranceOnWords Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. + * @param attributesToTransliterate Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead). Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive. + * @param camelCaseAttributes Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive. + * @param decompoundedAttributes Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding). Attribute names are case-sensitive. Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`). Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308). + * @param indexLanguages Languages for language-specific processing steps, such as word detection and dictionary settings. **You should always specify an indexing language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/). + * @param disablePrefixOnAttributes Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). Attribute names are case-sensitive. + * @param allowCompressionOfIntegerArray Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered. + * @param numericAttributesForFiltering Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). Attribute names are case-sensitive. By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes. If you want to turn off filtering for all numeric attributes, specifiy an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`. + * @param separatorsToIndex Controls which separators are indexed. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches. + * @param searchableAttributes Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered. For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/). **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute. Without modifier, matches at the beginning of an attribute rank higer than matches at the end. + * @param userData An object with custom data. You can store up to 32kB as custom data. + * @param customNormalization Characters and their normalized replacements. This overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/). + * @param attributeForDistinct Attribute that should be used to establish groups of results. Attribute names are case-sensitive. All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results. If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting _after_ deduplication, which will result in accurate facet counts. * @param attributesToRetrieve Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive. - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included. * @param ranking Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/). - * @param customRanking Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied. * @param relevancyStrictness Relevancy threshold below which less relevant results aren't included in the results. You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results. * @param attributesToHighlight Attributes to highlight. By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive. With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI. For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/). * @param attributesToSnippet Attributes for which to enable snippets. Attribute names are case-sensitive. Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted. @@ -49,7 +62,6 @@ import kotlinx.serialization.json.* * @param highlightPostTag HTML tag to insert after the highlighted parts in all highlighted results and snippets. * @param snippetEllipsisText String used as an ellipsis indicator when a snippet is truncated. * @param restrictHighlightAndSnippetArrays Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted. - * @param hitsPerPage Number of hits per page. * @param minWordSizefor1Typo Minimum number of characters a word in the search query 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). * @param minWordSizefor2Typos Minimum number of characters a word in the search query 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). * @param typoTolerance @@ -57,15 +69,12 @@ import kotlinx.serialization.json.* * @param disableTypoToleranceOnAttributes Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive. Returning only exact matches can help when: - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/). - Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions. Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos. * @param ignorePlurals * @param removeStopWords - * @param keepDiacriticsOnCharacters Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics. * @param queryLanguages Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [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) languages. To support this, you must place the CJK language **first**. **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/). * @param decompoundQuery Whether to split compound words in the query into their building blocks. For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308). * @param enableRules Whether to enable rules. * @param enablePersonalization Whether to enable Personalization. * @param queryType * @param removeWordsIfNoResults - * @param mode - * @param semanticSearch * @param advancedSyntax Whether to support phrase matching and excluding words from search queries. Use the `advancedSyntaxFeatures` parameter to control which feature is supported. * @param optionalWords Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words dividied by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words). * @param disableExactOnAttributes Searchable 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). Attribute names are case-sensitive. This can be useful for attributes with long values, where the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking. @@ -85,10 +94,7 @@ import kotlinx.serialization.json.* * @param reRankingApplyFilter */ @Serializable -public data class SearchParams( - - /** Search query. */ - @SerialName(value = "query") val query: String? = null, +public data class RecommendSearchParams( /** Keywords to be used instead of the search query to conduct a more broader search. Using the `similarQuery` parameter changes other settings: - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords`. Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results. */ @SerialName(value = "similarQuery") val similarQuery: String? = null, @@ -116,15 +122,6 @@ public data class SearchParams( /** Whether faceting should be applied after deduplication with `distinct`. This leads to accurate facet counts when using faceting in combination with `distinct`. It's usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`. */ @SerialName(value = "facetingAfterDistinct") val facetingAfterDistinct: Boolean? = null, - /** Page of search results to retrieve. */ - @SerialName(value = "page") val page: Int? = null, - - /** Position of the first hit to retrieve. */ - @SerialName(value = "offset") val offset: Int? = null, - - /** Number of hits to retrieve (used in combination with `offset`). */ - @SerialName(value = "length") val length: Int? = null, - /** Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`. */ @SerialName(value = "aroundLatLng") val aroundLatLng: String? = null, @@ -177,15 +174,66 @@ public data class SearchParams( /** Whether to enable A/B testing for this search. */ @SerialName(value = "enableABTest") val enableABTest: Boolean? = null, + /** Search query. */ + @SerialName(value = "query") val query: String? = null, + + /** Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/). Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows using this attribute as a filter, but doesn't evalue the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching for facet values. - `afterDistinct(\"ATTRIBUTE\")`. Evaluates the facet count _after_ deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`. */ + @SerialName(value = "attributesForFaceting") val attributesForFaceting: List? = null, + + /** Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/). Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you'll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer by synced with the primary index. **Modifier** - `virtual(\"REPLICA\")`. Create a virtual replica, Virtual replicas don't increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/). */ + @SerialName(value = "replicas") val replicas: List? = null, + + /** Maximum number of search results that can be obtained through pagination. Higher pagination limits might slow down your search. For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can't be guaranteed. */ + @SerialName(value = "paginationLimitedTo") val paginationLimitedTo: Int? = null, + + /** Attributes that can't be retrieved at query time. This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/), but don't want to include it in the search results. Attribute names are case-sensitive. */ + @SerialName(value = "unretrievableAttributes") val unretrievableAttributes: List? = null, + + /** Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. */ + @SerialName(value = "disableTypoToleranceOnWords") val disableTypoToleranceOnWords: List? = null, + + /** Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead). Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive. */ + @SerialName(value = "attributesToTransliterate") val attributesToTransliterate: List? = null, + + /** Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive. */ + @SerialName(value = "camelCaseAttributes") val camelCaseAttributes: List? = null, + + /** Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding). Attribute names are case-sensitive. Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`). Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308). */ + @SerialName(value = "decompoundedAttributes") val decompoundedAttributes: JsonObject? = null, + + /** Languages for language-specific processing steps, such as word detection and dictionary settings. **You should always specify an indexing language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/). */ + @SerialName(value = "indexLanguages") val indexLanguages: List? = null, + + /** Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). Attribute names are case-sensitive. */ + @SerialName(value = "disablePrefixOnAttributes") val disablePrefixOnAttributes: List? = null, + + /** Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered. */ + @SerialName(value = "allowCompressionOfIntegerArray") val allowCompressionOfIntegerArray: Boolean? = null, + + /** Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). Attribute names are case-sensitive. By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes. If you want to turn off filtering for all numeric attributes, specifiy an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`. */ + @SerialName(value = "numericAttributesForFiltering") val numericAttributesForFiltering: List? = null, + + /** Controls which separators are indexed. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches. */ + @SerialName(value = "separatorsToIndex") val separatorsToIndex: String? = null, + + /** Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered. For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/). **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute. Without modifier, matches at the beginning of an attribute rank higer than matches at the end. */ + @SerialName(value = "searchableAttributes") val searchableAttributes: List? = null, + + /** An object with custom data. You can store up to 32kB as custom data. */ + @SerialName(value = "userData") val userData: JsonObject? = null, + + /** Characters and their normalized replacements. This overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/). */ + @SerialName(value = "customNormalization") val customNormalization: Map>? = null, + + /** Attribute that should be used to establish groups of results. Attribute names are case-sensitive. All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results. If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting _after_ deduplication, which will result in accurate facet counts. */ + @SerialName(value = "attributeForDistinct") val attributeForDistinct: String? = null, + /** Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive. - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included. */ @SerialName(value = "attributesToRetrieve") val attributesToRetrieve: List? = null, /** Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/). */ @SerialName(value = "ranking") val ranking: List? = null, - /** Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied. */ - @SerialName(value = "customRanking") val customRanking: List? = null, - /** Relevancy threshold below which less relevant results aren't included in the results. You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results. */ @SerialName(value = "relevancyStrictness") val relevancyStrictness: Int? = null, @@ -207,9 +255,6 @@ public data class SearchParams( /** Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted. */ @SerialName(value = "restrictHighlightAndSnippetArrays") val restrictHighlightAndSnippetArrays: Boolean? = null, - /** Number of hits per page. */ - @SerialName(value = "hitsPerPage") val hitsPerPage: Int? = null, - /** Minimum number of characters a word in the search query 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). */ @SerialName(value = "minWordSizefor1Typo") val minWordSizefor1Typo: Int? = null, @@ -228,9 +273,6 @@ public data class SearchParams( @SerialName(value = "removeStopWords") val removeStopWords: RemoveStopWords? = null, - /** Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics. */ - @SerialName(value = "keepDiacriticsOnCharacters") val keepDiacriticsOnCharacters: String? = null, - /** Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [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) languages. To support this, you must place the CJK language **first**. **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/). */ @SerialName(value = "queryLanguages") val queryLanguages: List? = null, @@ -247,10 +289,6 @@ public data class SearchParams( @SerialName(value = "removeWordsIfNoResults") val removeWordsIfNoResults: RemoveWordsIfNoResults? = null, - @SerialName(value = "mode") val mode: Mode? = null, - - @SerialName(value = "semanticSearch") val semanticSearch: SemanticSearch? = null, - /** Whether to support phrase matching and excluding words from search queries. Use the `advancedSyntaxFeatures` parameter to control which feature is supported. */ @SerialName(value = "advancedSyntax") val advancedSyntax: Boolean? = null, diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/RecommendedForYouQuery.kt b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/RecommendedForYouQuery.kt index a7efadd1..6041dc9e 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/RecommendedForYouQuery.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/RecommendedForYouQuery.kt @@ -28,7 +28,7 @@ public data class RecommendedForYouQuery( /** Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value. */ @SerialName(value = "maxRecommendations") val maxRecommendations: Int? = null, - @SerialName(value = "queryParameters") val queryParameters: SearchParams? = null, + @SerialName(value = "queryParameters") val queryParameters: RecommendSearchParams? = null, @SerialName(value = "fallbackParameters") val fallbackParameters: FallbackParams? = null, ) : RecommendationsRequest diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/RelatedQuery.kt b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/RelatedQuery.kt index 217d90c8..41017908 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/RelatedQuery.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/RelatedQuery.kt @@ -32,7 +32,7 @@ public data class RelatedQuery( /** Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value. */ @SerialName(value = "maxRecommendations") val maxRecommendations: Int? = null, - @SerialName(value = "queryParameters") val queryParameters: SearchParams? = null, + @SerialName(value = "queryParameters") val queryParameters: RecommendSearchParams? = null, @SerialName(value = "fallbackParameters") val fallbackParameters: FallbackParams? = null, ) : RecommendationsRequest diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/SearchParamsObject.kt b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/SearchParamsObject.kt deleted file mode 100644 index 4d4aa240..00000000 --- a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/SearchParamsObject.kt +++ /dev/null @@ -1,300 +0,0 @@ -/** 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. */ -package com.algolia.client.model.recommend - -import kotlinx.serialization.* -import kotlinx.serialization.json.* - -/** - * Each parameter value, including the `query` must not be larger than 512 bytes. - * - * @param query Search query. - * @param similarQuery Keywords to be used instead of the search query to conduct a more broader search. Using the `similarQuery` parameter changes other settings: - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords`. Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results. - * @param filters Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** ` `, where `` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `: TO ` where `` and `` are the lower and upper limits of the range (inclusive). - **Facet filters.** `:` where `` is a facet attribute (case-sensitive) and `` a facet value. - **Tag filters.** `_tags:` or just `` (case-sensitive). - **Boolean filters.** `: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/). - * @param facetFilters - * @param optionalFilters - * @param numericFilters - * @param tagFilters - * @param sumOrFiltersScores Whether to sum all filter scores. If true, all filter scores are summed. Otherwise, the maximum filter score is kept. For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores). - * @param restrictSearchableAttributes Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive. - * @param facets Facets for which to retrieve facet values that match the search criteria and the number of matching facet values. To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts). - * @param facetingAfterDistinct Whether faceting should be applied after deduplication with `distinct`. This leads to accurate facet counts when using faceting in combination with `distinct`. It's usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`. - * @param page Page of search results to retrieve. - * @param offset Position of the first hit to retrieve. - * @param length Number of hits to retrieve (used in combination with `offset`). - * @param aroundLatLng Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`. - * @param aroundLatLngViaIP Whether to obtain the coordinates from the request's IP address. - * @param aroundRadius - * @param aroundPrecision - * @param minimumAroundRadius Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set. - * @param insideBoundingBox Coordinates for a rectangular area in which to search. Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). - * @param insidePolygon Coordinates of a polygon in which to search. Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`. - * @param naturalLanguages ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches): - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`. - * @param ruleContexts Assigns a rule context to the search query. [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules. - * @param personalizationImpact Impact that Personalization should have on this search. The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact). - * @param userToken Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). - * @param getRankingInfo Whether the search response should include detailed ranking information. - * @param synonyms Whether to take into account an index's synonyms for this search. - * @param clickAnalytics Whether to include a `queryID` attribute in the response. The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/). - * @param analytics Whether this search will be included in Analytics. - * @param analyticsTags Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). - * @param percentileComputation Whether to include this search when calculating processing-time percentiles. - * @param enableABTest Whether to enable A/B testing for this search. - * @param attributesToRetrieve Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive. - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included. - * @param ranking Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/). - * @param customRanking Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied. - * @param relevancyStrictness Relevancy threshold below which less relevant results aren't included in the results. You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results. - * @param attributesToHighlight Attributes to highlight. By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive. With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI. For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/). - * @param attributesToSnippet Attributes for which to enable snippets. Attribute names are case-sensitive. Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted. - * @param highlightPreTag HTML tag to insert before the highlighted parts in all highlighted results and snippets. - * @param highlightPostTag HTML tag to insert after the highlighted parts in all highlighted results and snippets. - * @param snippetEllipsisText String used as an ellipsis indicator when a snippet is truncated. - * @param restrictHighlightAndSnippetArrays Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted. - * @param hitsPerPage Number of hits per page. - * @param minWordSizefor1Typo Minimum number of characters a word in the search query 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). - * @param minWordSizefor2Typos Minimum number of characters a word in the search query 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). - * @param typoTolerance - * @param allowTyposOnNumericTokens Whether to allow typos on numbers in the search query. Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers. - * @param disableTypoToleranceOnAttributes Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive. Returning only exact matches can help when: - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/). - Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions. Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos. - * @param ignorePlurals - * @param removeStopWords - * @param keepDiacriticsOnCharacters Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics. - * @param queryLanguages Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [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) languages. To support this, you must place the CJK language **first**. **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/). - * @param decompoundQuery Whether to split compound words in the query into their building blocks. For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308). - * @param enableRules Whether to enable rules. - * @param enablePersonalization Whether to enable Personalization. - * @param queryType - * @param removeWordsIfNoResults - * @param mode - * @param semanticSearch - * @param advancedSyntax Whether to support phrase matching and excluding words from search queries. Use the `advancedSyntaxFeatures` parameter to control which feature is supported. - * @param optionalWords Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words dividied by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words). - * @param disableExactOnAttributes Searchable 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). Attribute names are case-sensitive. This can be useful for attributes with long values, where the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking. - * @param exactOnSingleWordQuery - * @param alternativesAsExact Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches. - * @param advancedSyntaxFeatures Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". - `excludeWords`. Query words prefixed with a `-` must not occur in a record. For example, `search -engine` matches records that contain \"search\" but not \"engine\". This setting only has an effect if `advancedSyntax` is true. - * @param distinct - * @param replaceSynonymsInHighlight Whether to replace a highlighted word with the matched synonym. By default, the original words are highlighted even if a synonym matches. For example, with `home` as a synonym for `house` and a search for `home`, records matching either \"home\" or \"house\" are included in the search results, and either \"home\" or \"house\" are highlighted. With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, but all occurences of \"house\" are replaced by \"home\" in the highlighted response. - * @param minProximity Minimum proximity score for two matching words. This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score. - * @param responseFields Properties to include in the API response of `search` and `browse` requests. By default, all response properties are included. To reduce the response size, you can select, which attributes should be included. You can't exclude these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your search UI. - * @param maxFacetHits 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). - * @param maxValuesPerFacet Maximum number of facet values to return for each facet. - * @param sortFacetValuesBy Order in which to retrieve facet values. - `count`. Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value. - `alpha`. Retrieve facet values alphabetically. This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/). - * @param attributeCriteriaComputedByMinProximity Whether the best matching attribute should be determined by minimum proximity. This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting. - * @param renderingContent - * @param enableReRanking Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard. - * @param reRankingApplyFilter - */ -@Serializable -public data class SearchParamsObject( - - /** Search query. */ - @SerialName(value = "query") val query: String? = null, - - /** Keywords to be used instead of the search query to conduct a more broader search. Using the `similarQuery` parameter changes other settings: - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords`. Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results. */ - @SerialName(value = "similarQuery") val similarQuery: String? = null, - - /** Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** ` `, where `` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `: TO ` where `` and `` are the lower and upper limits of the range (inclusive). - **Facet filters.** `:` where `` is a facet attribute (case-sensitive) and `` a facet value. - **Tag filters.** `_tags:` or just `` (case-sensitive). - **Boolean filters.** `: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/). */ - @SerialName(value = "filters") val filters: String? = null, - - @SerialName(value = "facetFilters") val facetFilters: FacetFilters? = null, - - @SerialName(value = "optionalFilters") val optionalFilters: OptionalFilters? = null, - - @SerialName(value = "numericFilters") val numericFilters: NumericFilters? = null, - - @SerialName(value = "tagFilters") val tagFilters: TagFilters? = null, - - /** Whether to sum all filter scores. If true, all filter scores are summed. Otherwise, the maximum filter score is kept. For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores). */ - @SerialName(value = "sumOrFiltersScores") val sumOrFiltersScores: Boolean? = null, - - /** Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive. */ - @SerialName(value = "restrictSearchableAttributes") val restrictSearchableAttributes: List? = null, - - /** Facets for which to retrieve facet values that match the search criteria and the number of matching facet values. To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts). */ - @SerialName(value = "facets") val facets: List? = null, - - /** Whether faceting should be applied after deduplication with `distinct`. This leads to accurate facet counts when using faceting in combination with `distinct`. It's usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`. */ - @SerialName(value = "facetingAfterDistinct") val facetingAfterDistinct: Boolean? = null, - - /** Page of search results to retrieve. */ - @SerialName(value = "page") val page: Int? = null, - - /** Position of the first hit to retrieve. */ - @SerialName(value = "offset") val offset: Int? = null, - - /** Number of hits to retrieve (used in combination with `offset`). */ - @SerialName(value = "length") val length: Int? = null, - - /** Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`. */ - @SerialName(value = "aroundLatLng") val aroundLatLng: String? = null, - - /** Whether to obtain the coordinates from the request's IP address. */ - @SerialName(value = "aroundLatLngViaIP") val aroundLatLngViaIP: Boolean? = null, - - @SerialName(value = "aroundRadius") val aroundRadius: AroundRadius? = null, - - @SerialName(value = "aroundPrecision") val aroundPrecision: AroundPrecision? = null, - - /** Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set. */ - @SerialName(value = "minimumAroundRadius") val minimumAroundRadius: Int? = null, - - /** Coordinates for a rectangular area in which to search. Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). */ - @SerialName(value = "insideBoundingBox") val insideBoundingBox: List>? = null, - - /** Coordinates of a polygon in which to search. Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`. */ - @SerialName(value = "insidePolygon") val insidePolygon: List>? = null, - - /** ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches): - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`. */ - @SerialName(value = "naturalLanguages") val naturalLanguages: List? = null, - - /** Assigns a rule context to the search query. [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules. */ - @SerialName(value = "ruleContexts") val ruleContexts: List? = null, - - /** Impact that Personalization should have on this search. The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact). */ - @SerialName(value = "personalizationImpact") val personalizationImpact: Int? = null, - - /** Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). */ - @SerialName(value = "userToken") val userToken: String? = null, - - /** Whether the search response should include detailed ranking information. */ - @SerialName(value = "getRankingInfo") val getRankingInfo: Boolean? = null, - - /** Whether to take into account an index's synonyms for this search. */ - @SerialName(value = "synonyms") val synonyms: Boolean? = null, - - /** Whether to include a `queryID` attribute in the response. The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/). */ - @SerialName(value = "clickAnalytics") val clickAnalytics: Boolean? = null, - - /** Whether this search will be included in Analytics. */ - @SerialName(value = "analytics") val analytics: Boolean? = null, - - /** Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). */ - @SerialName(value = "analyticsTags") val analyticsTags: List? = null, - - /** Whether to include this search when calculating processing-time percentiles. */ - @SerialName(value = "percentileComputation") val percentileComputation: Boolean? = null, - - /** Whether to enable A/B testing for this search. */ - @SerialName(value = "enableABTest") val enableABTest: Boolean? = null, - - /** Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive. - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included. */ - @SerialName(value = "attributesToRetrieve") val attributesToRetrieve: List? = null, - - /** Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/). */ - @SerialName(value = "ranking") val ranking: List? = null, - - /** Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied. */ - @SerialName(value = "customRanking") val customRanking: List? = null, - - /** Relevancy threshold below which less relevant results aren't included in the results. You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results. */ - @SerialName(value = "relevancyStrictness") val relevancyStrictness: Int? = null, - - /** Attributes to highlight. By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive. With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI. For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/). */ - @SerialName(value = "attributesToHighlight") val attributesToHighlight: List? = null, - - /** Attributes for which to enable snippets. Attribute names are case-sensitive. Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted. */ - @SerialName(value = "attributesToSnippet") val attributesToSnippet: List? = null, - - /** HTML tag to insert before the highlighted parts in all highlighted results and snippets. */ - @SerialName(value = "highlightPreTag") val highlightPreTag: String? = null, - - /** HTML tag to insert after the highlighted parts in all highlighted results and snippets. */ - @SerialName(value = "highlightPostTag") val highlightPostTag: String? = null, - - /** String used as an ellipsis indicator when a snippet is truncated. */ - @SerialName(value = "snippetEllipsisText") val snippetEllipsisText: String? = null, - - /** Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted. */ - @SerialName(value = "restrictHighlightAndSnippetArrays") val restrictHighlightAndSnippetArrays: Boolean? = null, - - /** Number of hits per page. */ - @SerialName(value = "hitsPerPage") val hitsPerPage: Int? = null, - - /** Minimum number of characters a word in the search query 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). */ - @SerialName(value = "minWordSizefor1Typo") val minWordSizefor1Typo: Int? = null, - - /** Minimum number of characters a word in the search query 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). */ - @SerialName(value = "minWordSizefor2Typos") val minWordSizefor2Typos: Int? = null, - - @SerialName(value = "typoTolerance") val typoTolerance: TypoTolerance? = null, - - /** Whether to allow typos on numbers in the search query. Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers. */ - @SerialName(value = "allowTyposOnNumericTokens") val allowTyposOnNumericTokens: Boolean? = null, - - /** Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive. Returning only exact matches can help when: - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/). - Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions. Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos. */ - @SerialName(value = "disableTypoToleranceOnAttributes") val disableTypoToleranceOnAttributes: List? = null, - - @SerialName(value = "ignorePlurals") val ignorePlurals: IgnorePlurals? = null, - - @SerialName(value = "removeStopWords") val removeStopWords: RemoveStopWords? = null, - - /** Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics. */ - @SerialName(value = "keepDiacriticsOnCharacters") val keepDiacriticsOnCharacters: String? = null, - - /** Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [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) languages. To support this, you must place the CJK language **first**. **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/). */ - @SerialName(value = "queryLanguages") val queryLanguages: List? = null, - - /** Whether to split compound words in the query into their building blocks. For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308). */ - @SerialName(value = "decompoundQuery") val decompoundQuery: Boolean? = null, - - /** Whether to enable rules. */ - @SerialName(value = "enableRules") val enableRules: Boolean? = null, - - /** Whether to enable Personalization. */ - @SerialName(value = "enablePersonalization") val enablePersonalization: Boolean? = null, - - @SerialName(value = "queryType") val queryType: QueryType? = null, - - @SerialName(value = "removeWordsIfNoResults") val removeWordsIfNoResults: RemoveWordsIfNoResults? = null, - - @SerialName(value = "mode") val mode: Mode? = null, - - @SerialName(value = "semanticSearch") val semanticSearch: SemanticSearch? = null, - - /** Whether to support phrase matching and excluding words from search queries. Use the `advancedSyntaxFeatures` parameter to control which feature is supported. */ - @SerialName(value = "advancedSyntax") val advancedSyntax: Boolean? = null, - - /** Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words dividied by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words). */ - @SerialName(value = "optionalWords") val optionalWords: List? = null, - - /** Searchable 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). Attribute names are case-sensitive. This can be useful for attributes with long values, where the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking. */ - @SerialName(value = "disableExactOnAttributes") val disableExactOnAttributes: List? = null, - - @SerialName(value = "exactOnSingleWordQuery") val exactOnSingleWordQuery: ExactOnSingleWordQuery? = null, - - /** Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches. */ - @SerialName(value = "alternativesAsExact") val alternativesAsExact: List? = null, - - /** Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". - `excludeWords`. Query words prefixed with a `-` must not occur in a record. For example, `search -engine` matches records that contain \"search\" but not \"engine\". This setting only has an effect if `advancedSyntax` is true. */ - @SerialName(value = "advancedSyntaxFeatures") val advancedSyntaxFeatures: List? = null, - - @SerialName(value = "distinct") val distinct: Distinct? = null, - - /** Whether to replace a highlighted word with the matched synonym. By default, the original words are highlighted even if a synonym matches. For example, with `home` as a synonym for `house` and a search for `home`, records matching either \"home\" or \"house\" are included in the search results, and either \"home\" or \"house\" are highlighted. With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, but all occurences of \"house\" are replaced by \"home\" in the highlighted response. */ - @SerialName(value = "replaceSynonymsInHighlight") val replaceSynonymsInHighlight: Boolean? = null, - - /** Minimum proximity score for two matching words. This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score. */ - @SerialName(value = "minProximity") val minProximity: Int? = null, - - /** Properties to include in the API response of `search` and `browse` requests. By default, all response properties are included. To reduce the response size, you can select, which attributes should be included. You can't exclude these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your search UI. */ - @SerialName(value = "responseFields") val responseFields: List? = null, - - /** 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). */ - @SerialName(value = "maxFacetHits") val maxFacetHits: Int? = null, - - /** Maximum number of facet values to return for each facet. */ - @SerialName(value = "maxValuesPerFacet") val maxValuesPerFacet: Int? = null, - - /** Order in which to retrieve facet values. - `count`. Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value. - `alpha`. Retrieve facet values alphabetically. This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/). */ - @SerialName(value = "sortFacetValuesBy") val sortFacetValuesBy: String? = null, - - /** Whether the best matching attribute should be determined by minimum proximity. This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting. */ - @SerialName(value = "attributeCriteriaComputedByMinProximity") val attributeCriteriaComputedByMinProximity: Boolean? = null, - - @SerialName(value = "renderingContent") val renderingContent: RenderingContent? = null, - - /** Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard. */ - @SerialName(value = "enableReRanking") val enableReRanking: Boolean? = null, - - @SerialName(value = "reRankingApplyFilter") val reRankingApplyFilter: ReRankingApplyFilter? = null, -) diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/SemanticSearch.kt b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/SemanticSearch.kt deleted file mode 100644 index 1655a637..00000000 --- a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/SemanticSearch.kt +++ /dev/null @@ -1,17 +0,0 @@ -/** 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. */ -package com.algolia.client.model.recommend - -import kotlinx.serialization.* -import kotlinx.serialization.json.* - -/** - * Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`. - * - * @param eventSources Indices from which to collect click and conversion events. If null, the current index and all its replicas are used. - */ -@Serializable -public data class SemanticSearch( - - /** Indices from which to collect click and conversion events. If null, the current index and all its replicas are used. */ - @SerialName(value = "eventSources") val eventSources: List? = null, -) diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/TrendingFacetsQuery.kt b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/TrendingFacetsQuery.kt index 3ec1f21e..290d2bc4 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/TrendingFacetsQuery.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/TrendingFacetsQuery.kt @@ -32,7 +32,7 @@ public data class TrendingFacetsQuery( /** Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value. */ @SerialName(value = "maxRecommendations") val maxRecommendations: Int? = null, - @SerialName(value = "queryParameters") val queryParameters: SearchParams? = null, + @SerialName(value = "queryParameters") val queryParameters: RecommendSearchParams? = null, @SerialName(value = "fallbackParameters") val fallbackParameters: FallbackParams? = null, ) : RecommendationsRequest diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/TrendingItemsQuery.kt b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/TrendingItemsQuery.kt index de94ee22..066b0269 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/recommend/TrendingItemsQuery.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/recommend/TrendingItemsQuery.kt @@ -30,7 +30,7 @@ public data class TrendingItemsQuery( /** Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value. */ @SerialName(value = "maxRecommendations") val maxRecommendations: Int? = null, - @SerialName(value = "queryParameters") val queryParameters: SearchParams? = null, + @SerialName(value = "queryParameters") val queryParameters: RecommendSearchParams? = null, /** Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned. */ @SerialName(value = "facetName") val facetName: String? = null, @@ -38,5 +38,5 @@ public data class TrendingItemsQuery( /** Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned. */ @SerialName(value = "facetValue") val facetValue: String? = null, - @SerialName(value = "fallbackParameters") val fallbackParameters: SearchParamsObject? = null, + @SerialName(value = "fallbackParameters") val fallbackParameters: FallbackParams? = null, ) : RecommendationsRequest