Skip to content

Commit 2e2cbda

Browse files
committed
Add custom search section in Getting Started
1 parent a9b9bd8 commit 2e2cbda

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ index.add_documents(documents) # => { "updateId": 0 }
7777

7878
With the `updateId`, you can check the status (`processed` or `failed`) of your documents addition thanks to this [method](https://docs.meilisearch.com/references/updates.html#get-an-update-status).
7979

80-
#### Search in index <!-- omit in toc -->
80+
#### Basic Search <!-- omit in toc -->
8181

8282
``` python
8383
# MeiliSearch is typo-tolerant:
@@ -98,6 +98,29 @@ Output:
9898
}
9999
```
100100

101+
#### Custom Search <!-- omit in toc -->
102+
103+
All the supported options are described in [this documentation section](https://docs.meilisearch.com/guides/advanced_guides/search_parameters.html).
104+
105+
```python
106+
index.search('prince', { 'limit': 1 })
107+
```
108+
109+
```json
110+
{
111+
"hits": [
112+
{
113+
"book_id": 456,
114+
"title": "Le Petit Prince"
115+
}
116+
],
117+
"offset": 0,
118+
"limit": 1,
119+
"processingTimeMs": 10,
120+
"query": "prince"
121+
}
122+
```
123+
101124
## 🤖 Compatibility with MeiliSearch
102125

103126
This package only guarantees the compatibility with the [version v0.15.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.15.0).

0 commit comments

Comments
 (0)