meilisearch/meilisearch-java

Context Meilisearch v1.55.0 introduces dynamic search rule preview. Objective Update the SDK to support previewing a dynamic search rule by sending an inline rule on search and multi-search. This requires Meilisearch Enterprise Edition and the dynamicSearchRules experimental feature. POST /indexes/{indexUid}/search: { "q": "super hero", "inlineRule": { "uid": "user-likes-batman", "actions": { "scale": [ { "filter": "hero = batman AND release_time = fresh", "weight": 1.2 } ] } } } POST /multi-search with Meili-Include-Metadata: true header: { "queries": [ { "indexUid": "products", "q": "fashion", "filter": "color = blue AND category = shirt" }, { "indexUid": "products", "q": "fashion", "filter": "color = blue AND category = shirt", "inlineRule": { "uid": "special-sales", "conditions": { "query": { "words": "pants" },

Context Meilisearch v1.53.0 adds indexSize and usedIndexSize to per-index stats. Objective Update the SDK so index stats responses include the new indexSize and usedIndexSize fields returned by Get stats of index and per index in Get stats of all indexes. indexSize: size of the index DB (bytes by default; honour sizeFormat when supported) usedIndexSize: size of the used pages of the index DB (bytes by default; honour sizeFormat when supported) Tasks Add indexSize and usedIndexSize to the index stats response shape Update test cases

Context Meilisearch introduced document relations as an experimental feature. Objective Add support for the document relations settings as an experimental feature. Experimental features should require opt-in by the user. Read the how to guide for more information. Tasks Add methods to interact with Get foreignKeys, Update foreignKeys, and Reset foreignKeys API endpoints Update the global settings methods to accept and handle the foreignKeys setting Add test cases for all new methods Add code samples in .code-samples.meilisearch.yaml matching the Meilisearch documentation CURL examples: Under get_foreign_keys_setting_1: equivalent of this code sample Under update_foreign_keys_setting_1: equivalent of this code sample Under reset_foreign_keys_setting_1: equivalent of this code sample Resources Release notes: Meilisearch v1.39 introduced cross-index document hydration via a new foreignKeys index setting. This allows linking documents across indexes so that search results are

Context Meilisearch 1.47.0 adds full support for personalized search (experimental) to the search endpoint. NB: before 1.47.0, federated search requests did not support personalized search. Objective Update the SDK to support personalized search on the search endpoint. Update the corresponding SDK methods Search (POST) Search (GET) Both related API endpoints now accept a new personalize object parameter: { // other request parameters... "personalize": { "userContext": "The user prefers ..." } } Tasks Add/update methods to handle interacting with the search API endpoints Add/update test cases for the new/updated methods No code samples to update

Context [Meilisearch 1.44.0]https://github.com/meilisearch/meilisearch/releases/tag/v1.44.0) introduces human-formatted sizes and detailed DB sizes in stats. Objective Update the corresponding SDK methods: Get stats of index Get stats of all indexes Both related API endpoints now accept new query parameters: showInternalDatabaseSizes: boolean, optional, defaults to false. When present, the index stat objects in responses of the stat routes now contain an additional internalDatabaseSizes key, whose value is a dictionary of the internal database names and their current size in the index, like in the stats object of a batch. sizeFormat: human or raw: optional, defaults to raw. When present and set to human, then all database sizes in responses of the stat routes will be returned as a string containing an appropriate unit (MiB, GiB, etc). When missing or set to raw, then the current behavior of expressing the size in bytes as a number is retained. The keys in internalDatabaseSizes are