Skip to content

Commit 115b64e

Browse files
authored
Merge branch 'main' into bump-meilisearch-v0.12.0
2 parents bc826bb + e86b7b3 commit 115b64e

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

packages/autocomplete-client/README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,14 +135,17 @@ The `options` field in the `meilisearchAutocompleteClient` function provides the
135135
- [`keepZeroFacets`](#keep-zero-facets): Show the facets value even when they have 0 matches (default `false`).
136136
- [`matchingStrategy`](#matching-strategy): Determine the search strategy on words matching (default `last`).
137137
- [`requestConfig`](#request-config): Use custom request configurations.
138-
- ['httpClient'](#custom-http-client): Use a custom HTTP client.
138+
- [`httpClient`](#custom-http-client): Use a custom HTTP client.
139+
- [`meiliSearchParams`](#meilisearch-search-parameters): Override search parameters sent to Meilisearch.
139140

140141
```js
141142
const client = meilisearchAutocompleteClient({
142143
url: 'http://localhost:7700',
143144
apiKey: 'searchKey',
144145
options: {
145-
placeholderSearch: false,
146+
// other options
147+
meiliSearchParams: {
148+
},
146149
},
147150
})
148151
```
@@ -237,6 +240,24 @@ You can use your own HTTP client, for example, with [`axios`](https://github.com
237240
}
238241
```
239242

243+
### Meilisearch search parameters
244+
245+
`meiliSearchParams` lets you override the parameters sent to Meilisearch.
246+
The following options can be overridden:
247+
- [`attributesToCrop`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#attributes-to-crop)
248+
- [`attributesToHighlight`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#attributes-to-highlight)
249+
- [`attributesToRetrieve`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#attributes-to-retrieve)
250+
- [`attributesToSearchOn`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#customize-attributes-to-search-on-at-search-time)
251+
- [`cropLength`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#crop-length)
252+
- [`cropMarker`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#crop-marker)
253+
- [`distinct`](https://www.meilisearch.com/docs/learn/relevancy/distinct_attribute)
254+
- [`highlightPreTag`, `highlightPostTag`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#highlight-tags)
255+
- [`hybrid`](https://www.meilisearch.com/docs/learn/experimental/vector_search)
256+
- [`matchingStrategy`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#matching-strategy)
257+
- [`showMatchesPosition`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#show-matches-position)
258+
- [`showRankingScore`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#ranking-score)
259+
- [`rankingScoreThreshold`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#ranking-score-threshold)
260+
240261
## 🤖 Compatibility with Meilisearch and Autocomplete
241262

242263
**Supported autocomplete versions**:

0 commit comments

Comments
 (0)