Skip to content

Commit ee5952f

Browse files
committed
docs: document the personalize search parameter
Meilisearch v1.47.0 adds experimental personalized search (a `personalize` object with a `userContext` string). `Index.search` forwards `opt_params` to the API as-is, so the parameter already works at runtime; document it alongside the other common search options. Closes #1245
1 parent f51bb17 commit ee5952f

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

meilisearch/index.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -348,6 +348,8 @@ def search(self, query: str, opt_params: Optional[Mapping[str, Any]] = None) ->
348348
- hybrid: Dict with 'semanticRatio' and 'embedder' fields for hybrid search
349349
- vector: Array of numbers for vector search
350350
- retrieveVectors: Boolean to include vector data in search results
351+
- personalize: Dict with a 'userContext' string to personalize the
352+
results (experimental; requires Meilisearch >= v1.47)
351353
- filter: Filter queries by an attribute's value
352354
- limit: Maximum number of documents returned
353355
- offset: Number of documents to skip

0 commit comments

Comments
 (0)