meilisearch-python-sdk 3.5.0__py3-none-any.whl → 3.5.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of meilisearch-python-sdk might be problematic. Click here for more details.

Files changed (9) hide show
  1. meilisearch_python_sdk/_client.py +46 -240
  2. meilisearch_python_sdk/_task.py +1 -5
  3. meilisearch_python_sdk/_version.py +1 -1
  4. meilisearch_python_sdk/decorators.py +2 -10
  5. meilisearch_python_sdk/index.py +256 -962
  6. {meilisearch_python_sdk-3.5.0.dist-info → meilisearch_python_sdk-3.5.1.dist-info}/METADATA +2 -1
  7. {meilisearch_python_sdk-3.5.0.dist-info → meilisearch_python_sdk-3.5.1.dist-info}/RECORD +9 -9
  8. {meilisearch_python_sdk-3.5.0.dist-info → meilisearch_python_sdk-3.5.1.dist-info}/WHEEL +0 -0
  9. {meilisearch_python_sdk-3.5.0.dist-info → meilisearch_python_sdk-3.5.1.dist-info}/licenses/LICENSE +0 -0
meilisearch_python_sdk/index.py CHANGED
@@ -123,7 +123,6 @@ class AsyncIndex(_BaseIndex):
123
123
  """Class initializer.
124
124
 
125
125
  Args:
126
-
127
126
  http_client: An instance of the AsyncClient. This automatically gets passed by the
128
127
  AsyncClient when creating and AsyncIndex instance.
129
128
  uid: The index's unique identifier.
@@ -155,10 +154,9 @@ class AsyncIndex(_BaseIndex):
155
154
  if not self.plugins or not self.plugins.add_documents_plugins:
156
155
  return None
157
156
 
158
- plugins = []
159
- for plugin in self.plugins.add_documents_plugins:
160
- if plugin.CONCURRENT_EVENT:
161
- plugins.append(plugin)
157
+ plugins = [
158
+ plugin for plugin in self.plugins.add_documents_plugins if plugin.CONCURRENT_EVENT
159
+ ]
162
160
 
163
161
  if not plugins:
164
162
  return None
@@ -170,10 +168,7 @@ class AsyncIndex(_BaseIndex):
170
168
  if not self.plugins or not self.plugins.add_documents_plugins:
171
169
  return None
172
170
 
173
- plugins = []
174
- for plugin in self.plugins.add_documents_plugins:
175
- if plugin.POST_EVENT:
176
- plugins.append(plugin)
171
+ plugins = [plugin for plugin in self.plugins.add_documents_plugins if plugin.POST_EVENT]
177
172
 
178
173
  if not plugins:
179
174
  return None
@@ -185,10 +180,7 @@ class AsyncIndex(_BaseIndex):
185
180
  if not self.plugins or not self.plugins.add_documents_plugins:
186
181
  return None
187
182
 
188
- plugins = []
189
- for plugin in self.plugins.add_documents_plugins:
190
- if plugin.PRE_EVENT:
191
- plugins.append(plugin)
183
+ plugins = [plugin for plugin in self.plugins.add_documents_plugins if plugin.PRE_EVENT]
192
184
 
193
185
  if not plugins:
194
186
  return None
@@ -200,10 +192,11 @@ class AsyncIndex(_BaseIndex):
200
192
  if not self.plugins or not self.plugins.delete_all_documents_plugins:
201
193
  return None
202
194
 
203
- plugins = []
204
- for plugin in self.plugins.delete_all_documents_plugins:
205
- if plugin.CONCURRENT_EVENT:
206
- plugins.append(plugin)
195
+ plugins = [
196
+ plugin
197
+ for plugin in self.plugins.delete_all_documents_plugins
198
+ if plugin.CONCURRENT_EVENT
199
+ ]
207
200
 
208
201
  if not plugins:
209
202
  return None
@@ -215,10 +208,9 @@ class AsyncIndex(_BaseIndex):
215
208
  if not self.plugins or not self.plugins.delete_all_documents_plugins:
216
209
  return None
217
210
 
218
- plugins = []
219
- for plugin in self.plugins.delete_all_documents_plugins:
220
- if plugin.POST_EVENT:
221
- plugins.append(plugin)
211
+ plugins = [
212
+ plugin for plugin in self.plugins.delete_all_documents_plugins if plugin.POST_EVENT
213
+ ]
222
214
 
223
215
  if not plugins:
224
216
  return None
@@ -230,10 +222,9 @@ class AsyncIndex(_BaseIndex):
230
222
  if not self.plugins or not self.plugins.delete_all_documents_plugins:
231
223
  return None
232
224
 
233
- plugins = []
234
- for plugin in self.plugins.delete_all_documents_plugins:
235
- if plugin.PRE_EVENT:
236
- plugins.append(plugin)
225
+ plugins = [
226
+ plugin for plugin in self.plugins.delete_all_documents_plugins if plugin.PRE_EVENT
227
+ ]
237
228
 
238
229
  if not plugins:
239
230
  return None
@@ -245,10 +236,9 @@ class AsyncIndex(_BaseIndex):
245
236
  if not self.plugins or not self.plugins.delete_document_plugins:
246
237
  return None
247
238
 
248
- plugins = []
249
- for plugin in self.plugins.delete_document_plugins:
250
- if plugin.CONCURRENT_EVENT:
251
- plugins.append(plugin)
239
+ plugins = [
240
+ plugin for plugin in self.plugins.delete_document_plugins if plugin.CONCURRENT_EVENT
241
+ ]
252
242
 
253
243
  if not plugins:
254
244
  return None
@@ -260,10 +250,7 @@ class AsyncIndex(_BaseIndex):
260
250
  if not self.plugins or not self.plugins.delete_document_plugins:
261
251
  return None
262
252
 
263
- plugins = []
264
- for plugin in self.plugins.delete_document_plugins:
265
- if plugin.POST_EVENT:
266
- plugins.append(plugin)
253
+ plugins = [plugin for plugin in self.plugins.delete_document_plugins if plugin.POST_EVENT]
267
254
 
268
255
  if not plugins:
269
256
  return None
@@ -275,10 +262,7 @@ class AsyncIndex(_BaseIndex):
275
262
  if not self.plugins or not self.plugins.delete_document_plugins:
276
263
  return None
277
264
 
278
- plugins = []
279
- for plugin in self.plugins.delete_document_plugins:
280
- if plugin.PRE_EVENT:
281
- plugins.append(plugin)
265
+ plugins = [plugin for plugin in self.plugins.delete_document_plugins if plugin.PRE_EVENT]
282
266
 
283
267
  if not plugins:
284
268
  return None
@@ -290,10 +274,9 @@ class AsyncIndex(_BaseIndex):
290
274
  if not self.plugins or not self.plugins.delete_documents_plugins:
291
275
  return None
292
276
 
293
- plugins = []
294
- for plugin in self.plugins.delete_documents_plugins:
295
- if plugin.CONCURRENT_EVENT:
296
- plugins.append(plugin)
277
+ plugins = [
278
+ plugin for plugin in self.plugins.delete_documents_plugins if plugin.CONCURRENT_EVENT
279
+ ]
297
280
 
298
281
  if not plugins:
299
282
  return None
@@ -305,10 +288,7 @@ class AsyncIndex(_BaseIndex):
305
288
  if not self.plugins or not self.plugins.delete_documents_plugins:
306
289
  return None
307
290
 
308
- plugins = []
309
- for plugin in self.plugins.delete_documents_plugins:
310
- if plugin.POST_EVENT:
311
- plugins.append(plugin)
291
+ plugins = [plugin for plugin in self.plugins.delete_documents_plugins if plugin.POST_EVENT]
312
292
 
313
293
  if not plugins:
314
294
  return None
@@ -320,10 +300,7 @@ class AsyncIndex(_BaseIndex):
320
300
  if not self.plugins or not self.plugins.delete_documents_plugins:
321
301
  return None
322
302
 
323
- plugins = []
324
- for plugin in self.plugins.delete_documents_plugins:
325
- if plugin.PRE_EVENT:
326
- plugins.append(plugin)
303
+ plugins = [plugin for plugin in self.plugins.delete_documents_plugins if plugin.PRE_EVENT]
327
304
 
328
305
  if not plugins:
329
306
  return None
@@ -335,10 +312,11 @@ class AsyncIndex(_BaseIndex):
335
312
  if not self.plugins or not self.plugins.delete_documents_by_filter_plugins:
336
313
  return None
337
314
 
338
- plugins = []
339
- for plugin in self.plugins.delete_documents_by_filter_plugins:
340
- if plugin.CONCURRENT_EVENT:
341
- plugins.append(plugin)
315
+ plugins = [
316
+ plugin
317
+ for plugin in self.plugins.delete_documents_by_filter_plugins
318
+ if plugin.CONCURRENT_EVENT
319
+ ]
342
320
 
343
321
  if not plugins:
344
322
  return None
@@ -350,10 +328,11 @@ class AsyncIndex(_BaseIndex):
350
328
  if not self.plugins or not self.plugins.delete_documents_by_filter_plugins:
351
329
  return None
352
330
 
353
- plugins = []
354
- for plugin in self.plugins.delete_documents_by_filter_plugins:
355
- if plugin.POST_EVENT:
356
- plugins.append(plugin)
331
+ plugins = [
332
+ plugin
333
+ for plugin in self.plugins.delete_documents_by_filter_plugins
334
+ if plugin.POST_EVENT
335
+ ]
357
336
 
358
337
  if not plugins:
359
338
  return None
@@ -365,10 +344,9 @@ class AsyncIndex(_BaseIndex):
365
344
  if not self.plugins or not self.plugins.delete_documents_by_filter_plugins:
366
345
  return None
367
346
 
368
- plugins = []
369
- for plugin in self.plugins.delete_documents_by_filter_plugins:
370
- if plugin.PRE_EVENT:
371
- plugins.append(plugin)
347
+ plugins = [
348
+ plugin for plugin in self.plugins.delete_documents_by_filter_plugins if plugin.PRE_EVENT
349
+ ]
372
350
 
373
351
  if not plugins:
374
352
  return None
@@ -380,10 +358,9 @@ class AsyncIndex(_BaseIndex):
380
358
  if not self.plugins or not self.plugins.facet_search_plugins:
381
359
  return None
382
360
 
383
- plugins = []
384
- for plugin in self.plugins.facet_search_plugins:
385
- if plugin.CONCURRENT_EVENT:
386
- plugins.append(plugin)
361
+ plugins = [
362
+ plugin for plugin in self.plugins.facet_search_plugins if plugin.CONCURRENT_EVENT
363
+ ]
387
364
 
388
365
  if not plugins:
389
366
  return None
@@ -395,10 +372,7 @@ class AsyncIndex(_BaseIndex):
395
372
  if not self.plugins or not self.plugins.facet_search_plugins:
396
373
  return None
397
374
 
398
- plugins = []
399
- for plugin in self.plugins.facet_search_plugins:
400
- if plugin.POST_EVENT:
401
- plugins.append(plugin)
375
+ plugins = [plugin for plugin in self.plugins.facet_search_plugins if plugin.POST_EVENT]
402
376
 
403
377
  if not plugins:
404
378
  return None
@@ -410,10 +384,7 @@ class AsyncIndex(_BaseIndex):
410
384
  if not self.plugins or not self.plugins.facet_search_plugins:
411
385
  return None
412
386
 
413
- plugins = []
414
- for plugin in self.plugins.facet_search_plugins:
415
- if plugin.PRE_EVENT:
416
- plugins.append(plugin)
387
+ plugins = [plugin for plugin in self.plugins.facet_search_plugins if plugin.PRE_EVENT]
417
388
 
418
389
  if not plugins:
419
390
  return None
@@ -425,10 +396,7 @@ class AsyncIndex(_BaseIndex):
425
396
  if not self.plugins or not self.plugins.search_plugins:
426
397
  return None
427
398
 
428
- plugins = []
429
- for plugin in self.plugins.search_plugins:
430
- if plugin.CONCURRENT_EVENT:
431
- plugins.append(plugin)
399
+ plugins = [plugin for plugin in self.plugins.search_plugins if plugin.CONCURRENT_EVENT]
432
400
 
433
401
  if not plugins:
434
402
  return None
@@ -440,10 +408,7 @@ class AsyncIndex(_BaseIndex):
440
408
  if not self.plugins or not self.plugins.search_plugins:
441
409
  return None
442
410
 
443
- plugins = []
444
- for plugin in self.plugins.search_plugins:
445
- if plugin.POST_EVENT:
446
- plugins.append(plugin)
411
+ plugins = [plugin for plugin in self.plugins.search_plugins if plugin.POST_EVENT]
447
412
 
448
413
  if not plugins:
449
414
  return None
@@ -455,10 +420,7 @@ class AsyncIndex(_BaseIndex):
455
420
  if not self.plugins or not self.plugins.search_plugins:
456
421
  return None
457
422
 
458
- plugins = []
459
- for plugin in self.plugins.search_plugins:
460
- if plugin.PRE_EVENT:
461
- plugins.append(plugin)
423
+ plugins = [plugin for plugin in self.plugins.search_plugins if plugin.PRE_EVENT]
462
424
 
463
425
  if not plugins:
464
426
  return None
@@ -472,10 +434,9 @@ class AsyncIndex(_BaseIndex):
472
434
  if not self.plugins or not self.plugins.update_documents_plugins:
473
435
  return None
474
436
 
475
- plugins = []
476
- for plugin in self.plugins.update_documents_plugins:
477
- if plugin.CONCURRENT_EVENT:
478
- plugins.append(plugin)
437
+ plugins = [
438
+ plugin for plugin in self.plugins.update_documents_plugins if plugin.CONCURRENT_EVENT
439
+ ]
479
440
 
480
441
  if not plugins:
481
442
  return None
@@ -487,10 +448,7 @@ class AsyncIndex(_BaseIndex):
487
448
  if not self.plugins or not self.plugins.update_documents_plugins:
488
449
  return None
489
450
 
490
- plugins = []
491
- for plugin in self.plugins.update_documents_plugins:
492
- if plugin.POST_EVENT:
493
- plugins.append(plugin)
451
+ plugins = [plugin for plugin in self.plugins.update_documents_plugins if plugin.POST_EVENT]
494
452
 
495
453
  if not plugins:
496
454
  return None
@@ -502,10 +460,7 @@ class AsyncIndex(_BaseIndex):
502
460
  if not self.plugins or not self.plugins.update_documents_plugins:
503
461
  return None
504
462
 
505
- plugins = []
506
- for plugin in self.plugins.update_documents_plugins:
507
- if plugin.PRE_EVENT:
508
- plugins.append(plugin)
463
+ plugins = [plugin for plugin in self.plugins.update_documents_plugins if plugin.PRE_EVENT]
509
464
 
510
465
  if not plugins:
511
466
  return None
@@ -516,16 +471,13 @@ class AsyncIndex(_BaseIndex):
516
471
  """Deletes the index.
517
472
 
518
473
  Returns:
519
-
520
474
  The details of the task.
521
475
 
522
476
  Raises:
523
-
524
477
  MeilisearchCommunicationError: If there was an error communicating with the server.
525
478
  MeilisearchApiError: If the Meilisearch API returned an error.
526
479
 
527
- Examples:
528
-
480
+ Examples
529
481
  >>> from meilisearch_python_sdk import AsyncClient
530
482
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
531
483
  >>> index = client.index("movies")
@@ -538,16 +490,13 @@ class AsyncIndex(_BaseIndex):
538
490
  """Delete the index if it already exists.
539
491
 
540
492
  Returns:
541
-
542
493
  True if the index was deleted or False if not.
543
494
 
544
495
  Raises:
545
-
546
496
  MeilisearchCommunicationError: If there was an error communicating with the server.
547
497
  MeilisearchApiError: If the Meilisearch API returned an error.
548
498
 
549
- Examples:
550
-
499
+ Examples
551
500
  >>> from meilisearch_python_sdk import AsyncClient
552
501
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
553
502
  >>> index = client.index("movies")
@@ -566,20 +515,16 @@ class AsyncIndex(_BaseIndex):
566
515
  """Update the index primary key.
567
516
 
568
517
  Args:
569
-
570
518
  primary_key: The primary key of the documents.
571
519
 
572
520
  Returns:
573
-
574
521
  An instance of the AsyncIndex with the updated information.
575
522
 
576
523
  Raises:
577
-
578
524
  MeilisearchCommunicationError: If there was an error communicating with the server.
579
525
  MeilisearchApiError: If the Meilisearch API returned an error.
580
526
 
581
- Examples:
582
-
527
+ Examples
583
528
  >>> from meilisearch_python_sdk import AsyncClient
584
529
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
585
530
  >>> index = client.index("movies")
@@ -598,16 +543,13 @@ class AsyncIndex(_BaseIndex):
598
543
  """Gets the infromation about the index.
599
544
 
600
545
  Returns:
601
-
602
546
  An instance of the AsyncIndex containing the retrieved information.
603
547
 
604
548
  Raises:
605
-
606
549
  MeilisearchCommunicationError: If there was an error communicating with the server.
607
550
  MeilisearchApiError: If the Meilisearch API returned an error.
608
551
 
609
- Examples:
610
-
552
+ Examples
611
553
  >>> from meilisearch_python_sdk import AsyncClient
612
554
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
613
555
  >>> index = client.index("movies")
@@ -624,16 +566,13 @@ class AsyncIndex(_BaseIndex):
624
566
  """Get the primary key.
625
567
 
626
568
  Returns:
627
-
628
569
  The primary key for the documents in the index.
629
570
 
630
571
  Raises:
631
-
632
572
  MeilisearchCommunicationError: If there was an error communicating with the server.
633
573
  MeilisearchApiError: If the Meilisearch API returned an error.
634
574
 
635
- Examples:
636
-
575
+ Examples
637
576
  >>> from meilisearch_python_sdk import AsyncClient
638
577
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
639
578
  >>> index = client.index("movies")
@@ -662,7 +601,6 @@ class AsyncIndex(_BaseIndex):
662
601
  through the `Client`.
663
602
 
664
603
  Args:
665
-
666
604
  http_client: An instance of the AsyncClient. This automatically gets passed by the
667
605
  Client when creating an AsyncIndex instance.
668
606
  uid: The index's unique identifier.
@@ -687,16 +625,13 @@ class AsyncIndex(_BaseIndex):
687
625
  JsonDict
688
626
 
689
627
  Returns:
690
-
691
628
  An instance of AsyncIndex containing the information of the newly created index.
692
629
 
693
630
  Raises:
694
-
695
631
  MeilisearchCommunicationError: If there was an error communicating with the server.
696
632
  MeilisearchApiError: If the Meilisearch API returned an error.
697
633
 
698
- Examples:
699
-
634
+ Examples
700
635
  >>> from meilisearch_python_sdk import AsyncClient
701
636
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
702
637
  >>> index = await index.create(client, "movies")
@@ -742,16 +677,13 @@ class AsyncIndex(_BaseIndex):
742
677
  """Get stats of the index.
743
678
 
744
679
  Returns:
745
-
746
680
  Stats of the index.
747
681
 
748
682
  Raises:
749
-
750
683
  MeilisearchCommunicationError: If there was an error communicating with the server.
751
684
  MeilisearchApiError: If the Meilisearch API returned an error.
752
685
 
753
- Examples:
754
-
686
+ Examples
755
687
  >>> from meilisearch_python_sdk import AsyncClient
756
688
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
757
689
  >>> index = client.index("movies")
@@ -793,7 +725,6 @@ class AsyncIndex(_BaseIndex):
793
725
  """Search the index.
794
726
 
795
727
  Args:
796
-
797
728
  query: String containing the word(s) to search
798
729
  offset: Number of documents to skip. Defaults to 0.
799
730
  limit: Maximum number of documents returned. Defaults to 20.
@@ -852,16 +783,13 @@ class AsyncIndex(_BaseIndex):
852
783
  Milisearch >= v1.10.0. Defaults to None letting the Meilisearch pick.
853
784
 
854
785
  Returns:
855
-
856
786
  Results of the search
857
787
 
858
788
  Raises:
859
-
860
789
  MeilisearchCommunicationError: If there was an error communicating with the server.
861
790
  MeilisearchApiError: If the Meilisearch API returned an error.
862
791
 
863
- Examples:
864
-
792
+ Examples
865
793
  >>> from meilisearch_python_sdk import AsyncClient
866
794
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
867
795
  >>> index = client.index("movies")
@@ -1062,7 +990,6 @@ class AsyncIndex(_BaseIndex):
1062
990
  """Search the index.
1063
991
 
1064
992
  Args:
1065
-
1066
993
  query: String containing the word(s) to search
1067
994
  facet_name: The name of the facet to search
1068
995
  facet_query: The facet search value
@@ -1113,16 +1040,13 @@ class AsyncIndex(_BaseIndex):
1113
1040
  Milisearch >= v1.10.0. Defaults to None letting the Meilisearch pick.
1114
1041
 
1115
1042
  Returns:
1116
-
1117
1043
  Results of the search
1118
1044
 
1119
1045
  Raises:
1120
-
1121
1046
  MeilisearchCommunicationError: If there was an error communicating with the server.
1122
1047
  MeilisearchApiError: If the Meilisearch API returned an error.
1123
1048
 
1124
- Examples:
1125
-
1049
+ Examples
1126
1050
  >>> from meilisearch_python_sdk import AsyncClient
1127
1051
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
1128
1052
  >>> index = client.index("movies")
@@ -1324,16 +1248,13 @@ class AsyncIndex(_BaseIndex):
1324
1248
  to None.
1325
1249
 
1326
1250
  Returns:
1327
-
1328
1251
  Results of the search
1329
1252
 
1330
1253
  Raises:
1331
-
1332
1254
  MeilisearchCommunicationError: If there was an error communicating with the server.
1333
1255
  MeilisearchApiError: If the Meilisearch API returned an error.
1334
1256
 
1335
- Examples:
1336
-
1257
+ Examples
1337
1258
  >>> from meilisearch_python_sdk import AsyncClient
1338
1259
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
1339
1260
  >>> index = client.index("movies")
@@ -1365,20 +1286,16 @@ class AsyncIndex(_BaseIndex):
1365
1286
  """Get one document with given document identifier.
1366
1287
 
1367
1288
  Args:
1368
-
1369
1289
  document_id: Unique identifier of the document.
1370
1290
 
1371
1291
  Returns:
1372
-
1373
1292
  The document information
1374
1293
 
1375
1294
  Raises:
1376
-
1377
1295
  MeilisearchCommunicationError: If there was an error communicating with the server.
1378
1296
  MeilisearchApiError: If the Meilisearch API returned an error.
1379
1297
 
1380
- Examples:
1381
-
1298
+ Examples
1382
1299
  >>> from meilisearch_python_sdk import AsyncClient
1383
1300
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
1384
1301
  >>> index = client.index("movies")
@@ -1399,7 +1316,6 @@ class AsyncIndex(_BaseIndex):
1399
1316
  """Get a batch documents from the index.
1400
1317
 
1401
1318
  Args:
1402
-
1403
1319
  offset: Number of documents to skip. Defaults to 0.
1404
1320
  limit: Maximum number of documents returnedd. Defaults to 20.
1405
1321
  fields: Document attributes to show. If this value is None then all
@@ -1408,17 +1324,14 @@ class AsyncIndex(_BaseIndex):
1408
1324
  used with Meilisearch >= v1.2.0
1409
1325
 
1410
1326
  Returns:
1411
-
1412
1327
  Documents info.
1413
1328
 
1414
1329
  Raises:
1415
-
1416
1330
  MeilisearchCommunicationError: If there was an error communicating with the server.
1417
1331
  MeilisearchApiError: If the Meilisearch API returned an error.
1418
1332
 
1419
1333
 
1420
- Examples:
1421
-
1334
+ Examples
1422
1335
  >>> from meilisearch_python_sdk import AsyncClient
1423
1336
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
1424
1337
  >>> index = client.index("movies")
@@ -1457,23 +1370,19 @@ class AsyncIndex(_BaseIndex):
1457
1370
  """Add documents to the index.
1458
1371
 
1459
1372
  Args:
1460
-
1461
1373
  documents: List of documents.
1462
1374
  primary_key: The primary key of the documents. This will be ignored if already set.
1463
1375
  Defaults to None.
1464
1376
  compress: If set to True the data will be sent in gzip format. Defaults to False.
1465
1377
 
1466
1378
  Returns:
1467
-
1468
1379
  The details of the task.
1469
1380
 
1470
1381
  Raises:
1471
-
1472
1382
  MeilisearchCommunicationError: If there was an error communicating with the server.
1473
1383
  MeilisearchApiError: If the Meilisearch API returned an error.
1474
1384
 
1475
- Examples:
1476
-
1385
+ Examples
1477
1386
  >>> from meilisearch_python_sdk import AsyncClient
1478
1387
  >>> documents = [
1479
1388
  >>> {"id": 1, "title": "Movie 1", "genre": "comedy"},
@@ -1601,7 +1510,6 @@ class AsyncIndex(_BaseIndex):
1601
1510
  """Adds documents in batches to reduce RAM usage with indexing.
1602
1511
 
1603
1512
  Args:
1604
-
1605
1513
  documents: List of documents.
1606
1514
  batch_size: The number of documents that should be included in each batch.
1607
1515
  Defaults to 1000.
@@ -1613,16 +1521,13 @@ class AsyncIndex(_BaseIndex):
1613
1521
  server with requests. Defaults to None.
1614
1522
 
1615
1523
  Returns:
1616
-
1617
1524
  List of update ids to track the action.
1618
1525
 
1619
1526
  Raises:
1620
-
1621
1527
  MeilisearchCommunicationError: If there was an error communicating with the server.
1622
1528
  MeilisearchApiError: If the Meilisearch API returned an error.
1623
1529
 
1624
- Examples:
1625
-
1530
+ Examples
1626
1531
  >>> from meilisearch_python_sdk import AsyncClient
1627
1532
  >>> >>> documents = [
1628
1533
  >>> {"id": 1, "title": "Movie 1", "genre": "comedy"},
@@ -1678,7 +1583,6 @@ class AsyncIndex(_BaseIndex):
1678
1583
  """Load all json files from a directory and add the documents to the index.
1679
1584
 
1680
1585
  Args:
1681
-
1682
1586
  directory_path: Path to the directory that contains the json files.
1683
1587
  primary_key: The primary key of the documents. This will be ignored if already set.
1684
1588
  Defaults to None.
@@ -1695,18 +1599,15 @@ class AsyncIndex(_BaseIndex):
1695
1599
  server with requests. Defaults to None.
1696
1600
 
1697
1601
  Returns:
1698
-
1699
1602
  The details of the task status.
1700
1603
 
1701
1604
  Raises:
1702
-
1703
1605
  InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
1704
1606
  MeilisearchError: If the file path is not valid
1705
1607
  MeilisearchCommunicationError: If there was an error communicating with the server.
1706
1608
  MeilisearchApiError: If the Meilisearch API returned an error.
1707
1609
 
1708
- Examples:
1709
-
1610
+ Examples
1710
1611
  >>> from pathlib import Path
1711
1612
  >>> from meilisearch_python_sdk import AsyncClient
1712
1613
  >>> directory_path = Path("/path/to/directory/containing/files")
@@ -1844,7 +1745,6 @@ class AsyncIndex(_BaseIndex):
1844
1745
  """Load all json files from a directory and add the documents to the index in batches.
1845
1746
 
1846
1747
  Args:
1847
-
1848
1748
  directory_path: Path to the directory that contains the json files.
1849
1749
  batch_size: The number of documents that should be included in each batch.
1850
1750
  Defaults to 1000.
@@ -1863,18 +1763,15 @@ class AsyncIndex(_BaseIndex):
1863
1763
  server with requests. Defaults to None.
1864
1764
 
1865
1765
  Returns:
1866
-
1867
1766
  List of update ids to track the action.
1868
1767
 
1869
1768
  Raises:
1870
-
1871
1769
  InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
1872
1770
  MeilisearchError: If the file path is not valid
1873
1771
  MeilisearchCommunicationError: If there was an error communicating with the server.
1874
1772
  MeilisearchApiError: If the Meilisearch API returned an error.
1875
1773
 
1876
- Examples:
1877
-
1774
+ Examples
1878
1775
  >>> from pathlib import Path
1879
1776
  >>> from meilisearch_python_sdk import AsyncClient
1880
1777
  >>> directory_path = Path("/path/to/directory/containing/files")
@@ -1947,25 +1844,21 @@ class AsyncIndex(_BaseIndex):
1947
1844
  """Add documents to the index from a json file.
1948
1845
 
1949
1846
  Args:
1950
-
1951
1847
  file_path: Path to the json file.
1952
1848
  primary_key: The primary key of the documents. This will be ignored if already set.
1953
1849
  Defaults to None.
1954
1850
  compress: If set to True the data will be sent in gzip format. Defaults to False.
1955
1851
 
1956
1852
  Returns:
1957
-
1958
1853
  The details of the task status.
1959
1854
 
1960
1855
  Raises:
1961
-
1962
1856
  InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
1963
1857
  MeilisearchError: If the file path is not valid
1964
1858
  MeilisearchCommunicationError: If there was an error communicating with the server.
1965
1859
  MeilisearchApiError: If the Meilisearch API returned an error.
1966
1860
 
1967
- Examples:
1968
-
1861
+ Examples
1969
1862
  >>> from pathlib import Path
1970
1863
  >>> from meilisearch_python_sdk import AsyncClient
1971
1864
  >>> file_path = Path("/path/to/file.json")
@@ -1992,7 +1885,6 @@ class AsyncIndex(_BaseIndex):
1992
1885
  """Adds documents form a json file in batches to reduce RAM usage with indexing.
1993
1886
 
1994
1887
  Args:
1995
-
1996
1888
  file_path: Path to the json file.
1997
1889
  batch_size: The number of documents that should be included in each batch.
1998
1890
  Defaults to 1000.
@@ -2006,18 +1898,15 @@ class AsyncIndex(_BaseIndex):
2006
1898
  server with requests. Defaults to None.
2007
1899
 
2008
1900
  Returns:
2009
-
2010
1901
  List of update ids to track the action.
2011
1902
 
2012
1903
  Raises:
2013
-
2014
1904
  InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
2015
1905
  MeilisearchError: If the file path is not valid
2016
1906
  MeilisearchCommunicationError: If there was an error communicating with the server.
2017
1907
  MeilisearchApiError: If the Meilisearch API returned an error.
2018
1908
 
2019
- Examples:
2020
-
1909
+ Examples
2021
1910
  >>> from pathlib import Path
2022
1911
  >>> from meilisearch_python_sdk import AsyncClient
2023
1912
  >>> file_path = Path("/path/to/file.json")
@@ -2051,7 +1940,6 @@ class AsyncIndex(_BaseIndex):
2051
1940
  for batching.
2052
1941
 
2053
1942
  Args:
2054
-
2055
1943
  file_path: The path to the file to send to Meilisearch. Only csv and ndjson files are
2056
1944
  allowed.
2057
1945
  primary_key: The primary key of the documents. This will be ignored if already set.
@@ -2061,19 +1949,16 @@ class AsyncIndex(_BaseIndex):
2061
1949
  compress: If set to True the data will be sent in gzip format. Defaults to False.
2062
1950
 
2063
1951
  Returns:
2064
-
2065
1952
  The details of the task.
2066
1953
 
2067
1954
  Raises:
2068
-
2069
1955
  ValueError: If the file is not a csv or ndjson file, or if a csv_delimiter is sent for
2070
1956
  a non-csv file.
2071
1957
  MeilisearchError: If the file path is not valid
2072
1958
  MeilisearchCommunicationError: If there was an error communicating with the server.
2073
1959
  MeilisearchApiError: If the Meilisearch API returned an error.
2074
1960
 
2075
- Examples:
2076
-
1961
+ Examples
2077
1962
  >>> from pathlib import Path
2078
1963
  >>> from meilisearch_python_sdk import AsyncClient
2079
1964
  >>> file_path = Path("/path/to/file.csv")
@@ -2131,23 +2016,19 @@ class AsyncIndex(_BaseIndex):
2131
2016
  sending a PATCH request to /experimental-features with { "editDocumentsByFunction": true }.
2132
2017
 
2133
2018
  Args:
2134
-
2135
2019
  function: Rhai function to use to update the documents.
2136
2020
  context: Parameters to use in the function. Defaults to None.
2137
2021
  filter: Filter the documents before applying the function. Defaults to None.
2138
2022
 
2139
2023
  Returns:
2140
-
2141
2024
  The details of the task.
2142
2025
 
2143
2026
  Raises:
2144
-
2145
2027
  MeilisearchError: If the file path is not valid
2146
2028
  MeilisearchCommunicationError: If there was an error communicating with the server.
2147
2029
  MeilisearchApiError: If the Meilisearch API returned an error.
2148
2030
 
2149
- Examples:
2150
-
2031
+ Examples
2151
2032
  >>> from meilisearch_python_sdk import AsyncClient
2152
2033
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
2153
2034
  >>> index = client.index("movies")
@@ -2176,23 +2057,19 @@ class AsyncIndex(_BaseIndex):
2176
2057
  """Update documents in the index.
2177
2058
 
2178
2059
  Args:
2179
-
2180
2060
  documents: List of documents.
2181
2061
  primary_key: The primary key of the documents. This will be ignored if already set.
2182
2062
  Defaults to None.
2183
2063
  compress: If set to True the data will be sent in gzip format. Defaults to False.
2184
2064
 
2185
2065
  Returns:
2186
-
2187
2066
  The details of the task.
2188
2067
 
2189
2068
  Raises:
2190
-
2191
2069
  MeilisearchCommunicationError: If there was an error communicating with the server.
2192
2070
  MeilisearchApiError: If the Meilisearch API returned an error.
2193
2071
 
2194
- Examples:
2195
-
2072
+ Examples
2196
2073
  >>> from meilisearch_python_sdk import AsyncClient
2197
2074
  >>> documents = [
2198
2075
  >>> {"id": 1, "title": "Movie 1", "genre": "comedy"},
@@ -2323,7 +2200,6 @@ class AsyncIndex(_BaseIndex):
2323
2200
  Each batch tries to fill the max_payload_size
2324
2201
 
2325
2202
  Args:
2326
-
2327
2203
  documents: List of documents.
2328
2204
  batch_size: The number of documents that should be included in each batch.
2329
2205
  Defaults to 1000.
@@ -2335,16 +2211,13 @@ class AsyncIndex(_BaseIndex):
2335
2211
  server with requests. Defaults to None.
2336
2212
 
2337
2213
  Returns:
2338
-
2339
2214
  List of update ids to track the action.
2340
2215
 
2341
2216
  Raises:
2342
-
2343
2217
  MeilisearchCommunicationError: If there was an error communicating with the server.
2344
2218
  MeilisearchApiError: If the Meilisearch API returned an error.
2345
2219
 
2346
- Examples:
2347
-
2220
+ Examples
2348
2221
  >>> from meilisearch_python_sdk import AsyncClient
2349
2222
  >>> documents = [
2350
2223
  >>> {"id": 1, "title": "Movie 1", "genre": "comedy"},
@@ -2397,7 +2270,6 @@ class AsyncIndex(_BaseIndex):
2397
2270
  """Load all json files from a directory and update the documents.
2398
2271
 
2399
2272
  Args:
2400
-
2401
2273
  directory_path: Path to the directory that contains the json files.
2402
2274
  primary_key: The primary key of the documents. This will be ignored if already set.
2403
2275
  Defaults to None.
@@ -2411,18 +2283,15 @@ class AsyncIndex(_BaseIndex):
2411
2283
  compress: If set to True the data will be sent in gzip format. Defaults to False.
2412
2284
 
2413
2285
  Returns:
2414
-
2415
2286
  The details of the task status.
2416
2287
 
2417
2288
  Raises:
2418
-
2419
2289
  InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
2420
2290
  MeilisearchError: If the file path is not valid
2421
2291
  MeilisearchCommunicationError: If there was an error communicating with the server.
2422
2292
  MeilisearchApiError: If the Meilisearch API returned an error.
2423
2293
 
2424
- Examples:
2425
-
2294
+ Examples
2426
2295
  >>> from pathlib import Path
2427
2296
  >>> from meilisearch_python_sdk import AsyncClient
2428
2297
  >>> directory_path = Path("/path/to/directory/containing/files")
@@ -2511,7 +2380,6 @@ class AsyncIndex(_BaseIndex):
2511
2380
  """Load all json files from a directory and update the documents.
2512
2381
 
2513
2382
  Args:
2514
-
2515
2383
  directory_path: Path to the directory that contains the json files.
2516
2384
  batch_size: The number of documents that should be included in each batch.
2517
2385
  Defaults to 1000.
@@ -2530,18 +2398,15 @@ class AsyncIndex(_BaseIndex):
2530
2398
  server with requests. Defaults to None.
2531
2399
 
2532
2400
  Returns:
2533
-
2534
2401
  List of update ids to track the action.
2535
2402
 
2536
2403
  Raises:
2537
-
2538
2404
  InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
2539
2405
  MeilisearchError: If the file path is not valid
2540
2406
  MeilisearchCommunicationError: If there was an error communicating with the server.
2541
2407
  MeilisearchApiError: If the Meilisearch API returned an error.
2542
2408
 
2543
- Examples:
2544
-
2409
+ Examples
2545
2410
  >>> from pathlib import Path
2546
2411
  >>> from meilisearch_python_sdk import AsyncClient
2547
2412
  >>> directory_path = Path("/path/to/directory/containing/files")
@@ -2649,7 +2514,6 @@ class AsyncIndex(_BaseIndex):
2649
2514
  """Add documents in the index from a json file.
2650
2515
 
2651
2516
  Args:
2652
-
2653
2517
  file_path: Path to the json file.
2654
2518
  primary_key: The primary key of the documents. This will be ignored if already set.
2655
2519
  Defaults to None.
@@ -2658,16 +2522,13 @@ class AsyncIndex(_BaseIndex):
2658
2522
  compress: If set to True the data will be sent in gzip format. Defaults to False.
2659
2523
 
2660
2524
  Returns:
2661
-
2662
2525
  The details of the task status.
2663
2526
 
2664
2527
  Raises:
2665
-
2666
2528
  MeilisearchCommunicationError: If there was an error communicating with the server.
2667
2529
  MeilisearchApiError: If the Meilisearch API returned an error.
2668
2530
 
2669
- Examples:
2670
-
2531
+ Examples
2671
2532
  >>> from pathlib import Path
2672
2533
  >>> from meilisearch_python_sdk import AsyncClient
2673
2534
  >>> file_path = Path("/path/to/file.json")
@@ -2693,7 +2554,6 @@ class AsyncIndex(_BaseIndex):
2693
2554
  """Updates documents form a json file in batches to reduce RAM usage with indexing.
2694
2555
 
2695
2556
  Args:
2696
-
2697
2557
  file_path: Path to the json file.
2698
2558
  batch_size: The number of documents that should be included in each batch.
2699
2559
  Defaults to 1000.
@@ -2705,16 +2565,13 @@ class AsyncIndex(_BaseIndex):
2705
2565
  server with requests. Defaults to None.
2706
2566
 
2707
2567
  Returns:
2708
-
2709
2568
  List of update ids to track the action.
2710
2569
 
2711
2570
  Raises:
2712
-
2713
2571
  MeilisearchCommunicationError: If there was an error communicating with the server.
2714
2572
  MeilisearchApiError: If the Meilisearch API returned an error.
2715
2573
 
2716
- Examples:
2717
-
2574
+ Examples
2718
2575
  >>> from pathlib import Path
2719
2576
  >>> from meilisearch_python_sdk import AsyncClient
2720
2577
  >>> file_path = Path("/path/to/file.json")
@@ -2748,7 +2605,6 @@ class AsyncIndex(_BaseIndex):
2748
2605
  for batching.
2749
2606
 
2750
2607
  Args:
2751
-
2752
2608
  file_path: The path to the file to send to Meilisearch. Only csv and ndjson files are
2753
2609
  allowed.
2754
2610
  primary_key: The primary key of the documents. This will be ignored if already set.
@@ -2758,19 +2614,16 @@ class AsyncIndex(_BaseIndex):
2758
2614
  compress: If set to True the data will be sent in gzip format. Defaults to False.
2759
2615
 
2760
2616
  Returns:
2761
-
2762
2617
  The details of the task status.
2763
2618
 
2764
2619
  Raises:
2765
-
2766
2620
  ValueError: If the file is not a csv or ndjson file, or if a csv_delimiter is sent for
2767
2621
  a non-csv file.
2768
2622
  MeilisearchError: If the file path is not valid
2769
2623
  MeilisearchCommunicationError: If there was an error communicating with the server.
2770
2624
  MeilisearchApiError: If the Meilisearch API returned an error.
2771
2625
 
2772
- Examples:
2773
-
2626
+ Examples
2774
2627
  >>> from pathlib import Path
2775
2628
  >>> from meilisearch_python_sdk import AsyncClient
2776
2629
  >>> file_path = Path("/path/to/file.csv")
@@ -2822,20 +2675,16 @@ class AsyncIndex(_BaseIndex):
2822
2675
  """Delete one document from the index.
2823
2676
 
2824
2677
  Args:
2825
-
2826
2678
  document_id: Unique identifier of the document.
2827
2679
 
2828
2680
  Returns:
2829
-
2830
2681
  The details of the task status.
2831
2682
 
2832
2683
  Raises:
2833
-
2834
2684
  MeilisearchCommunicationError: If there was an error communicating with the server.
2835
2685
  MeilisearchApiError: If the Meilisearch API returned an error.
2836
2686
 
2837
- Examples:
2838
-
2687
+ Examples
2839
2688
  >>> from meilisearch_python_sdk import AsyncClient
2840
2689
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
2841
2690
  >>> index = client.index("movies")
@@ -2901,20 +2750,16 @@ class AsyncIndex(_BaseIndex):
2901
2750
  """Delete multiple documents from the index.
2902
2751
 
2903
2752
  Args:
2904
-
2905
2753
  ids: List of unique identifiers of documents.
2906
2754
 
2907
2755
  Returns:
2908
-
2909
2756
  List of update ids to track the action.
2910
2757
 
2911
2758
  Raises:
2912
-
2913
2759
  MeilisearchCommunicationError: If there was an error communicating with the server.
2914
2760
  MeilisearchApiError: If the Meilisearch API returned an error.
2915
2761
 
2916
- Examples:
2917
-
2762
+ Examples
2918
2763
  >>> from meilisearch_python_sdk import AsyncClient
2919
2764
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
2920
2765
  >>> index = client.index("movies")
@@ -2976,20 +2821,16 @@ class AsyncIndex(_BaseIndex):
2976
2821
  """Delete documents from the index by filter.
2977
2822
 
2978
2823
  Args:
2979
-
2980
2824
  filter: The filter value information.
2981
2825
 
2982
2826
  Returns:
2983
-
2984
2827
  The details of the task status.
2985
2828
 
2986
2829
  Raises:
2987
-
2988
2830
  MeilisearchCommunicationError: If there was an error communicating with the server.
2989
2831
  MeilisearchApiError: If the Meilisearch API returned an error.
2990
2832
 
2991
- Examples:
2992
-
2833
+ Examples
2993
2834
  >>> from meilisearch_pyrhon_sdk import AsyncClient
2994
2835
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
2995
2836
  >>> index = client.index("movies")
@@ -3057,23 +2898,19 @@ class AsyncIndex(_BaseIndex):
3057
2898
  """Delete batches of documents from the index by filter.
3058
2899
 
3059
2900
  Args:
3060
-
3061
2901
  filters: A list of filter value information.
3062
2902
  concurrency_limit: If set this will limit the number of batches that will be sent
3063
2903
  concurrently. This can be helpful if you find you are overloading the Meilisearch
3064
2904
  server with requests. Defaults to None.
3065
2905
 
3066
2906
  Returns:
3067
-
3068
2907
  The a list of details of the task statuses.
3069
2908
 
3070
2909
  Raises:
3071
-
3072
2910
  MeilisearchCommunicationError: If there was an error communicating with the server.
3073
2911
  MeilisearchApiError: If the Meilisearch API returned an error.
3074
2912
 
3075
- Examples:
3076
-
2913
+ Examples
3077
2914
  >>> from meilisearch_python_sdk import AsyncClient
3078
2915
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3079
2916
  >>> index = client.index("movies")
@@ -3113,16 +2950,13 @@ class AsyncIndex(_BaseIndex):
3113
2950
  """Delete all documents from the index.
3114
2951
 
3115
2952
  Returns:
3116
-
3117
2953
  The details of the task status.
3118
2954
 
3119
2955
  Raises:
3120
-
3121
2956
  MeilisearchCommunicationError: If there was an error communicating with the server.
3122
2957
  MeilisearchApiError: If the Meilisearch API returned an error.
3123
2958
 
3124
- Examples:
3125
-
2959
+ Examples
3126
2960
  >>> from meilisearch_python_sdk import AsyncClient
3127
2961
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3128
2962
  >>> index = client.index("movies")
@@ -3179,16 +3013,13 @@ class AsyncIndex(_BaseIndex):
3179
3013
  """Get settings of the index.
3180
3014
 
3181
3015
  Returns:
3182
-
3183
3016
  Settings of the index.
3184
3017
 
3185
3018
  Raises:
3186
-
3187
3019
  MeilisearchCommunicationError: If there was an error communicating with the server.
3188
3020
  MeilisearchApiError: If the Meilisearch API returned an error.
3189
3021
 
3190
- Examples:
3191
-
3022
+ Examples
3192
3023
  >>> from meilisearch_python_sdk import AsyncClient
3193
3024
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3194
3025
  >>> index = client.index("movies")
@@ -3212,21 +3043,17 @@ class AsyncIndex(_BaseIndex):
3212
3043
  """Update settings of the index.
3213
3044
 
3214
3045
  Args:
3215
-
3216
3046
  body: Settings of the index.
3217
3047
  compress: If set to True the data will be sent in gzip format. Defaults to False.
3218
3048
 
3219
3049
  Returns:
3220
-
3221
3050
  The details of the task status.
3222
3051
 
3223
3052
  Raises:
3224
-
3225
3053
  MeilisearchCommunicationError: If there was an error communicating with the server.
3226
3054
  MeilisearchApiError: If the Meilisearch API returned an error.
3227
3055
 
3228
- Examples:
3229
-
3056
+ Examples
3230
3057
  >>> from meilisearch_python_sdk import AsyncClient
3231
3058
  >>> from meilisearch_python_sdk import MeilisearchSettings
3232
3059
  >>> new_settings = MeilisearchSettings(
@@ -3261,16 +3088,13 @@ class AsyncIndex(_BaseIndex):
3261
3088
  """Reset settings of the index to default values.
3262
3089
 
3263
3090
  Returns:
3264
-
3265
3091
  The details of the task status.
3266
3092
 
3267
3093
  Raises:
3268
-
3269
3094
  MeilisearchCommunicationError: If there was an error communicating with the server.
3270
3095
  MeilisearchApiError: If the Meilisearch API returned an error.
3271
3096
 
3272
- Examples:
3273
-
3097
+ Examples
3274
3098
  >>> from meilisearch_python_sdk import AsyncClient
3275
3099
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3276
3100
  >>> index = client.index("movies")
@@ -3284,16 +3108,13 @@ class AsyncIndex(_BaseIndex):
3284
3108
  """Get ranking rules of the index.
3285
3109
 
3286
3110
  Returns:
3287
-
3288
3111
  List containing the ranking rules of the index.
3289
3112
 
3290
3113
  Raises:
3291
-
3292
3114
  MeilisearchCommunicationError: If there was an error communicating with the server.
3293
3115
  MeilisearchApiError: If the Meilisearch API returned an error.
3294
3116
 
3295
- Examples:
3296
-
3117
+ Examples
3297
3118
  >>> from meilisearch_python_sdk import AsyncClient
3298
3119
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3299
3120
  >>> index = client.index("movies")
@@ -3309,21 +3130,17 @@ class AsyncIndex(_BaseIndex):
3309
3130
  """Update ranking rules of the index.
3310
3131
 
3311
3132
  Args:
3312
-
3313
3133
  ranking_rules: List containing the ranking rules.
3314
3134
  compress: If set to True the data will be sent in gzip format. Defaults to False.
3315
3135
 
3316
3136
  Returns:
3317
-
3318
3137
  The details of the task status.
3319
3138
 
3320
3139
  Raises:
3321
-
3322
3140
  MeilisearchCommunicationError: If there was an error communicating with the server.
3323
3141
  MeilisearchApiError: If the Meilisearch API returned an error.
3324
3142
 
3325
- Examples:
3326
-
3143
+ Examples
3327
3144
  >>> from meilisearch_python_sdk import AsyncClient
3328
3145
  >>> ranking_rules=[
3329
3146
  >>> "words",
@@ -3349,16 +3166,13 @@ class AsyncIndex(_BaseIndex):
3349
3166
  """Reset ranking rules of the index to default values.
3350
3167
 
3351
3168
  Returns:
3352
-
3353
3169
  The details of the task status.
3354
3170
 
3355
3171
  Raises:
3356
-
3357
3172
  MeilisearchCommunicationError: If there was an error communicating with the server.
3358
3173
  MeilisearchApiError: If the Meilisearch API returned an error.
3359
3174
 
3360
- Examples:
3361
-
3175
+ Examples
3362
3176
  >>> from meilisearch_python_sdk import AsyncClient
3363
3177
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3364
3178
  >>> index = client.index("movies")
@@ -3372,17 +3186,14 @@ class AsyncIndex(_BaseIndex):
3372
3186
  """Get distinct attribute of the index.
3373
3187
 
3374
3188
  Returns:
3375
-
3376
3189
  String containing the distinct attribute of the index. If no distinct attribute
3377
3190
  `None` is returned.
3378
3191
 
3379
3192
  Raises:
3380
-
3381
3193
  MeilisearchCommunicationError: If there was an error communicating with the server.
3382
3194
  MeilisearchApiError: If the Meilisearch API returned an error.
3383
3195
 
3384
- Examples:
3385
-
3196
+ Examples
3386
3197
  >>> from meilisearch_python_sdk import AsyncClient
3387
3198
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3388
3199
  >>> index = client.index("movies")
@@ -3399,21 +3210,17 @@ class AsyncIndex(_BaseIndex):
3399
3210
  """Update distinct attribute of the index.
3400
3211
 
3401
3212
  Args:
3402
-
3403
3213
  body: Distinct attribute.
3404
3214
  compress: If set to True the data will be sent in gzip format. Defaults to False.
3405
3215
 
3406
3216
  Returns:
3407
-
3408
3217
  The details of the task status.
3409
3218
 
3410
3219
  Raises:
3411
-
3412
3220
  MeilisearchCommunicationError: If there was an error communicating with the server.
3413
3221
  MeilisearchApiError: If the Meilisearch API returned an error.
3414
3222
 
3415
- Examples:
3416
-
3223
+ Examples
3417
3224
  >>> from meilisearch_python_sdk import AsyncClient
3418
3225
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3419
3226
  >>> index = client.index("movies")
@@ -3429,16 +3236,13 @@ class AsyncIndex(_BaseIndex):
3429
3236
  """Reset distinct attribute of the index to default values.
3430
3237
 
3431
3238
  Returns:
3432
-
3433
3239
  The details of the task status.
3434
3240
 
3435
3241
  Raises:
3436
-
3437
3242
  MeilisearchCommunicationError: If there was an error communicating with the server.
3438
3243
  MeilisearchApiError: If the Meilisearch API returned an error.
3439
3244
 
3440
- Examples:
3441
-
3245
+ Examples
3442
3246
  >>> from meilisearch_python_sdk import AsyncClient
3443
3247
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3444
3248
  >>> index = client.index("movies")
@@ -3452,16 +3256,13 @@ class AsyncIndex(_BaseIndex):
3452
3256
  """Get searchable attributes of the index.
3453
3257
 
3454
3258
  Returns:
3455
-
3456
3259
  List containing the searchable attributes of the index.
3457
3260
 
3458
3261
  Raises:
3459
-
3460
3262
  MeilisearchCommunicationError: If there was an error communicating with the server.
3461
3263
  MeilisearchApiError: If the Meilisearch API returned an error.
3462
3264
 
3463
- Examples:
3464
-
3265
+ Examples
3465
3266
  >>> from meilisearch_python_sdk import AsyncClient
3466
3267
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3467
3268
  >>> index = client.index("movies")
@@ -3477,21 +3278,17 @@ class AsyncIndex(_BaseIndex):
3477
3278
  """Update searchable attributes of the index.
3478
3279
 
3479
3280
  Args:
3480
-
3481
3281
  body: List containing the searchable attributes.
3482
3282
  compress: If set to True the data will be sent in gzip format. Defaults to False.
3483
3283
 
3484
3284
  Returns:
3485
-
3486
3285
  The details of the task status.
3487
3286
 
3488
3287
  Raises:
3489
-
3490
3288
  MeilisearchCommunicationError: If there was an error communicating with the server.
3491
3289
  MeilisearchApiError: If the Meilisearch API returned an error.
3492
3290
 
3493
- Examples:
3494
-
3291
+ Examples
3495
3292
  >>> from meilisearch_python_sdk import AsyncClient
3496
3293
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3497
3294
  >>> index = client.index("movies")
@@ -3507,16 +3304,13 @@ class AsyncIndex(_BaseIndex):
3507
3304
  """Reset searchable attributes of the index to default values.
3508
3305
 
3509
3306
  Returns:
3510
-
3511
3307
  The details of the task status.
3512
3308
 
3513
3309
  Raises:
3514
-
3515
3310
  MeilisearchCommunicationError: If there was an error communicating with the server.
3516
3311
  MeilisearchApiError: If the Meilisearch API returned an error.
3517
3312
 
3518
- Examples:
3519
-
3313
+ Examples
3520
3314
  >>> from meilisearch_python_sdk import AsyncClient
3521
3315
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3522
3316
  >>> index = client.index("movies")
@@ -3530,16 +3324,13 @@ class AsyncIndex(_BaseIndex):
3530
3324
  """Get displayed attributes of the index.
3531
3325
 
3532
3326
  Returns:
3533
-
3534
3327
  List containing the displayed attributes of the index.
3535
3328
 
3536
3329
  Raises:
3537
-
3538
3330
  MeilisearchCommunicationError: If there was an error communicating with the server.
3539
3331
  MeilisearchApiError: If the Meilisearch API returned an error.
3540
3332
 
3541
- Examples:
3542
-
3333
+ Examples
3543
3334
  >>> from meilisearch_python_sdk import AsyncClient
3544
3335
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3545
3336
  >>> index = client.index("movies")
@@ -3555,21 +3346,17 @@ class AsyncIndex(_BaseIndex):
3555
3346
  """Update displayed attributes of the index.
3556
3347
 
3557
3348
  Args:
3558
-
3559
3349
  body: List containing the displayed attributes.
3560
3350
  compress: If set to True the data will be sent in gzip format. Defaults to False.
3561
3351
 
3562
3352
  Returns:
3563
-
3564
3353
  The details of the task status.
3565
3354
 
3566
3355
  Raises:
3567
-
3568
3356
  MeilisearchCommunicationError: If there was an error communicating with the server.
3569
3357
  MeilisearchApiError: If the Meilisearch API returned an error.
3570
3358
 
3571
- Examples:
3572
-
3359
+ Examples
3573
3360
  >>> from meilisearch_python_sdk import AsyncClient
3574
3361
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3575
3362
  >>> index = client.index("movies")
@@ -3587,16 +3374,13 @@ class AsyncIndex(_BaseIndex):
3587
3374
  """Reset displayed attributes of the index to default values.
3588
3375
 
3589
3376
  Returns:
3590
-
3591
3377
  The details of the task status.
3592
3378
 
3593
3379
  Raises:
3594
-
3595
3380
  MeilisearchCommunicationError: If there was an error communicating with the server.
3596
3381
  MeilisearchApiError: If the Meilisearch API returned an error.
3597
3382
 
3598
- Examples:
3599
-
3383
+ Examples
3600
3384
  >>> from meilisearch_python_sdk import AsyncClient
3601
3385
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3602
3386
  >>> index = client.index("movies")
@@ -3610,16 +3394,13 @@ class AsyncIndex(_BaseIndex):
3610
3394
  """Get stop words of the index.
3611
3395
 
3612
3396
  Returns:
3613
-
3614
3397
  List containing the stop words of the index.
3615
3398
 
3616
3399
  Raises:
3617
-
3618
3400
  MeilisearchCommunicationError: If there was an error communicating with the server.
3619
3401
  MeilisearchApiError: If the Meilisearch API returned an error.
3620
3402
 
3621
- Examples:
3622
-
3403
+ Examples
3623
3404
  >>> from meilisearch_python_sdk import AsyncClient
3624
3405
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3625
3406
  >>> index = client.index("movies")
@@ -3636,21 +3417,17 @@ class AsyncIndex(_BaseIndex):
3636
3417
  """Update stop words of the index.
3637
3418
 
3638
3419
  Args:
3639
-
3640
3420
  body: List containing the stop words of the index.
3641
3421
  compress: If set to True the data will be sent in gzip format. Defaults to False.
3642
3422
 
3643
3423
  Returns:
3644
-
3645
3424
  The details of the task status.
3646
3425
 
3647
3426
  Raises:
3648
-
3649
3427
  MeilisearchCommunicationError: If there was an error communicating with the server.
3650
3428
  MeilisearchApiError: If the Meilisearch API returned an error.
3651
3429
 
3652
- Examples:
3653
-
3430
+ Examples
3654
3431
  >>> from meilisearch_python_sdk import AsyncClient
3655
3432
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3656
3433
  >>> index = client.index("movies")
@@ -3666,16 +3443,13 @@ class AsyncIndex(_BaseIndex):
3666
3443
  """Reset stop words of the index to default values.
3667
3444
 
3668
3445
  Returns:
3669
-
3670
3446
  The details of the task status.
3671
3447
 
3672
3448
  Raises:
3673
-
3674
3449
  MeilisearchCommunicationError: If there was an error communicating with the server.
3675
3450
  MeilisearchApiError: If the Meilisearch API returned an error.
3676
3451
 
3677
- Examples:
3678
-
3452
+ Examples
3679
3453
  >>> from meilisearch_python_sdk import AsyncClient
3680
3454
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3681
3455
  >>> index = client.index("movies")
@@ -3689,16 +3463,13 @@ class AsyncIndex(_BaseIndex):
3689
3463
  """Get synonyms of the index.
3690
3464
 
3691
3465
  Returns:
3692
-
3693
3466
  The synonyms of the index.
3694
3467
 
3695
3468
  Raises:
3696
-
3697
3469
  MeilisearchCommunicationError: If there was an error communicating with the server.
3698
3470
  MeilisearchApiError: If the Meilisearch API returned an error.
3699
3471
 
3700
- Examples:
3701
-
3472
+ Examples
3702
3473
  >>> from meilisearch_python_sdk import AsyncClient
3703
3474
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3704
3475
  >>> index = client.index("movies")
@@ -3717,21 +3488,17 @@ class AsyncIndex(_BaseIndex):
3717
3488
  """Update synonyms of the index.
3718
3489
 
3719
3490
  Args:
3720
-
3721
3491
  body: The synonyms of the index.
3722
3492
  compress: If set to True the data will be sent in gzip format. Defaults to False.
3723
3493
 
3724
3494
  Returns:
3725
-
3726
3495
  The details of the task status.
3727
3496
 
3728
3497
  Raises:
3729
-
3730
3498
  MeilisearchCommunicationError: If there was an error communicating with the server.
3731
3499
  MeilisearchApiError: If the Meilisearch API returned an error.
3732
3500
 
3733
- Examples:
3734
-
3501
+ Examples
3735
3502
  >>> from meilisearch_python_sdk import AsyncClient
3736
3503
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3737
3504
  >>> index = client.index("movies")
@@ -3749,16 +3516,13 @@ class AsyncIndex(_BaseIndex):
3749
3516
  """Reset synonyms of the index to default values.
3750
3517
 
3751
3518
  Returns:
3752
-
3753
3519
  The details of the task status.
3754
3520
 
3755
3521
  Raises:
3756
-
3757
3522
  MeilisearchCommunicationError: If there was an error communicating with the server.
3758
3523
  MeilisearchApiError: If the Meilisearch API returned an error.
3759
3524
 
3760
- Examples:
3761
-
3525
+ Examples
3762
3526
  >>> from meilisearch_python_sdk import AsyncClient
3763
3527
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3764
3528
  >>> index = client.index("movies")
@@ -3772,16 +3536,13 @@ class AsyncIndex(_BaseIndex):
3772
3536
  """Get filterable attributes of the index.
3773
3537
 
3774
3538
  Returns:
3775
-
3776
3539
  List containing the filterable attributes of the index.
3777
3540
 
3778
3541
  Raises:
3779
-
3780
3542
  MeilisearchCommunicationError: If there was an error communicating with the server.
3781
3543
  MeilisearchApiError: If the Meilisearch API returned an error.
3782
3544
 
3783
- Examples:
3784
-
3545
+ Examples
3785
3546
  >>> from meilisearch_python_sdk import AsyncClient
3786
3547
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3787
3548
  >>> index = client.index("movies")
@@ -3800,21 +3561,17 @@ class AsyncIndex(_BaseIndex):
3800
3561
  """Update filterable attributes of the index.
3801
3562
 
3802
3563
  Args:
3803
-
3804
3564
  body: List containing the filterable attributes of the index.
3805
3565
  compress: If set to True the data will be sent in gzip format. Defaults to False.
3806
3566
 
3807
3567
  Returns:
3808
-
3809
3568
  The details of the task status.
3810
3569
 
3811
3570
  Raises:
3812
-
3813
3571
  MeilisearchCommunicationError: If there was an error communicating with the server.
3814
3572
  MeilisearchApiError: If the Meilisearch API returned an error.
3815
3573
 
3816
- Examples:
3817
-
3574
+ Examples
3818
3575
  >>> from meilisearch_python_sdk import AsyncClient
3819
3576
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3820
3577
  >>> index = client.index("movies")
@@ -3830,16 +3587,13 @@ class AsyncIndex(_BaseIndex):
3830
3587
  """Reset filterable attributes of the index to default values.
3831
3588
 
3832
3589
  Returns:
3833
-
3834
3590
  The details of the task status.
3835
3591
 
3836
3592
  Raises:
3837
-
3838
3593
  MeilisearchCommunicationError: If there was an error communicating with the server.
3839
3594
  MeilisearchApiError: If the Meilisearch API returned an error.
3840
3595
 
3841
- Examples:
3842
-
3596
+ Examples
3843
3597
  >>> from meilisearch_python_sdk import AsyncClient
3844
3598
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3845
3599
  >>> index = client.index("movies")
@@ -3853,16 +3607,13 @@ class AsyncIndex(_BaseIndex):
3853
3607
  """Get sortable attributes of the AsyncIndex.
3854
3608
 
3855
3609
  Returns:
3856
-
3857
3610
  List containing the sortable attributes of the AsyncIndex.
3858
3611
 
3859
3612
  Raises:
3860
-
3861
3613
  MeilisearchCommunicationError: If there was an error communicating with the server.
3862
3614
  MeilisearchApiError: If the Meilisearch API returned an error.
3863
3615
 
3864
- Examples:
3865
-
3616
+ Examples
3866
3617
  >>> from meilisearch_python_sdk import AsyncClient
3867
3618
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3868
3619
  >>> index = client.index("movies")
@@ -3878,21 +3629,17 @@ class AsyncIndex(_BaseIndex):
3878
3629
  """Get sortable attributes of the AsyncIndex.
3879
3630
 
3880
3631
  Args:
3881
-
3882
3632
  sortable_attributes: List of attributes for searching.
3883
3633
  compress: If set to True the data will be sent in gzip format. Defaults to False.
3884
3634
 
3885
3635
  Returns:
3886
-
3887
3636
  The details of the task status.
3888
3637
 
3889
3638
  Raises:
3890
-
3891
3639
  MeilisearchCommunicationError: If there was an error communicating with the server.
3892
3640
  MeilisearchApiError: If the Meilisearch API returned an error.
3893
3641
 
3894
- Examples:
3895
-
3642
+ Examples
3896
3643
  >>> from meilisearch_python_sdk import AsyncClient
3897
3644
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3898
3645
  >>> index = client.index("movies")
@@ -3908,16 +3655,13 @@ class AsyncIndex(_BaseIndex):
3908
3655
  """Reset sortable attributes of the index to default values.
3909
3656
 
3910
3657
  Returns:
3911
-
3912
3658
  The details of the task status.
3913
3659
 
3914
3660
  Raises:
3915
-
3916
3661
  MeilisearchCommunicationError: If there was an error communicating with the server.
3917
3662
  MeilisearchApiError: If the Meilisearch API returned an error.
3918
3663
 
3919
- Examples:
3920
-
3664
+ Examples
3921
3665
  >>> from meilisearch_python_sdk import AsyncClient
3922
3666
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3923
3667
  >>> index = client.index("movies")
@@ -3931,16 +3675,13 @@ class AsyncIndex(_BaseIndex):
3931
3675
  """Get typo tolerance for the index.
3932
3676
 
3933
3677
  Returns:
3934
-
3935
3678
  TypoTolerance for the index.
3936
3679
 
3937
3680
  Raises:
3938
-
3939
3681
  MeilisearchCommunicationError: If there was an error communicating with the server.
3940
3682
  MeilisearchApiError: If the Meilisearch API returned an error.
3941
3683
 
3942
- Examples:
3943
-
3684
+ Examples
3944
3685
  >>> from meilisearch_python_sdk import AsyncClient
3945
3686
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3946
3687
  >>> index = client.index("movies")
@@ -3956,21 +3697,17 @@ class AsyncIndex(_BaseIndex):
3956
3697
  """Update typo tolerance.
3957
3698
 
3958
3699
  Args:
3959
-
3960
3700
  typo_tolerance: Typo tolerance settings.
3961
3701
  compress: If set to True the data will be sent in gzip format. Defaults to False.
3962
3702
 
3963
3703
  Returns:
3964
-
3965
3704
  Task to track the action.
3966
3705
 
3967
3706
  Raises:
3968
-
3969
3707
  MeilisearchCommunicationError: If there was an error communicating with the server.
3970
3708
  MeilisearchApiError: If the Meilisearch API returned an error.
3971
3709
 
3972
- Examples:
3973
-
3710
+ Examples
3974
3711
  >>> from meilisearch_python_sdk import AsyncClient
3975
3712
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
3976
3713
  >>> index = client.index("movies")
@@ -3989,16 +3726,13 @@ class AsyncIndex(_BaseIndex):
3989
3726
  """Reset typo tolerance to default values.
3990
3727
 
3991
3728
  Returns:
3992
-
3993
3729
  The details of the task status.
3994
3730
 
3995
3731
  Raises:
3996
-
3997
3732
  MeilisearchCommunicationError: If there was an error communicating with the server.
3998
3733
  MeilisearchApiError: If the Meilisearch API returned an error.
3999
3734
 
4000
- Examples:
4001
-
3735
+ Examples
4002
3736
  >>> from meilisearch_python_sdk import AsyncClient
4003
3737
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4004
3738
  >>> index = client.index("movies")
@@ -4012,16 +3746,13 @@ class AsyncIndex(_BaseIndex):
4012
3746
  """Get faceting for the index.
4013
3747
 
4014
3748
  Returns:
4015
-
4016
3749
  Faceting for the index.
4017
3750
 
4018
3751
  Raises:
4019
-
4020
3752
  MeilisearchCommunicationError: If there was an error communicating with the server.
4021
3753
  MeilisearchApiError: If the Meilisearch API returned an error.
4022
3754
 
4023
- Examples:
4024
-
3755
+ Examples
4025
3756
  >>> from meilisearch_python_sdk import AsyncClient
4026
3757
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4027
3758
  >>> index = client.index("movies")
@@ -4035,21 +3766,17 @@ class AsyncIndex(_BaseIndex):
4035
3766
  """Partially update the faceting settings for an index.
4036
3767
 
4037
3768
  Args:
4038
-
4039
3769
  faceting: Faceting values.
4040
3770
  compress: If set to True the data will be sent in gzip format. Defaults to False.
4041
3771
 
4042
3772
  Returns:
4043
-
4044
3773
  Task to track the action.
4045
3774
 
4046
3775
  Raises:
4047
-
4048
3776
  MeilisearchCommunicationError: If there was an error communicating with the server.
4049
3777
  MeilisearchApiError: If the Meilisearch API returned an error.
4050
3778
 
4051
- Examples:
4052
-
3779
+ Examples
4053
3780
  >>> from meilisearch_python_sdk import AsyncClient
4054
3781
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4055
3782
  >>> index = client.index("movies")
@@ -4067,16 +3794,13 @@ class AsyncIndex(_BaseIndex):
4067
3794
  """Reset an index's faceting settings to their default value.
4068
3795
 
4069
3796
  Returns:
4070
-
4071
3797
  The details of the task status.
4072
3798
 
4073
3799
  Raises:
4074
-
4075
3800
  MeilisearchCommunicationError: If there was an error communicating with the server.
4076
3801
  MeilisearchApiError: If the Meilisearch API returned an error.
4077
3802
 
4078
- Examples:
4079
-
3803
+ Examples
4080
3804
  >>> from meilisearch_python_sdk import AsyncClient
4081
3805
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4082
3806
  >>> index = client.index("movies")
@@ -4090,16 +3814,13 @@ class AsyncIndex(_BaseIndex):
4090
3814
  """Get pagination settings for the index.
4091
3815
 
4092
3816
  Returns:
4093
-
4094
3817
  Pagination for the index.
4095
3818
 
4096
3819
  Raises:
4097
-
4098
3820
  MeilisearchCommunicationError: If there was an error communicating with the server.
4099
3821
  MeilisearchApiError: If the Meilisearch API returned an error.
4100
3822
 
4101
- Examples:
4102
-
3823
+ Examples
4103
3824
  >>> from meilisearch_async_client import AsyncClient
4104
3825
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4105
3826
  >>> index = client.index("movies")
@@ -4113,21 +3834,17 @@ class AsyncIndex(_BaseIndex):
4113
3834
  """Partially update the pagination settings for an index.
4114
3835
 
4115
3836
  Args:
4116
-
4117
3837
  settings: settings for pagination.
4118
3838
  compress: If set to True the data will be sent in gzip format. Defaults to False.
4119
3839
 
4120
3840
  Returns:
4121
-
4122
3841
  Task to track the action.
4123
3842
 
4124
3843
  Raises:
4125
-
4126
3844
  MeilisearchCommunicationError: If there was an error communicating with the server.
4127
3845
  MeilisearchApiError: If the Meilisearch API returned an error.
4128
3846
 
4129
- Examples:
4130
-
3847
+ Examples
4131
3848
  >>> from meilisearch_python_sdk import AsyncClient
4132
3849
  >>> from meilisearch_python_sdk.models.settings import Pagination
4133
3850
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
@@ -4146,16 +3863,13 @@ class AsyncIndex(_BaseIndex):
4146
3863
  """Reset an index's pagination settings to their default value.
4147
3864
 
4148
3865
  Returns:
4149
-
4150
3866
  The details of the task status.
4151
3867
 
4152
3868
  Raises:
4153
-
4154
3869
  MeilisearchCommunicationError: If there was an error communicating with the server.
4155
3870
  MeilisearchApiError: If the Meilisearch API returned an error.
4156
3871
 
4157
- Examples:
4158
-
3872
+ Examples
4159
3873
  >>> from meilisearch_async_client import AsyncClient
4160
3874
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4161
3875
  >>> index = client.index("movies")
@@ -4169,16 +3883,13 @@ class AsyncIndex(_BaseIndex):
4169
3883
  """Get separator token settings for the index.
4170
3884
 
4171
3885
  Returns:
4172
-
4173
3886
  Separator tokens for the index.
4174
3887
 
4175
3888
  Raises:
4176
-
4177
3889
  MeilisearchCommunicationError: If there was an error communicating with the server.
4178
3890
  MeilisearchApiError: If the Meilisearch API returned an error.
4179
3891
 
4180
- Examples:
4181
-
3892
+ Examples
4182
3893
  >>> from meilisearch_async_client import AsyncClient
4183
3894
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4184
3895
  >>> index = client.index("movies")
@@ -4194,21 +3905,17 @@ class AsyncIndex(_BaseIndex):
4194
3905
  """Update the separator tokens settings for an index.
4195
3906
 
4196
3907
  Args:
4197
-
4198
3908
  separator_tokens: List of separator tokens.
4199
3909
  compress: If set to True the data will be sent in gzip format. Defaults to False.
4200
3910
 
4201
3911
  Returns:
4202
-
4203
3912
  Task to track the action.
4204
3913
 
4205
3914
  Raises:
4206
-
4207
3915
  MeilisearchCommunicationError: If there was an error communicating with the server.
4208
3916
  MeilisearchApiError: If the Meilisearch API returned an error.
4209
3917
 
4210
- Examples:
4211
-
3918
+ Examples
4212
3919
  >>> from meilisearch_python_sdk import AsyncClient
4213
3920
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4214
3921
  >>> index = client.index("movies")
@@ -4224,16 +3931,13 @@ class AsyncIndex(_BaseIndex):
4224
3931
  """Reset an index's separator tokens settings to the default value.
4225
3932
 
4226
3933
  Returns:
4227
-
4228
3934
  The details of the task status.
4229
3935
 
4230
3936
  Raises:
4231
-
4232
3937
  MeilisearchCommunicationError: If there was an error communicating with the server.
4233
3938
  MeilisearchApiError: If the Meilisearch API returned an error.
4234
3939
 
4235
- Examples:
4236
-
3940
+ Examples
4237
3941
  >>> from meilisearch_async_client import AsyncClient
4238
3942
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4239
3943
  >>> index = client.index("movies")
@@ -4247,16 +3951,13 @@ class AsyncIndex(_BaseIndex):
4247
3951
  """Get non-separator token settings for the index.
4248
3952
 
4249
3953
  Returns:
4250
-
4251
3954
  Non-separator tokens for the index.
4252
3955
 
4253
3956
  Raises:
4254
-
4255
3957
  MeilisearchCommunicationError: If there was an error communicating with the server.
4256
3958
  MeilisearchApiError: If the Meilisearch API returned an error.
4257
3959
 
4258
- Examples:
4259
-
3960
+ Examples
4260
3961
  >>> from meilisearch_async_client import AsyncClient
4261
3962
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4262
3963
  >>> index = client.index("movies")
@@ -4272,21 +3973,17 @@ class AsyncIndex(_BaseIndex):
4272
3973
  """Update the non-separator tokens settings for an index.
4273
3974
 
4274
3975
  Args:
4275
-
4276
3976
  non_separator_tokens: List of non-separator tokens.
4277
3977
  compress: If set to True the data will be sent in gzip format. Defaults to False.
4278
3978
 
4279
3979
  Returns:
4280
-
4281
3980
  Task to track the action.
4282
3981
 
4283
3982
  Raises:
4284
-
4285
3983
  MeilisearchCommunicationError: If there was an error communicating with the server.
4286
3984
  MeilisearchApiError: If the Meilisearch API returned an error.
4287
3985
 
4288
- Examples:
4289
-
3986
+ Examples
4290
3987
  >>> from meilisearch_python_sdk import AsyncClient
4291
3988
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4292
3989
  >>> index = client.index("movies")
@@ -4302,16 +3999,13 @@ class AsyncIndex(_BaseIndex):
4302
3999
  """Reset an index's non-separator tokens settings to the default value.
4303
4000
 
4304
4001
  Returns:
4305
-
4306
4002
  The details of the task status.
4307
4003
 
4308
4004
  Raises:
4309
-
4310
4005
  MeilisearchCommunicationError: If there was an error communicating with the server.
4311
4006
  MeilisearchApiError: If the Meilisearch API returned an error.
4312
4007
 
4313
- Examples:
4314
-
4008
+ Examples
4315
4009
  >>> from meilisearch_async_client import AsyncClient
4316
4010
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4317
4011
  >>> index = client.index("movies")
@@ -4325,16 +4019,13 @@ class AsyncIndex(_BaseIndex):
4325
4019
  """Get search cutoff time in ms.
4326
4020
 
4327
4021
  Returns:
4328
-
4329
4022
  Integer representing the search cutoff time in ms, or None.
4330
4023
 
4331
4024
  Raises:
4332
-
4333
4025
  MeilisearchCommunicationError: If there was an error communicating with the server.
4334
4026
  MeilisearchApiError: If the Meilisearch API returned an error.
4335
4027
 
4336
- Examples:
4337
-
4028
+ Examples
4338
4029
  >>> from meilisearch_async_client import AsyncClient
4339
4030
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4340
4031
  >>> index = client.index("movies")
@@ -4350,21 +4041,17 @@ class AsyncIndex(_BaseIndex):
4350
4041
  """Update the search cutoff for an index.
4351
4042
 
4352
4043
  Args:
4353
-
4354
4044
  search_cutoff_ms: Integer value of the search cutoff time in ms.
4355
4045
  compress: If set to True the data will be sent in gzip format. Defaults to False.
4356
4046
 
4357
4047
  Returns:
4358
-
4359
4048
  The details of the task status.
4360
4049
 
4361
4050
  Raises:
4362
-
4363
4051
  MeilisearchCommunicationError: If there was an error communicating with the server.
4364
4052
  MeilisearchApiError: If the Meilisearch API returned an error.
4365
4053
 
4366
- Examples:
4367
-
4054
+ Examples
4368
4055
  >>> from meilisearch_python_sdk import AsyncClient
4369
4056
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4370
4057
  >>> index = client.index("movies")
@@ -4380,16 +4067,13 @@ class AsyncIndex(_BaseIndex):
4380
4067
  """Reset the search cutoff time to the default value.
4381
4068
 
4382
4069
  Returns:
4383
-
4384
4070
  The details of the task status.
4385
4071
 
4386
4072
  Raises:
4387
-
4388
4073
  MeilisearchCommunicationError: If there was an error communicating with the server.
4389
4074
  MeilisearchApiError: If the Meilisearch API returned an error.
4390
4075
 
4391
- Examples:
4392
-
4076
+ Examples
4393
4077
  >>> from meilisearch_async_client import AsyncClient
4394
4078
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4395
4079
  >>> index = client.index("movies")
@@ -4403,16 +4087,13 @@ class AsyncIndex(_BaseIndex):
4403
4087
  """Get word dictionary settings for the index.
4404
4088
 
4405
4089
  Returns:
4406
-
4407
4090
  Word dictionary for the index.
4408
4091
 
4409
4092
  Raises:
4410
-
4411
4093
  MeilisearchCommunicationError: If there was an error communicating with the server.
4412
4094
  MeilisearchApiError: If the Meilisearch API returned an error.
4413
4095
 
4414
- Examples:
4415
-
4096
+ Examples
4416
4097
  >>> from meilisearch_async_client import AsyncClient
4417
4098
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4418
4099
  >>> index = client.index("movies")
@@ -4428,21 +4109,17 @@ class AsyncIndex(_BaseIndex):
4428
4109
  """Update the word dictionary settings for an index.
4429
4110
 
4430
4111
  Args:
4431
-
4432
4112
  dictionary: List of dictionary values.
4433
4113
  compress: If set to True the data will be sent in gzip format. Defaults to False.
4434
4114
 
4435
4115
  Returns:
4436
-
4437
4116
  Task to track the action.
4438
4117
 
4439
4118
  Raises:
4440
-
4441
4119
  MeilisearchCommunicationError: If there was an error communicating with the server.
4442
4120
  MeilisearchApiError: If the Meilisearch API returned an error.
4443
4121
 
4444
- Examples:
4445
-
4122
+ Examples
4446
4123
  >>> from meilisearch_python_sdk import AsyncClient
4447
4124
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4448
4125
  >>> index = client.index("movies")
@@ -4458,16 +4135,13 @@ class AsyncIndex(_BaseIndex):
4458
4135
  """Reset an index's word dictionary settings to the default value.
4459
4136
 
4460
4137
  Returns:
4461
-
4462
4138
  The details of the task status.
4463
4139
 
4464
4140
  Raises:
4465
-
4466
4141
  MeilisearchCommunicationError: If there was an error communicating with the server.
4467
4142
  MeilisearchApiError: If the Meilisearch API returned an error.
4468
4143
 
4469
- Examples:
4470
-
4144
+ Examples
4471
4145
  >>> from meilisearch_async_client import AsyncClient
4472
4146
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4473
4147
  >>> index = client.index("movies")
@@ -4481,16 +4155,13 @@ class AsyncIndex(_BaseIndex):
4481
4155
  """Get proximity precision settings for the index.
4482
4156
 
4483
4157
  Returns:
4484
-
4485
4158
  Proximity precision for the index.
4486
4159
 
4487
4160
  Raises:
4488
-
4489
4161
  MeilisearchCommunicationError: If there was an error communicating with the server.
4490
4162
  MeilisearchApiError: If the Meilisearch API returned an error.
4491
4163
 
4492
- Examples:
4493
-
4164
+ Examples
4494
4165
  >>> from meilisearch_async_client import AsyncClient
4495
4166
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4496
4167
  >>> index = client.index("movies")
@@ -4506,21 +4177,17 @@ class AsyncIndex(_BaseIndex):
4506
4177
  """Update the proximity precision settings for an index.
4507
4178
 
4508
4179
  Args:
4509
-
4510
4180
  proximity_precision: The proximity precision value.
4511
4181
  compress: If set to True the data will be sent in gzip format. Defaults to False.
4512
4182
 
4513
4183
  Returns:
4514
-
4515
4184
  Task to track the action.
4516
4185
 
4517
4186
  Raises:
4518
-
4519
4187
  MeilisearchCommunicationError: If there was an error communicating with the server.
4520
4188
  MeilisearchApiError: If the Meilisearch API returned an error.
4521
4189
 
4522
- Examples:
4523
-
4190
+ Examples
4524
4191
  >>> from meilisearch_python_sdk import AsyncClient
4525
4192
  >>> from meilisearch_python_sdk.models.settings import ProximityPrecision
4526
4193
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
@@ -4539,16 +4206,13 @@ class AsyncIndex(_BaseIndex):
4539
4206
  """Reset an index's proximity precision settings to the default value.
4540
4207
 
4541
4208
  Returns:
4542
-
4543
4209
  The details of the task status.
4544
4210
 
4545
4211
  Raises:
4546
-
4547
4212
  MeilisearchCommunicationError: If there was an error communicating with the server.
4548
4213
  MeilisearchApiError: If the Meilisearch API returned an error.
4549
4214
 
4550
- Examples:
4551
-
4215
+ Examples
4552
4216
  >>> from meilisearch_async_client import AsyncClient
4553
4217
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4554
4218
  >>> index = client.index("movies")
@@ -4562,16 +4226,13 @@ class AsyncIndex(_BaseIndex):
4562
4226
  """Get embedder settings for the index.
4563
4227
 
4564
4228
  Returns:
4565
-
4566
4229
  Embedders for the index.
4567
4230
 
4568
4231
  Raises:
4569
-
4570
4232
  MeilisearchCommunicationError: If there was an error communicating with the server.
4571
4233
  MeilisearchApiError: If the Meilisearch API returned an error.
4572
4234
 
4573
- Examples:
4574
-
4235
+ Examples
4575
4236
  >>> from meilisearch_async_client import AsyncClient
4576
4237
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4577
4238
  >>> index = client.index("movies")
@@ -4585,21 +4246,17 @@ class AsyncIndex(_BaseIndex):
4585
4246
  """Update the embedders settings for an index.
4586
4247
 
4587
4248
  Args:
4588
-
4589
4249
  embedders: The embedders value.
4590
4250
  compress: If set to True the data will be sent in gzip format. Defaults to False.
4591
4251
 
4592
4252
  Returns:
4593
-
4594
4253
  Task to track the action.
4595
4254
 
4596
4255
  Raises:
4597
-
4598
4256
  MeilisearchCommunicationError: If there was an error communicating with the server.
4599
4257
  MeilisearchApiError: If the Meilisearch API returned an error.
4600
4258
 
4601
- Examples:
4602
-
4259
+ Examples
4603
4260
  >>> from meilisearch_python_sdk import AsyncClient
4604
4261
  >>> from meilisearch_python_sdk.models.settings import Embedders, UserProvidedEmbedder
4605
4262
  >>>
@@ -4626,16 +4283,13 @@ class AsyncIndex(_BaseIndex):
4626
4283
  """Reset an index's embedders settings to the default value.
4627
4284
 
4628
4285
  Returns:
4629
-
4630
4286
  The details of the task status.
4631
4287
 
4632
4288
  Raises:
4633
-
4634
4289
  MeilisearchCommunicationError: If there was an error communicating with the server.
4635
4290
  MeilisearchApiError: If the Meilisearch API returned an error.
4636
4291
 
4637
- Examples:
4638
-
4292
+ Examples
4639
4293
  >>> from meilisearch_async_client import AsyncClient
4640
4294
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4641
4295
  >>> index = client.index("movies")
@@ -4649,16 +4303,13 @@ class AsyncIndex(_BaseIndex):
4649
4303
  """Get localized attributes settings for the index.
4650
4304
 
4651
4305
  Returns:
4652
-
4653
4306
  Localized attributes for the index.
4654
4307
 
4655
4308
  Raises:
4656
-
4657
4309
  MeilisearchCommunicationError: If there was an error communicating with the server.
4658
4310
  MeilisearchApiError: If the Meilisearch API returned an error.
4659
4311
 
4660
- Examples:
4661
-
4312
+ Examples
4662
4313
  >>> from meilisearch_async_client import AsyncClient
4663
4314
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4664
4315
  >>> index = client.index("movies")
@@ -4677,21 +4328,17 @@ class AsyncIndex(_BaseIndex):
4677
4328
  """Update the localized attributes settings for an index.
4678
4329
 
4679
4330
  Args:
4680
-
4681
4331
  localized_attributes: The localized attributes value.
4682
4332
  compress: If set to True the data will be sent in gzip format. Defaults to False.
4683
4333
 
4684
4334
  Returns:
4685
-
4686
4335
  Task to track the action.
4687
4336
 
4688
4337
  Raises:
4689
-
4690
4338
  MeilisearchCommunicationError: If there was an error communicating with the server.
4691
4339
  MeilisearchApiError: If the Meilisearch API returned an error.
4692
4340
 
4693
- Examples:
4694
-
4341
+ Examples
4695
4342
  >>> from meilisearch_python_sdk import AsyncClient
4696
4343
  >>> from meilisearch_python_sdk.models.settings import LocalizedAttributes
4697
4344
  >>>
@@ -4714,16 +4361,13 @@ class AsyncIndex(_BaseIndex):
4714
4361
  """Reset an index's localized attributes settings to the default value.
4715
4362
 
4716
4363
  Returns:
4717
-
4718
4364
  The details of the task status.
4719
4365
 
4720
4366
  Raises:
4721
-
4722
4367
  MeilisearchCommunicationError: If there was an error communicating with the server.
4723
4368
  MeilisearchApiError: If the Meilisearch API returned an error.
4724
4369
 
4725
- Examples:
4726
-
4370
+ Examples
4727
4371
  >>> from meilisearch_async_client import AsyncClient
4728
4372
  >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
4729
4373
  >>> index = client.index("movies")
@@ -4823,7 +4467,6 @@ class Index(_BaseIndex):
4823
4467
  """Class initializer.
4824
4468
 
4825
4469
  Args:
4826
-
4827
4470
  http_client: An instance of the Client. This automatically gets passed by the
4828
4471
  Client when creating and Index instance.
4829
4472
  uid: The index's unique identifier.
@@ -4855,10 +4498,7 @@ class Index(_BaseIndex):
4855
4498
  if not self.plugins or not self.plugins.add_documents_plugins:
4856
4499
  return None
4857
4500
 
4858
- plugins = []
4859
- for plugin in self.plugins.add_documents_plugins:
4860
- if plugin.POST_EVENT:
4861
- plugins.append(plugin)
4501
+ plugins = [plugin for plugin in self.plugins.add_documents_plugins if plugin.POST_EVENT]
4862
4502
 
4863
4503
  if not plugins:
4864
4504
  return None
@@ -4870,10 +4510,7 @@ class Index(_BaseIndex):
4870
4510
  if not self.plugins or not self.plugins.add_documents_plugins:
4871
4511
  return None
4872
4512
 
4873
- plugins = []
4874
- for plugin in self.plugins.add_documents_plugins:
4875
- if plugin.PRE_EVENT:
4876
- plugins.append(plugin)
4513
+ plugins = [plugin for plugin in self.plugins.add_documents_plugins if plugin.PRE_EVENT]
4877
4514
 
4878
4515
  if not plugins:
4879
4516
  return None
@@ -4885,10 +4522,9 @@ class Index(_BaseIndex):
4885
4522
  if not self.plugins or not self.plugins.delete_all_documents_plugins:
4886
4523
  return None
4887
4524
 
4888
- plugins = []
4889
- for plugin in self.plugins.delete_all_documents_plugins:
4890
- if plugin.POST_EVENT:
4891
- plugins.append(plugin)
4525
+ plugins = [
4526
+ plugin for plugin in self.plugins.delete_all_documents_plugins if plugin.POST_EVENT
4527
+ ]
4892
4528
 
4893
4529
  if not plugins:
4894
4530
  return None
@@ -4900,10 +4536,9 @@ class Index(_BaseIndex):
4900
4536
  if not self.plugins or not self.plugins.delete_all_documents_plugins:
4901
4537
  return None
4902
4538
 
4903
- plugins = []
4904
- for plugin in self.plugins.delete_all_documents_plugins:
4905
- if plugin.PRE_EVENT:
4906
- plugins.append(plugin)
4539
+ plugins = [
4540
+ plugin for plugin in self.plugins.delete_all_documents_plugins if plugin.PRE_EVENT
4541
+ ]
4907
4542
 
4908
4543
  if not plugins:
4909
4544
  return None
@@ -4915,10 +4550,7 @@ class Index(_BaseIndex):
4915
4550
  if not self.plugins or not self.plugins.delete_document_plugins:
4916
4551
  return None
4917
4552
 
4918
- plugins = []
4919
- for plugin in self.plugins.delete_document_plugins:
4920
- if plugin.POST_EVENT:
4921
- plugins.append(plugin)
4553
+ plugins = [plugin for plugin in self.plugins.delete_document_plugins if plugin.POST_EVENT]
4922
4554
 
4923
4555
  if not plugins:
4924
4556
  return None
@@ -4930,10 +4562,7 @@ class Index(_BaseIndex):
4930
4562
  if not self.plugins or not self.plugins.delete_document_plugins:
4931
4563
  return None
4932
4564
 
4933
- plugins = []
4934
- for plugin in self.plugins.delete_document_plugins:
4935
- if plugin.PRE_EVENT:
4936
- plugins.append(plugin)
4565
+ plugins = [plugin for plugin in self.plugins.delete_document_plugins if plugin.PRE_EVENT]
4937
4566
 
4938
4567
  if not plugins:
4939
4568
  return None
@@ -4945,10 +4574,7 @@ class Index(_BaseIndex):
4945
4574
  if not self.plugins or not self.plugins.delete_documents_plugins:
4946
4575
  return None
4947
4576
 
4948
- plugins = []
4949
- for plugin in self.plugins.delete_documents_plugins:
4950
- if plugin.POST_EVENT:
4951
- plugins.append(plugin)
4577
+ plugins = [plugin for plugin in self.plugins.delete_documents_plugins if plugin.POST_EVENT]
4952
4578
 
4953
4579
  if not plugins:
4954
4580
  return None
@@ -4960,10 +4586,7 @@ class Index(_BaseIndex):
4960
4586
  if not self.plugins or not self.plugins.delete_documents_plugins:
4961
4587
  return None
4962
4588
 
4963
- plugins = []
4964
- for plugin in self.plugins.delete_documents_plugins:
4965
- if plugin.PRE_EVENT:
4966
- plugins.append(plugin)
4589
+ plugins = [plugin for plugin in self.plugins.delete_documents_plugins if plugin.PRE_EVENT]
4967
4590
 
4968
4591
  if not plugins:
4969
4592
  return None
@@ -4975,10 +4598,11 @@ class Index(_BaseIndex):
4975
4598
  if not self.plugins or not self.plugins.delete_documents_by_filter_plugins:
4976
4599
  return None
4977
4600
 
4978
- plugins = []
4979
- for plugin in self.plugins.delete_documents_by_filter_plugins:
4980
- if plugin.POST_EVENT:
4981
- plugins.append(plugin)
4601
+ plugins = [
4602
+ plugin
4603
+ for plugin in self.plugins.delete_documents_by_filter_plugins
4604
+ if plugin.POST_EVENT
4605
+ ]
4982
4606
 
4983
4607
  if not plugins:
4984
4608
  return None
@@ -4990,10 +4614,9 @@ class Index(_BaseIndex):
4990
4614
  if not self.plugins or not self.plugins.delete_documents_by_filter_plugins:
4991
4615
  return None
4992
4616
 
4993
- plugins = []
4994
- for plugin in self.plugins.delete_documents_by_filter_plugins:
4995
- if plugin.PRE_EVENT:
4996
- plugins.append(plugin)
4617
+ plugins = [
4618
+ plugin for plugin in self.plugins.delete_documents_by_filter_plugins if plugin.PRE_EVENT
4619
+ ]
4997
4620
 
4998
4621
  if not plugins:
4999
4622
  return None
@@ -5005,10 +4628,7 @@ class Index(_BaseIndex):
5005
4628
  if not self.plugins or not self.plugins.facet_search_plugins:
5006
4629
  return None
5007
4630
 
5008
- plugins = []
5009
- for plugin in self.plugins.facet_search_plugins:
5010
- if plugin.POST_EVENT:
5011
- plugins.append(plugin)
4631
+ plugins = [plugin for plugin in self.plugins.facet_search_plugins if plugin.POST_EVENT]
5012
4632
 
5013
4633
  if not plugins:
5014
4634
  return None
@@ -5020,10 +4640,7 @@ class Index(_BaseIndex):
5020
4640
  if not self.plugins or not self.plugins.facet_search_plugins:
5021
4641
  return None
5022
4642
 
5023
- plugins = []
5024
- for plugin in self.plugins.facet_search_plugins:
5025
- if plugin.PRE_EVENT:
5026
- plugins.append(plugin)
4643
+ plugins = [plugin for plugin in self.plugins.facet_search_plugins if plugin.PRE_EVENT]
5027
4644
 
5028
4645
  if not plugins:
5029
4646
  return None
@@ -5035,10 +4652,7 @@ class Index(_BaseIndex):
5035
4652
  if not self.plugins or not self.plugins.search_plugins:
5036
4653
  return None
5037
4654
 
5038
- plugins = []
5039
- for plugin in self.plugins.search_plugins:
5040
- if plugin.POST_EVENT:
5041
- plugins.append(plugin)
4655
+ plugins = [plugin for plugin in self.plugins.search_plugins if plugin.POST_EVENT]
5042
4656
 
5043
4657
  if not plugins:
5044
4658
  return None
@@ -5050,10 +4664,7 @@ class Index(_BaseIndex):
5050
4664
  if not self.plugins or not self.plugins.search_plugins:
5051
4665
  return None
5052
4666
 
5053
- plugins = []
5054
- for plugin in self.plugins.search_plugins:
5055
- if plugin.PRE_EVENT:
5056
- plugins.append(plugin)
4667
+ plugins = [plugin for plugin in self.plugins.search_plugins if plugin.PRE_EVENT]
5057
4668
 
5058
4669
  if not plugins:
5059
4670
  return None
@@ -5065,10 +4676,7 @@ class Index(_BaseIndex):
5065
4676
  if not self.plugins or not self.plugins.update_documents_plugins:
5066
4677
  return None
5067
4678
 
5068
- plugins = []
5069
- for plugin in self.plugins.update_documents_plugins:
5070
- if plugin.POST_EVENT:
5071
- plugins.append(plugin)
4679
+ plugins = [plugin for plugin in self.plugins.update_documents_plugins if plugin.POST_EVENT]
5072
4680
 
5073
4681
  if not plugins:
5074
4682
  return None
@@ -5080,10 +4688,7 @@ class Index(_BaseIndex):
5080
4688
  if not self.plugins or not self.plugins.update_documents_plugins:
5081
4689
  return None
5082
4690
 
5083
- plugins = []
5084
- for plugin in self.plugins.update_documents_plugins:
5085
- if plugin.PRE_EVENT:
5086
- plugins.append(plugin)
4691
+ plugins = [plugin for plugin in self.plugins.update_documents_plugins if plugin.PRE_EVENT]
5087
4692
 
5088
4693
  if not plugins:
5089
4694
  return None
@@ -5094,16 +4699,13 @@ class Index(_BaseIndex):
5094
4699
  """Deletes the index.
5095
4700
 
5096
4701
  Returns:
5097
-
5098
4702
  The details of the task.
5099
4703
 
5100
4704
  Raises:
5101
-
5102
4705
  MeilisearchCommunicationError: If there was an error communicating with the server.
5103
4706
  MeilisearchApiError: If the Meilisearch API returned an error.
5104
4707
 
5105
- Examples:
5106
-
4708
+ Examples
5107
4709
  >>> from meilisearch_python_sdk import Client
5108
4710
  >>> client = Client("http://localhost.com", "masterKey")
5109
4711
  >>> index = client.index("movies")
@@ -5116,16 +4718,13 @@ class Index(_BaseIndex):
5116
4718
  """Delete the index if it already exists.
5117
4719
 
5118
4720
  Returns:
5119
-
5120
4721
  True if the index was deleted or False if not.
5121
4722
 
5122
4723
  Raises:
5123
-
5124
4724
  MeilisearchCommunicationError: If there was an error communicating with the server.
5125
4725
  MeilisearchApiError: If the Meilisearch API returned an error.
5126
4726
 
5127
- Examples:
5128
-
4727
+ Examples
5129
4728
  >>> from meilisearch_python_sdk import Client
5130
4729
  >>> client = Client("http://localhost.com", "masterKey")
5131
4730
  >>> index = client.index("movies")
@@ -5142,20 +4741,16 @@ class Index(_BaseIndex):
5142
4741
  """Update the index primary key.
5143
4742
 
5144
4743
  Args:
5145
-
5146
4744
  primary_key: The primary key of the documents.
5147
4745
 
5148
4746
  Returns:
5149
-
5150
4747
  An instance of the AsyncIndex with the updated information.
5151
4748
 
5152
4749
  Raises:
5153
-
5154
4750
  MeilisearchCommunicationError: If there was an error communicating with the server.
5155
4751
  MeilisearchApiError: If the Meilisearch API returned an error.
5156
4752
 
5157
- Examples:
5158
-
4753
+ Examples
5159
4754
  >>> from meilisearch_python_sdk import Client
5160
4755
  >>> client = Client("http://localhost.com", "masterKey")
5161
4756
  >>> index = client.index("movies")
@@ -5172,16 +4767,13 @@ class Index(_BaseIndex):
5172
4767
  """Gets the infromation about the index.
5173
4768
 
5174
4769
  Returns:
5175
-
5176
4770
  An instance of the AsyncIndex containing the retrieved information.
5177
4771
 
5178
4772
  Raises:
5179
-
5180
4773
  MeilisearchCommunicationError: If there was an error communicating with the server.
5181
4774
  MeilisearchApiError: If the Meilisearch API returned an error.
5182
4775
 
5183
- Examples:
5184
-
4776
+ Examples
5185
4777
  >>> from meilisearch_python_sdk import Client
5186
4778
  >>> client = Client("http://localhost.com", "masterKey")
5187
4779
  >>> index = client.index("movies")
@@ -5198,16 +4790,13 @@ class Index(_BaseIndex):
5198
4790
  """Get the primary key.
5199
4791
 
5200
4792
  Returns:
5201
-
5202
4793
  The primary key for the documents in the index.
5203
4794
 
5204
4795
  Raises:
5205
-
5206
4796
  MeilisearchCommunicationError: If there was an error communicating with the server.
5207
4797
  MeilisearchApiError: If the Meilisearch API returned an error.
5208
4798
 
5209
- Examples:
5210
-
4799
+ Examples
5211
4800
  >>> from meilisearch_python_sdk import Client
5212
4801
  >>> client = Client("http://localhost.com", "masterKey")
5213
4802
  >>> index = client.index("movies")
@@ -5236,7 +4825,6 @@ class Index(_BaseIndex):
5236
4825
  through the `Client`.
5237
4826
 
5238
4827
  Args:
5239
-
5240
4828
  http_client: An instance of the Client. This automatically gets passed by the Client
5241
4829
  when creating an Index instance.
5242
4830
  uid: The index's unique identifier.
@@ -5261,16 +4849,13 @@ class Index(_BaseIndex):
5261
4849
  JsonDict
5262
4850
 
5263
4851
  Returns:
5264
-
5265
4852
  An instance of Index containing the information of the newly created index.
5266
4853
 
5267
4854
  Raises:
5268
-
5269
4855
  MeilisearchCommunicationError: If there was an error communicating with the server.
5270
4856
  MeilisearchApiError: If the Meilisearch API returned an error.
5271
4857
 
5272
- Examples:
5273
-
4858
+ Examples
5274
4859
  >>> from meilisearch_python_sdk import Client
5275
4860
  >>> client = Client("http://localhost.com", "masterKey")
5276
4861
  >>> index = index.create(client, "movies")
@@ -5309,16 +4894,13 @@ class Index(_BaseIndex):
5309
4894
  """Get stats of the index.
5310
4895
 
5311
4896
  Returns:
5312
-
5313
4897
  Stats of the index.
5314
4898
 
5315
4899
  Raises:
5316
-
5317
4900
  MeilisearchCommunicationError: If there was an error communicating with the server.
5318
4901
  MeilisearchApiError: If the Meilisearch API returned an error.
5319
4902
 
5320
- Examples:
5321
-
4903
+ Examples
5322
4904
  >>> from meilisearch_python_sdk import Client
5323
4905
  >>> client = Client("http://localhost.com", "masterKey")
5324
4906
  >>> index = client.index("movies")
@@ -5360,7 +4942,6 @@ class Index(_BaseIndex):
5360
4942
  """Search the index.
5361
4943
 
5362
4944
  Args:
5363
-
5364
4945
  query: String containing the word(s) to search
5365
4946
  offset: Number of documents to skip. Defaults to 0.
5366
4947
  limit: Maximum number of documents returned. Defaults to 20.
@@ -5419,16 +5000,13 @@ class Index(_BaseIndex):
5419
5000
  Milisearch >= v1.10.0. Defaults to None letting the Meilisearch pick.
5420
5001
 
5421
5002
  Returns:
5422
-
5423
5003
  Results of the search
5424
5004
 
5425
5005
  Raises:
5426
-
5427
5006
  MeilisearchCommunicationError: If there was an error communicating with the server.
5428
5007
  MeilisearchApiError: If the Meilisearch API returned an error.
5429
5008
 
5430
- Examples:
5431
-
5009
+ Examples
5432
5010
  >>> from meilisearch_python_sdk import Client
5433
5011
  >>> client = Client("http://localhost.com", "masterKey")
5434
5012
  >>> index = client.index("movies")
@@ -5535,7 +5113,6 @@ class Index(_BaseIndex):
5535
5113
  """Search the index.
5536
5114
 
5537
5115
  Args:
5538
-
5539
5116
  query: String containing the word(s) to search
5540
5117
  facet_name: The name of the facet to search
5541
5118
  facet_query: The facet search value
@@ -5586,16 +5163,13 @@ class Index(_BaseIndex):
5586
5163
  Milisearch >= v1.10.0. Defaults to None letting the Meilisearch pick.
5587
5164
 
5588
5165
  Returns:
5589
-
5590
5166
  Results of the search
5591
5167
 
5592
5168
  Raises:
5593
-
5594
5169
  MeilisearchCommunicationError: If there was an error communicating with the server.
5595
5170
  MeilisearchApiError: If the Meilisearch API returned an error.
5596
5171
 
5597
- Examples:
5598
-
5172
+ Examples
5599
5173
  >>> from meilisearch_python_sdk import Client
5600
5174
  >>> client = Client("http://localhost.com", "masterKey")
5601
5175
  >>> index = client.index("movies")
@@ -5705,16 +5279,13 @@ class Index(_BaseIndex):
5705
5279
  to None.
5706
5280
 
5707
5281
  Returns:
5708
-
5709
5282
  Results of the search
5710
5283
 
5711
5284
  Raises:
5712
-
5713
5285
  MeilisearchCommunicationError: If there was an error communicating with the server.
5714
5286
  MeilisearchApiError: If the Meilisearch API returned an error.
5715
5287
 
5716
- Examples:
5717
-
5288
+ Examples
5718
5289
  >>> from meilisearch_python_sdk import Client
5719
5290
  >>> client = Client("http://localhost.com", "masterKey")
5720
5291
  >>> index = client.index("movies")
@@ -5744,20 +5315,16 @@ class Index(_BaseIndex):
5744
5315
  """Get one document with given document identifier.
5745
5316
 
5746
5317
  Args:
5747
-
5748
5318
  document_id: Unique identifier of the document.
5749
5319
 
5750
5320
  Returns:
5751
-
5752
5321
  The document information
5753
5322
 
5754
5323
  Raises:
5755
-
5756
5324
  MeilisearchCommunicationError: If there was an error communicating with the server.
5757
5325
  MeilisearchApiError: If the Meilisearch API returned an error.
5758
5326
 
5759
- Examples:
5760
-
5327
+ Examples
5761
5328
  >>> from meilisearch_python_sdk import Client
5762
5329
  >>> client = Client("http://localhost.com", "masterKey")
5763
5330
  >>> index = client.index("movies")
@@ -5778,7 +5345,6 @@ class Index(_BaseIndex):
5778
5345
  """Get a batch documents from the index.
5779
5346
 
5780
5347
  Args:
5781
-
5782
5348
  offset: Number of documents to skip. Defaults to 0.
5783
5349
  limit: Maximum number of documents returnedd. Defaults to 20.
5784
5350
  fields: Document attributes to show. If this value is None then all
@@ -5787,17 +5353,14 @@ class Index(_BaseIndex):
5787
5353
  used with Meilisearch >= v1.2.0
5788
5354
 
5789
5355
  Returns:
5790
-
5791
5356
  Documents info.
5792
5357
 
5793
5358
  Raises:
5794
-
5795
5359
  MeilisearchCommunicationError: If there was an error communicating with the server.
5796
5360
  MeilisearchApiError: If the Meilisearch API returned an error.
5797
5361
 
5798
5362
 
5799
- Examples:
5800
-
5363
+ Examples
5801
5364
  >>> from meilisearch_python_sdk import Client
5802
5365
  >>> client = Client("http://localhost.com", "masterKey")
5803
5366
  >>> index = client.index("movies")
@@ -5835,23 +5398,19 @@ class Index(_BaseIndex):
5835
5398
  """Add documents to the index.
5836
5399
 
5837
5400
  Args:
5838
-
5839
5401
  documents: List of documents.
5840
5402
  primary_key: The primary key of the documents. This will be ignored if already set.
5841
5403
  Defaults to None.
5842
5404
  compress: If set to True the data will be sent in gzip format. Defaults to False.
5843
5405
 
5844
5406
  Returns:
5845
-
5846
5407
  The details of the task.
5847
5408
 
5848
5409
  Raises:
5849
-
5850
5410
  MeilisearchCommunicationError: If there was an error communicating with the server.
5851
5411
  MeilisearchApiError: If the Meilisearch API returned an error.
5852
5412
 
5853
- Examples:
5854
-
5413
+ Examples
5855
5414
  >>> from meilisearch_python_sdk import Client
5856
5415
  >>> documents = [
5857
5416
  >>> {"id": 1, "title": "Movie 1", "genre": "comedy"},
@@ -5896,7 +5455,6 @@ class Index(_BaseIndex):
5896
5455
  """Adds documents in batches to reduce RAM usage with indexing.
5897
5456
 
5898
5457
  Args:
5899
-
5900
5458
  documents: List of documents.
5901
5459
  batch_size: The number of documents that should be included in each batch.
5902
5460
  Defaults to 1000.
@@ -5905,16 +5463,13 @@ class Index(_BaseIndex):
5905
5463
  compress: If set to True the data will be sent in gzip format. Defaults to False.
5906
5464
 
5907
5465
  Returns:
5908
-
5909
5466
  List of update ids to track the action.
5910
5467
 
5911
5468
  Raises:
5912
-
5913
5469
  MeilisearchCommunicationError: If there was an error communicating with the server.
5914
5470
  MeilisearchApiError: If the Meilisearch API returned an error.
5915
5471
 
5916
- Examples:
5917
-
5472
+ Examples
5918
5473
  >>> from meilisearch_python_sdk import Client
5919
5474
  >>> >>> documents = [
5920
5475
  >>> {"id": 1, "title": "Movie 1", "genre": "comedy"},
@@ -5942,7 +5497,6 @@ class Index(_BaseIndex):
5942
5497
  """Load all json files from a directory and add the documents to the index.
5943
5498
 
5944
5499
  Args:
5945
-
5946
5500
  directory_path: Path to the directory that contains the json files.
5947
5501
  primary_key: The primary key of the documents. This will be ignored if already set.
5948
5502
  Defaults to None.
@@ -5956,18 +5510,15 @@ class Index(_BaseIndex):
5956
5510
  compress: If set to True the data will be sent in gzip format. Defaults to False.
5957
5511
 
5958
5512
  Returns:
5959
-
5960
5513
  The details of the task status.
5961
5514
 
5962
5515
  Raises:
5963
-
5964
5516
  InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
5965
5517
  MeilisearchError: If the file path is not valid
5966
5518
  MeilisearchCommunicationError: If there was an error communicating with the server.
5967
5519
  MeilisearchApiError: If the Meilisearch API returned an error.
5968
5520
 
5969
- Examples:
5970
-
5521
+ Examples
5971
5522
  >>> from pathlib import Path
5972
5523
  >>> from meilisearch_python_sdk import Client
5973
5524
  >>> directory_path = Path("/path/to/directory/containing/files")
@@ -6020,7 +5571,6 @@ class Index(_BaseIndex):
6020
5571
  """Load all json files from a directory and add the documents to the index in batches.
6021
5572
 
6022
5573
  Args:
6023
-
6024
5574
  directory_path: Path to the directory that contains the json files.
6025
5575
  batch_size: The number of documents that should be included in each batch.
6026
5576
  Defaults to 1000.
@@ -6036,18 +5586,15 @@ class Index(_BaseIndex):
6036
5586
  compress: If set to True the data will be sent in gzip format. Defaults to False.
6037
5587
 
6038
5588
  Returns:
6039
-
6040
5589
  List of update ids to track the action.
6041
5590
 
6042
5591
  Raises:
6043
-
6044
5592
  InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
6045
5593
  MeilisearchError: If the file path is not valid
6046
5594
  MeilisearchCommunicationError: If there was an error communicating with the server.
6047
5595
  MeilisearchApiError: If the Meilisearch API returned an error.
6048
5596
 
6049
- Examples:
6050
-
5597
+ Examples
6051
5598
  >>> from pathlib import Path
6052
5599
  >>> from meilisearch_python_sdk import Client
6053
5600
  >>> directory_path = Path("/path/to/directory/containing/files")
@@ -6106,25 +5653,21 @@ class Index(_BaseIndex):
6106
5653
  """Add documents to the index from a json file.
6107
5654
 
6108
5655
  Args:
6109
-
6110
5656
  file_path: Path to the json file.
6111
5657
  primary_key: The primary key of the documents. This will be ignored if already set.
6112
5658
  Defaults to None.
6113
5659
  compress: If set to True the data will be sent in gzip format. Defaults to False.
6114
5660
 
6115
5661
  Returns:
6116
-
6117
5662
  The details of the task status.
6118
5663
 
6119
5664
  Raises:
6120
-
6121
5665
  InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
6122
5666
  MeilisearchError: If the file path is not valid
6123
5667
  MeilisearchCommunicationError: If there was an error communicating with the server.
6124
5668
  MeilisearchApiError: If the Meilisearch API returned an error.
6125
5669
 
6126
- Examples:
6127
-
5670
+ Examples
6128
5671
  >>> from pathlib import Path
6129
5672
  >>> from meilisearch_python_sdk import Client
6130
5673
  >>> file_path = Path("/path/to/file.json")
@@ -6148,7 +5691,6 @@ class Index(_BaseIndex):
6148
5691
  """Adds documents form a json file in batches to reduce RAM usage with indexing.
6149
5692
 
6150
5693
  Args:
6151
-
6152
5694
  file_path: Path to the json file.
6153
5695
  batch_size: The number of documents that should be included in each batch.
6154
5696
  Defaults to 1000.
@@ -6159,18 +5701,15 @@ class Index(_BaseIndex):
6159
5701
  compress: If set to True the data will be sent in gzip format. Defaults to False.
6160
5702
 
6161
5703
  Returns:
6162
-
6163
5704
  List of update ids to track the action.
6164
5705
 
6165
5706
  Raises:
6166
-
6167
5707
  InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
6168
5708
  MeilisearchError: If the file path is not valid
6169
5709
  MeilisearchCommunicationError: If there was an error communicating with the server.
6170
5710
  MeilisearchApiError: If the Meilisearch API returned an error.
6171
5711
 
6172
- Examples:
6173
-
5712
+ Examples
6174
5713
  >>> from pathlib import Path
6175
5714
  >>> from meilisearch_python_sdk import Client
6176
5715
  >>> file_path = Path("/path/to/file.json")
@@ -6203,7 +5742,6 @@ class Index(_BaseIndex):
6203
5742
  for batching.
6204
5743
 
6205
5744
  Args:
6206
-
6207
5745
  file_path: The path to the file to send to Meilisearch. Only csv and ndjson files are
6208
5746
  allowed.
6209
5747
  primary_key: The primary key of the documents. This will be ignored if already set.
@@ -6213,19 +5751,16 @@ class Index(_BaseIndex):
6213
5751
  compress: If set to True the data will be sent in gzip format. Defaults to False.
6214
5752
 
6215
5753
  Returns:
6216
-
6217
5754
  The details of the task.
6218
5755
 
6219
5756
  Raises:
6220
-
6221
5757
  ValueError: If the file is not a csv or ndjson file, or if a csv_delimiter is sent for
6222
5758
  a non-csv file.
6223
5759
  MeilisearchError: If the file path is not valid
6224
5760
  MeilisearchCommunicationError: If there was an error communicating with the server.
6225
5761
  MeilisearchApiError: If the Meilisearch API returned an error.
6226
5762
 
6227
- Examples:
6228
-
5763
+ Examples
6229
5764
  >>> from pathlib import Path
6230
5765
  >>> from meilisearch_python_sdk import Client
6231
5766
  >>> file_path = Path("/path/to/file.csv")
@@ -6283,23 +5818,19 @@ class Index(_BaseIndex):
6283
5818
  sending a PATCH request to /experimental-features with { "editDocumentsByFunction": true }.
6284
5819
 
6285
5820
  Args:
6286
-
6287
5821
  function: Rhai function to use to update the documents.
6288
5822
  context: Parameters to use in the function. Defaults to None.
6289
5823
  filter: Filter the documents before applying the function. Defaults to None.
6290
5824
 
6291
5825
  Returns:
6292
-
6293
5826
  The details of the task.
6294
5827
 
6295
5828
  Raises:
6296
-
6297
5829
  MeilisearchError: If the file path is not valid
6298
5830
  MeilisearchCommunicationError: If there was an error communicating with the server.
6299
5831
  MeilisearchApiError: If the Meilisearch API returned an error.
6300
5832
 
6301
- Examples:
6302
-
5833
+ Examples
6303
5834
  >>> from meilisearch_python_sdk import Client
6304
5835
  >>> client = Client("http://localhost.com", "masterKey")
6305
5836
  >>> index = client.index("movies")
@@ -6328,23 +5859,19 @@ class Index(_BaseIndex):
6328
5859
  """Update documents in the index.
6329
5860
 
6330
5861
  Args:
6331
-
6332
5862
  documents: List of documents.
6333
5863
  primary_key: The primary key of the documents. This will be ignored if already set.
6334
5864
  Defaults to None.
6335
5865
  compress: If set to True the data will be sent in gzip format. Defaults to False.
6336
5866
 
6337
5867
  Returns:
6338
-
6339
5868
  The details of the task.
6340
5869
 
6341
5870
  Raises:
6342
-
6343
5871
  MeilisearchCommunicationError: If there was an error communicating with the server.
6344
5872
  MeilisearchApiError: If the Meilisearch API returned an error.
6345
5873
 
6346
- Examples:
6347
-
5874
+ Examples
6348
5875
  >>> from meilisearch_python_sdk import Client
6349
5876
  >>> documents = [
6350
5877
  >>> {"id": 1, "title": "Movie 1", "genre": "comedy"},
@@ -6393,7 +5920,6 @@ class Index(_BaseIndex):
6393
5920
  Each batch tries to fill the max_payload_size
6394
5921
 
6395
5922
  Args:
6396
-
6397
5923
  documents: List of documents.
6398
5924
  batch_size: The number of documents that should be included in each batch.
6399
5925
  Defaults to 1000.
@@ -6402,16 +5928,13 @@ class Index(_BaseIndex):
6402
5928
  compress: If set to True the data will be sent in gzip format. Defaults to False.
6403
5929
 
6404
5930
  Returns:
6405
-
6406
5931
  List of update ids to track the action.
6407
5932
 
6408
5933
  Raises:
6409
-
6410
5934
  MeilisearchCommunicationError: If there was an error communicating with the server.
6411
5935
  MeilisearchApiError: If the Meilisearch API returned an error.
6412
5936
 
6413
- Examples:
6414
-
5937
+ Examples
6415
5938
  >>> from meilisearch_python_sdk import Client
6416
5939
  >>> documents = [
6417
5940
  >>> {"id": 1, "title": "Movie 1", "genre": "comedy"},
@@ -6439,7 +5962,6 @@ class Index(_BaseIndex):
6439
5962
  """Load all json files from a directory and update the documents.
6440
5963
 
6441
5964
  Args:
6442
-
6443
5965
  directory_path: Path to the directory that contains the json files.
6444
5966
  primary_key: The primary key of the documents. This will be ignored if already set.
6445
5967
  Defaults to None.
@@ -6453,18 +5975,15 @@ class Index(_BaseIndex):
6453
5975
  compress: If set to True the data will be sent in gzip format. Defaults to False.
6454
5976
 
6455
5977
  Returns:
6456
-
6457
5978
  The details of the task status.
6458
5979
 
6459
5980
  Raises:
6460
-
6461
5981
  InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
6462
5982
  MeilisearchError: If the file path is not valid
6463
5983
  MeilisearchCommunicationError: If there was an error communicating with the server.
6464
5984
  MeilisearchApiError: If the Meilisearch API returned an error.
6465
5985
 
6466
- Examples:
6467
-
5986
+ Examples
6468
5987
  >>> from pathlib import Path
6469
5988
  >>> from meilisearch_python_sdk import Client
6470
5989
  >>> directory_path = Path("/path/to/directory/containing/files")
@@ -6516,7 +6035,6 @@ class Index(_BaseIndex):
6516
6035
  """Load all json files from a directory and update the documents.
6517
6036
 
6518
6037
  Args:
6519
-
6520
6038
  directory_path: Path to the directory that contains the json files.
6521
6039
  batch_size: The number of documents that should be included in each batch.
6522
6040
  Defaults to 1000.
@@ -6532,18 +6050,15 @@ class Index(_BaseIndex):
6532
6050
  compress: If set to True the data will be sent in gzip format. Defaults to False.
6533
6051
 
6534
6052
  Returns:
6535
-
6536
6053
  List of update ids to track the action.
6537
6054
 
6538
6055
  Raises:
6539
-
6540
6056
  InvalidDocumentError: If the docucment is not a valid format for Meilisearch.
6541
6057
  MeilisearchError: If the file path is not valid
6542
6058
  MeilisearchCommunicationError: If there was an error communicating with the server.
6543
6059
  MeilisearchApiError: If the Meilisearch API returned an error.
6544
6060
 
6545
- Examples:
6546
-
6061
+ Examples
6547
6062
  >>> from pathlib import Path
6548
6063
  >>> from meilisearch_python_sdk import Client
6549
6064
  >>> directory_path = Path("/path/to/directory/containing/files")
@@ -6604,7 +6119,6 @@ class Index(_BaseIndex):
6604
6119
  """Add documents in the index from a json file.
6605
6120
 
6606
6121
  Args:
6607
-
6608
6122
  file_path: Path to the json file.
6609
6123
  primary_key: The primary key of the documents. This will be ignored if already set.
6610
6124
  Defaults to None.
@@ -6613,16 +6127,13 @@ class Index(_BaseIndex):
6613
6127
  compress: If set to True the data will be sent in gzip format. Defaults to False.
6614
6128
 
6615
6129
  Returns:
6616
-
6617
6130
  The details of the task status.
6618
6131
 
6619
6132
  Raises:
6620
-
6621
6133
  MeilisearchCommunicationError: If there was an error communicating with the server.
6622
6134
  MeilisearchApiError: If the Meilisearch API returned an error.
6623
6135
 
6624
- Examples:
6625
-
6136
+ Examples
6626
6137
  >>> from pathlib import Path
6627
6138
  >>> from meilisearch_python_sdk import Client
6628
6139
  >>> file_path = Path("/path/to/file.json")
@@ -6647,7 +6158,6 @@ class Index(_BaseIndex):
6647
6158
  """Updates documents form a json file in batches to reduce RAM usage with indexing.
6648
6159
 
6649
6160
  Args:
6650
-
6651
6161
  file_path: Path to the json file.
6652
6162
  batch_size: The number of documents that should be included in each batch.
6653
6163
  Defaults to 1000.
@@ -6656,16 +6166,13 @@ class Index(_BaseIndex):
6656
6166
  compress: If set to True the data will be sent in gzip format. Defaults to False.
6657
6167
 
6658
6168
  Returns:
6659
-
6660
6169
  List of update ids to track the action.
6661
6170
 
6662
6171
  Raises:
6663
-
6664
6172
  MeilisearchCommunicationError: If there was an error communicating with the server.
6665
6173
  MeilisearchApiError: If the Meilisearch API returned an error.
6666
6174
 
6667
- Examples:
6668
-
6175
+ Examples
6669
6176
  >>> from pathlib import Path
6670
6177
  >>> from meilisearch_python_sdk import Client
6671
6178
  >>> file_path = Path("/path/to/file.json")
@@ -6696,7 +6203,6 @@ class Index(_BaseIndex):
6696
6203
  for batching.
6697
6204
 
6698
6205
  Args:
6699
-
6700
6206
  file_path: The path to the file to send to Meilisearch. Only csv and ndjson files are
6701
6207
  allowed.
6702
6208
  primary_key: The primary key of the documents. This will be ignored if already set.
@@ -6706,19 +6212,16 @@ class Index(_BaseIndex):
6706
6212
  compress: If set to True the data will be sent in gzip format. Defaults to False.
6707
6213
 
6708
6214
  Returns:
6709
-
6710
6215
  The details of the task status.
6711
6216
 
6712
6217
  Raises:
6713
-
6714
6218
  ValueError: If the file is not a csv or ndjson file, or if a csv_delimiter is sent for
6715
6219
  a non-csv file.
6716
6220
  MeilisearchError: If the file path is not valid
6717
6221
  MeilisearchCommunicationError: If there was an error communicating with the server.
6718
6222
  MeilisearchApiError: If the Meilisearch API returned an error.
6719
6223
 
6720
- Examples:
6721
-
6224
+ Examples
6722
6225
  >>> from pathlib import Path
6723
6226
  >>> from meilisearch_python_sdk import Client
6724
6227
  >>> file_path = Path("/path/to/file.csv")
@@ -6770,20 +6273,16 @@ class Index(_BaseIndex):
6770
6273
  """Delete one document from the index.
6771
6274
 
6772
6275
  Args:
6773
-
6774
6276
  document_id: Unique identifier of the document.
6775
6277
 
6776
6278
  Returns:
6777
-
6778
6279
  The details of the task status.
6779
6280
 
6780
6281
  Raises:
6781
-
6782
6282
  MeilisearchCommunicationError: If there was an error communicating with the server.
6783
6283
  MeilisearchApiError: If the Meilisearch API returned an error.
6784
6284
 
6785
- Examples:
6786
-
6285
+ Examples
6787
6286
  >>> from meilisearch_python_sdk import Client
6788
6287
  >>> client = Client("http://localhost.com", "masterKey")
6789
6288
  >>> index = client.index("movies")
@@ -6807,20 +6306,16 @@ class Index(_BaseIndex):
6807
6306
  """Delete multiple documents from the index.
6808
6307
 
6809
6308
  Args:
6810
-
6811
6309
  ids: List of unique identifiers of documents.
6812
6310
 
6813
6311
  Returns:
6814
-
6815
6312
  List of update ids to track the action.
6816
6313
 
6817
6314
  Raises:
6818
-
6819
6315
  MeilisearchCommunicationError: If there was an error communicating with the server.
6820
6316
  MeilisearchApiError: If the Meilisearch API returned an error.
6821
6317
 
6822
- Examples:
6823
-
6318
+ Examples
6824
6319
  >>> from meilisearch_python_sdk import Client
6825
6320
  >>> client = Client("http://localhost.com", "masterKey")
6826
6321
  >>> index = client.index("movies")
@@ -6844,20 +6339,16 @@ class Index(_BaseIndex):
6844
6339
  """Delete documents from the index by filter.
6845
6340
 
6846
6341
  Args:
6847
-
6848
6342
  filter: The filter value information.
6849
6343
 
6850
6344
  Returns:
6851
-
6852
6345
  The details of the task status.
6853
6346
 
6854
6347
  Raises:
6855
-
6856
6348
  MeilisearchCommunicationError: If there was an error communicating with the server.
6857
6349
  MeilisearchApiError: If the Meilisearch API returned an error.
6858
6350
 
6859
- Examples:
6860
-
6351
+ Examples
6861
6352
  >>> from meilisearch_python_sdk import Client
6862
6353
  >>> client = Client("http://localhost.com", "masterKey")
6863
6354
  >>> index = client.index("movies")
@@ -6887,20 +6378,16 @@ class Index(_BaseIndex):
6887
6378
  """Delete batches of documents from the index by filter.
6888
6379
 
6889
6380
  Args:
6890
-
6891
6381
  filters: A list of filter value information.
6892
6382
 
6893
6383
  Returns:
6894
-
6895
6384
  The a list of details of the task statuses.
6896
6385
 
6897
6386
  Raises:
6898
-
6899
6387
  MeilisearchCommunicationError: If there was an error communicating with the server.
6900
6388
  MeilisearchApiError: If the Meilisearch API returned an error.
6901
6389
 
6902
- Examples:
6903
-
6390
+ Examples
6904
6391
  >>> from meilisearch_python_sdk import Client
6905
6392
  >>> client = Client("http://localhost.com", "masterKey")
6906
6393
  >>> index = client.index("movies")
@@ -6917,16 +6404,13 @@ class Index(_BaseIndex):
6917
6404
  """Delete all documents from the index.
6918
6405
 
6919
6406
  Returns:
6920
-
6921
6407
  The details of the task status.
6922
6408
 
6923
6409
  Raises:
6924
-
6925
6410
  MeilisearchCommunicationError: If there was an error communicating with the server.
6926
6411
  MeilisearchApiError: If the Meilisearch API returned an error.
6927
6412
 
6928
- Examples:
6929
-
6413
+ Examples
6930
6414
  >>> from meilisearch_python_sdk import Client
6931
6415
  >>> client = Client("http://localhost.com", "masterKey")
6932
6416
  >>> index = client.index("movies")
@@ -6950,16 +6434,13 @@ class Index(_BaseIndex):
6950
6434
  """Get settings of the index.
6951
6435
 
6952
6436
  Returns:
6953
-
6954
6437
  Settings of the index.
6955
6438
 
6956
6439
  Raises:
6957
-
6958
6440
  MeilisearchCommunicationError: If there was an error communicating with the server.
6959
6441
  MeilisearchApiError: If the Meilisearch API returned an error.
6960
6442
 
6961
- Examples:
6962
-
6443
+ Examples
6963
6444
  >>> from meilisearch_python_sdk import Client
6964
6445
  >>> client = Client("http://localhost.com", "masterKey")
6965
6446
  >>> index = client.index("movies")
@@ -6981,21 +6462,17 @@ class Index(_BaseIndex):
6981
6462
  """Update settings of the index.
6982
6463
 
6983
6464
  Args:
6984
-
6985
6465
  body: Settings of the index.
6986
6466
  compress: If set to True the data will be sent in gzip format. Defaults to False.
6987
6467
 
6988
6468
  Returns:
6989
-
6990
6469
  The details of the task status.
6991
6470
 
6992
6471
  Raises:
6993
-
6994
6472
  MeilisearchCommunicationError: If there was an error communicating with the server.
6995
6473
  MeilisearchApiError: If the Meilisearch API returned an error.
6996
6474
 
6997
- Examples:
6998
-
6475
+ Examples
6999
6476
  >>> from meilisearch_python_sdk import Client
7000
6477
  >>> from meilisearch_python_sdk import MeilisearchSettings
7001
6478
  >>> new_settings = MeilisearchSettings(
@@ -7030,16 +6507,13 @@ class Index(_BaseIndex):
7030
6507
  """Reset settings of the index to default values.
7031
6508
 
7032
6509
  Returns:
7033
-
7034
6510
  The details of the task status.
7035
6511
 
7036
6512
  Raises:
7037
-
7038
6513
  MeilisearchCommunicationError: If there was an error communicating with the server.
7039
6514
  MeilisearchApiError: If the Meilisearch API returned an error.
7040
6515
 
7041
- Examples:
7042
-
6516
+ Examples
7043
6517
  >>> from meilisearch_python_sdk import Client
7044
6518
  >>> client = Client("http://localhost.com", "masterKey")
7045
6519
  >>> index = client.index("movies")
@@ -7053,16 +6527,13 @@ class Index(_BaseIndex):
7053
6527
  """Get ranking rules of the index.
7054
6528
 
7055
6529
  Returns:
7056
-
7057
6530
  List containing the ranking rules of the index.
7058
6531
 
7059
6532
  Raises:
7060
-
7061
6533
  MeilisearchCommunicationError: If there was an error communicating with the server.
7062
6534
  MeilisearchApiError: If the Meilisearch API returned an error.
7063
6535
 
7064
- Examples:
7065
-
6536
+ Examples
7066
6537
  >>> from meilisearch_python_sdk import Client
7067
6538
  >>> client = Client("http://localhost.com", "masterKey")
7068
6539
  >>> index = client.index("movies")
@@ -7076,21 +6547,17 @@ class Index(_BaseIndex):
7076
6547
  """Update ranking rules of the index.
7077
6548
 
7078
6549
  Args:
7079
-
7080
6550
  ranking_rules: List containing the ranking rules.
7081
6551
  compress: If set to True the data will be sent in gzip format. Defaults to False.
7082
6552
 
7083
6553
  Returns:
7084
-
7085
6554
  The details of the task status.
7086
6555
 
7087
6556
  Raises:
7088
-
7089
6557
  MeilisearchCommunicationError: If there was an error communicating with the server.
7090
6558
  MeilisearchApiError: If the Meilisearch API returned an error.
7091
6559
 
7092
- Examples:
7093
-
6560
+ Examples
7094
6561
  >>> from meilisearch_python_sdk import Client
7095
6562
  >>> ranking_rules=[
7096
6563
  >>> "words",
@@ -7116,16 +6583,13 @@ class Index(_BaseIndex):
7116
6583
  """Reset ranking rules of the index to default values.
7117
6584
 
7118
6585
  Returns:
7119
-
7120
6586
  The details of the task status.
7121
6587
 
7122
6588
  Raises:
7123
-
7124
6589
  MeilisearchCommunicationError: If there was an error communicating with the server.
7125
6590
  MeilisearchApiError: If the Meilisearch API returned an error.
7126
6591
 
7127
- Examples:
7128
-
6592
+ Examples
7129
6593
  >>> from meilisearch_python_sdk import Client
7130
6594
  >>> client = Client("http://localhost.com", "masterKey")
7131
6595
  >>> index = client.index("movies")
@@ -7139,17 +6603,14 @@ class Index(_BaseIndex):
7139
6603
  """Get distinct attribute of the index.
7140
6604
 
7141
6605
  Returns:
7142
-
7143
6606
  String containing the distinct attribute of the index. If no distinct attribute
7144
6607
  `None` is returned.
7145
6608
 
7146
6609
  Raises:
7147
-
7148
6610
  MeilisearchCommunicationError: If there was an error communicating with the server.
7149
6611
  MeilisearchApiError: If the Meilisearch API returned an error.
7150
6612
 
7151
- Examples:
7152
-
6613
+ Examples
7153
6614
  >>> from meilisearch_python_sdk import Client
7154
6615
  >>> client = Client("http://localhost.com", "masterKey")
7155
6616
  >>> index = client.index("movies")
@@ -7166,21 +6627,17 @@ class Index(_BaseIndex):
7166
6627
  """Update distinct attribute of the index.
7167
6628
 
7168
6629
  Args:
7169
-
7170
6630
  body: Distinct attribute.
7171
6631
  compress: If set to True the data will be sent in gzip format. Defaults to False.
7172
6632
 
7173
6633
  Returns:
7174
-
7175
6634
  The details of the task status.
7176
6635
 
7177
6636
  Raises:
7178
-
7179
6637
  MeilisearchCommunicationError: If there was an error communicating with the server.
7180
6638
  MeilisearchApiError: If the Meilisearch API returned an error.
7181
6639
 
7182
- Examples:
7183
-
6640
+ Examples
7184
6641
  >>> from meilisearch_python_sdk import Client
7185
6642
  >>> client = Client("http://localhost.com", "masterKey")
7186
6643
  >>> index = client.index("movies")
@@ -7196,16 +6653,13 @@ class Index(_BaseIndex):
7196
6653
  """Reset distinct attribute of the index to default values.
7197
6654
 
7198
6655
  Returns:
7199
-
7200
6656
  The details of the task status.
7201
6657
 
7202
6658
  Raises:
7203
-
7204
6659
  MeilisearchCommunicationError: If there was an error communicating with the server.
7205
6660
  MeilisearchApiError: If the Meilisearch API returned an error.
7206
6661
 
7207
- Examples:
7208
-
6662
+ Examples
7209
6663
  >>> from meilisearch_python_sdk import Client
7210
6664
  >>> client = Client("http://localhost.com", "masterKey")
7211
6665
  >>> index = client.index("movies")
@@ -7219,16 +6673,13 @@ class Index(_BaseIndex):
7219
6673
  """Get searchable attributes of the index.
7220
6674
 
7221
6675
  Returns:
7222
-
7223
6676
  List containing the searchable attributes of the index.
7224
6677
 
7225
6678
  Raises:
7226
-
7227
6679
  MeilisearchCommunicationError: If there was an error communicating with the server.
7228
6680
  MeilisearchApiError: If the Meilisearch API returned an error.
7229
6681
 
7230
- Examples:
7231
-
6682
+ Examples
7232
6683
  >>> from meilisearch_python_sdk import Client
7233
6684
  >>> client = Client("http://localhost.com", "masterKey")
7234
6685
  >>> index = client.index("movies")
@@ -7242,21 +6693,17 @@ class Index(_BaseIndex):
7242
6693
  """Update searchable attributes of the index.
7243
6694
 
7244
6695
  Args:
7245
-
7246
6696
  body: List containing the searchable attributes.
7247
6697
  compress: If set to True the data will be sent in gzip format. Defaults to False.
7248
6698
 
7249
6699
  Returns:
7250
-
7251
6700
  The details of the task status.
7252
6701
 
7253
6702
  Raises:
7254
-
7255
6703
  MeilisearchCommunicationError: If there was an error communicating with the server.
7256
6704
  MeilisearchApiError: If the Meilisearch API returned an error.
7257
6705
 
7258
- Examples:
7259
-
6706
+ Examples
7260
6707
  >>> from meilisearch_python_sdk import Client
7261
6708
  >>> client = Client("http://localhost.com", "masterKey")
7262
6709
  >>> index = client.index("movies")
@@ -7272,16 +6719,13 @@ class Index(_BaseIndex):
7272
6719
  """Reset searchable attributes of the index to default values.
7273
6720
 
7274
6721
  Returns:
7275
-
7276
6722
  The details of the task status.
7277
6723
 
7278
6724
  Raises:
7279
-
7280
6725
  MeilisearchCommunicationError: If there was an error communicating with the server.
7281
6726
  MeilisearchApiError: If the Meilisearch API returned an error.
7282
6727
 
7283
- Examples:
7284
-
6728
+ Examples
7285
6729
  >>> from meilisearch_python_sdk import Client
7286
6730
  >>> client = Client("http://localhost.com", "masterKey")
7287
6731
  >>> index = client.index("movies")
@@ -7295,16 +6739,13 @@ class Index(_BaseIndex):
7295
6739
  """Get displayed attributes of the index.
7296
6740
 
7297
6741
  Returns:
7298
-
7299
6742
  List containing the displayed attributes of the index.
7300
6743
 
7301
6744
  Raises:
7302
-
7303
6745
  MeilisearchCommunicationError: If there was an error communicating with the server.
7304
6746
  MeilisearchApiError: If the Meilisearch API returned an error.
7305
6747
 
7306
- Examples:
7307
-
6748
+ Examples
7308
6749
  >>> from meilisearch_python_sdk import Client
7309
6750
  >>> client = Client("http://localhost.com", "masterKey")
7310
6751
  >>> index = client.index("movies")
@@ -7318,21 +6759,17 @@ class Index(_BaseIndex):
7318
6759
  """Update displayed attributes of the index.
7319
6760
 
7320
6761
  Args:
7321
-
7322
6762
  body: List containing the displayed attributes.
7323
6763
  compress: If set to True the data will be sent in gzip format. Defaults to False.
7324
6764
 
7325
6765
  Returns:
7326
-
7327
6766
  The details of the task status.
7328
6767
 
7329
6768
  Raises:
7330
-
7331
6769
  MeilisearchCommunicationError: If there was an error communicating with the server.
7332
6770
  MeilisearchApiError: If the Meilisearch API returned an error.
7333
6771
 
7334
- Examples:
7335
-
6772
+ Examples
7336
6773
  >>> from meilisearch_python_sdk import Client
7337
6774
  >>> client = Client("http://localhost.com", "masterKey")
7338
6775
  >>> index = client.index("movies")
@@ -7350,16 +6787,13 @@ class Index(_BaseIndex):
7350
6787
  """Reset displayed attributes of the index to default values.
7351
6788
 
7352
6789
  Returns:
7353
-
7354
6790
  The details of the task status.
7355
6791
 
7356
6792
  Raises:
7357
-
7358
6793
  MeilisearchCommunicationError: If there was an error communicating with the server.
7359
6794
  MeilisearchApiError: If the Meilisearch API returned an error.
7360
6795
 
7361
- Examples:
7362
-
6796
+ Examples
7363
6797
  >>> from meilisearch_python_sdk import Client
7364
6798
  >>> client = Client("http://localhost.com", "masterKey")
7365
6799
  >>> index = client.index("movies")
@@ -7373,16 +6807,13 @@ class Index(_BaseIndex):
7373
6807
  """Get stop words of the index.
7374
6808
 
7375
6809
  Returns:
7376
-
7377
6810
  List containing the stop words of the index.
7378
6811
 
7379
6812
  Raises:
7380
-
7381
6813
  MeilisearchCommunicationError: If there was an error communicating with the server.
7382
6814
  MeilisearchApiError: If the Meilisearch API returned an error.
7383
6815
 
7384
- Examples:
7385
-
6816
+ Examples
7386
6817
  >>> from meilisearch_python_sdk import Client
7387
6818
  >>> client = Client("http://localhost.com", "masterKey")
7388
6819
  >>> index = client.index("movies")
@@ -7399,21 +6830,17 @@ class Index(_BaseIndex):
7399
6830
  """Update stop words of the index.
7400
6831
 
7401
6832
  Args:
7402
-
7403
6833
  body: List containing the stop words of the index.
7404
6834
  compress: If set to True the data will be sent in gzip format. Defaults to False.
7405
6835
 
7406
6836
  Returns:
7407
-
7408
6837
  The details of the task status.
7409
6838
 
7410
6839
  Raises:
7411
-
7412
6840
  MeilisearchCommunicationError: If there was an error communicating with the server.
7413
6841
  MeilisearchApiError: If the Meilisearch API returned an error.
7414
6842
 
7415
- Examples:
7416
-
6843
+ Examples
7417
6844
  >>> from meilisearch_python_sdk import Client
7418
6845
  >>> client = Client("http://localhost.com", "masterKey")
7419
6846
  >>> index = client.index("movies")
@@ -7429,16 +6856,13 @@ class Index(_BaseIndex):
7429
6856
  """Reset stop words of the index to default values.
7430
6857
 
7431
6858
  Returns:
7432
-
7433
6859
  The details of the task status.
7434
6860
 
7435
6861
  Raises:
7436
-
7437
6862
  MeilisearchCommunicationError: If there was an error communicating with the server.
7438
6863
  MeilisearchApiError: If the Meilisearch API returned an error.
7439
6864
 
7440
- Examples:
7441
-
6865
+ Examples
7442
6866
  >>> from meilisearch_python_sdk import Client
7443
6867
  >>> client = Client("http://localhost.com", "masterKey")
7444
6868
  >>> index = client.index("movies")
@@ -7452,16 +6876,13 @@ class Index(_BaseIndex):
7452
6876
  """Get synonyms of the index.
7453
6877
 
7454
6878
  Returns:
7455
-
7456
6879
  The synonyms of the index.
7457
6880
 
7458
6881
  Raises:
7459
-
7460
6882
  MeilisearchCommunicationError: If there was an error communicating with the server.
7461
6883
  MeilisearchApiError: If the Meilisearch API returned an error.
7462
6884
 
7463
- Examples:
7464
-
6885
+ Examples
7465
6886
  >>> from meilisearch_python_sdk import Client
7466
6887
  >>> client = Client("http://localhost.com", "masterKey")
7467
6888
  >>> index = client.index("movies")
@@ -7478,20 +6899,16 @@ class Index(_BaseIndex):
7478
6899
  """Update synonyms of the index.
7479
6900
 
7480
6901
  Args:
7481
-
7482
6902
  body: The synonyms of the index.
7483
6903
 
7484
6904
  Returns:
7485
-
7486
6905
  The details of the task status.
7487
6906
 
7488
6907
  Raises:
7489
-
7490
6908
  MeilisearchCommunicationError: If there was an error communicating with the server.
7491
6909
  MeilisearchApiError: If the Meilisearch API returned an error.
7492
6910
 
7493
- Examples:
7494
-
6911
+ Examples
7495
6912
  >>> from meilisearch_python_sdk import Client
7496
6913
  >>> client = Client("http://localhost.com", "masterKey") as client:
7497
6914
  >>> index = client.index("movies")
@@ -7509,16 +6926,13 @@ class Index(_BaseIndex):
7509
6926
  """Reset synonyms of the index to default values.
7510
6927
 
7511
6928
  Returns:
7512
-
7513
6929
  The details of the task status.
7514
6930
 
7515
6931
  Raises:
7516
-
7517
6932
  MeilisearchCommunicationError: If there was an error communicating with the server.
7518
6933
  MeilisearchApiError: If the Meilisearch API returned an error.
7519
6934
 
7520
- Examples:
7521
-
6935
+ Examples
7522
6936
  >>> from meilisearch_python_sdk import Client
7523
6937
  >>> client = Client("http://localhost.com", "masterKey")
7524
6938
  >>> index = client.index("movies")
@@ -7532,16 +6946,13 @@ class Index(_BaseIndex):
7532
6946
  """Get filterable attributes of the index.
7533
6947
 
7534
6948
  Returns:
7535
-
7536
6949
  List containing the filterable attributes of the index.
7537
6950
 
7538
6951
  Raises:
7539
-
7540
6952
  MeilisearchCommunicationError: If there was an error communicating with the server.
7541
6953
  MeilisearchApiError: If the Meilisearch API returned an error.
7542
6954
 
7543
- Examples:
7544
-
6955
+ Examples
7545
6956
  >>> from meilisearch_python_sdk import Client
7546
6957
  >>> client = Client("http://localhost.com", "masterKey")
7547
6958
  >>> index = client.index("movies")
@@ -7558,21 +6969,17 @@ class Index(_BaseIndex):
7558
6969
  """Update filterable attributes of the index.
7559
6970
 
7560
6971
  Args:
7561
-
7562
6972
  body: List containing the filterable attributes of the index.
7563
6973
  compress: If set to True the data will be sent in gzip format. Defaults to False.
7564
6974
 
7565
6975
  Returns:
7566
-
7567
6976
  The details of the task status.
7568
6977
 
7569
6978
  Raises:
7570
-
7571
6979
  MeilisearchCommunicationError: If there was an error communicating with the server.
7572
6980
  MeilisearchApiError: If the Meilisearch API returned an error.
7573
6981
 
7574
- Examples:
7575
-
6982
+ Examples
7576
6983
  >>> from meilisearch_python_sdk import Client
7577
6984
  >>> client = Client("http://localhost.com", "masterKey")
7578
6985
  >>> index = client.index("movies")
@@ -7588,16 +6995,13 @@ class Index(_BaseIndex):
7588
6995
  """Reset filterable attributes of the index to default values.
7589
6996
 
7590
6997
  Returns:
7591
-
7592
6998
  The details of the task status.
7593
6999
 
7594
7000
  Raises:
7595
-
7596
7001
  MeilisearchCommunicationError: If there was an error communicating with the server.
7597
7002
  MeilisearchApiError: If the Meilisearch API returned an error.
7598
7003
 
7599
- Examples:
7600
-
7004
+ Examples
7601
7005
  >>> from meilisearch_python_sdk import Client
7602
7006
  >>> client = Client("http://localhost.com", "masterKey")
7603
7007
  >>> index = client.index("movies")
@@ -7611,16 +7015,13 @@ class Index(_BaseIndex):
7611
7015
  """Get sortable attributes of the AsyncIndex.
7612
7016
 
7613
7017
  Returns:
7614
-
7615
7018
  List containing the sortable attributes of the AsyncIndex.
7616
7019
 
7617
7020
  Raises:
7618
-
7619
7021
  MeilisearchCommunicationError: If there was an error communicating with the server.
7620
7022
  MeilisearchApiError: If the Meilisearch API returned an error.
7621
7023
 
7622
- Examples:
7623
-
7024
+ Examples
7624
7025
  >>> from meilisearch_python_sdk import Client
7625
7026
  >>> client = Client("http://localhost.com", "masterKey")
7626
7027
  >>> index = client.index("movies")
@@ -7636,21 +7037,17 @@ class Index(_BaseIndex):
7636
7037
  """Get sortable attributes of the AsyncIndex.
7637
7038
 
7638
7039
  Args:
7639
-
7640
7040
  sortable_attributes: List of attributes for searching.
7641
7041
  compress: If set to True the data will be sent in gzip format. Defaults to False.
7642
7042
 
7643
7043
  Returns:
7644
-
7645
7044
  The details of the task status.
7646
7045
 
7647
7046
  Raises:
7648
-
7649
7047
  MeilisearchCommunicationError: If there was an error communicating with the server.
7650
7048
  MeilisearchApiError: If the Meilisearch API returned an error.
7651
7049
 
7652
- Examples:
7653
-
7050
+ Examples
7654
7051
  >>> from meilisearch_python_sdk import Client
7655
7052
  >>> client = Client("http://localhost.com", "masterKey")
7656
7053
  >>> index = client.index("movies")
@@ -7666,16 +7063,13 @@ class Index(_BaseIndex):
7666
7063
  """Reset sortable attributes of the index to default values.
7667
7064
 
7668
7065
  Returns:
7669
-
7670
7066
  The details of the task status.
7671
7067
 
7672
7068
  Raises:
7673
-
7674
7069
  MeilisearchCommunicationError: If there was an error communicating with the server.
7675
7070
  MeilisearchApiError: If the Meilisearch API returned an error.
7676
7071
 
7677
- Examples:
7678
-
7072
+ Examples
7679
7073
  >>> from meilisearch_python_sdk import Client
7680
7074
  >>> client = Client("http://localhost.com", "masterKey")
7681
7075
  >>> index = client.index("movies")
@@ -7689,16 +7083,13 @@ class Index(_BaseIndex):
7689
7083
  """Get typo tolerance for the index.
7690
7084
 
7691
7085
  Returns:
7692
-
7693
7086
  TypoTolerance for the index.
7694
7087
 
7695
7088
  Raises:
7696
-
7697
7089
  MeilisearchCommunicationError: If there was an error communicating with the server.
7698
7090
  MeilisearchApiError: If the Meilisearch API returned an error.
7699
7091
 
7700
- Examples:
7701
-
7092
+ Examples
7702
7093
  >>> from meilisearch_python_sdk import Client
7703
7094
  >>> client = Client("http://localhost.com", "masterKey")
7704
7095
  >>> index = client.index("movies")
@@ -7714,21 +7105,17 @@ class Index(_BaseIndex):
7714
7105
  """Update typo tolerance.
7715
7106
 
7716
7107
  Args:
7717
-
7718
7108
  typo_tolerance: Typo tolerance settings.
7719
7109
  compress: If set to True the data will be sent in gzip format. Defaults to False.
7720
7110
 
7721
7111
  Returns:
7722
-
7723
7112
  Task to track the action.
7724
7113
 
7725
7114
  Raises:
7726
-
7727
7115
  MeilisearchCommunicationError: If there was an error communicating with the server.
7728
7116
  MeilisearchApiError: If the Meilisearch API returned an error.
7729
7117
 
7730
- Examples:
7731
-
7118
+ Examples
7732
7119
  >>> from meilisearch_python_sdk import Client
7733
7120
  >>> client = Client("http://localhost.com", "masterKey")
7734
7121
  >>> index = client.index("movies")
@@ -7747,16 +7134,13 @@ class Index(_BaseIndex):
7747
7134
  """Reset typo tolerance to default values.
7748
7135
 
7749
7136
  Returns:
7750
-
7751
7137
  The details of the task status.
7752
7138
 
7753
7139
  Raises:
7754
-
7755
7140
  MeilisearchCommunicationError: If there was an error communicating with the server.
7756
7141
  MeilisearchApiError: If the Meilisearch API returned an error.
7757
7142
 
7758
- Examples:
7759
-
7143
+ Examples
7760
7144
  >>> from meilisearch_python_sdk import Client
7761
7145
  >>> client = Client("http://localhost.com", "masterKey")
7762
7146
  >>> index = client.index("movies")
@@ -7770,16 +7154,13 @@ class Index(_BaseIndex):
7770
7154
  """Get faceting for the index.
7771
7155
 
7772
7156
  Returns:
7773
-
7774
7157
  Faceting for the index.
7775
7158
 
7776
7159
  Raises:
7777
-
7778
7160
  MeilisearchCommunicationError: If there was an error communicating with the server.
7779
7161
  MeilisearchApiError: If the Meilisearch API returned an error.
7780
7162
 
7781
- Examples:
7782
-
7163
+ Examples
7783
7164
  >>> from meilisearch_python_sdk import Client
7784
7165
  >>> client = Client("http://localhost.com", "masterKey")
7785
7166
  >>> index = client.index("movies")
@@ -7793,21 +7174,17 @@ class Index(_BaseIndex):
7793
7174
  """Partially update the faceting settings for an index.
7794
7175
 
7795
7176
  Args:
7796
-
7797
7177
  faceting: Faceting values.
7798
7178
  compress: If set to True the data will be sent in gzip format. Defaults to False.
7799
7179
 
7800
7180
  Returns:
7801
-
7802
7181
  Task to track the action.
7803
7182
 
7804
7183
  Raises:
7805
-
7806
7184
  MeilisearchCommunicationError: If there was an error communicating with the server.
7807
7185
  MeilisearchApiError: If the Meilisearch API returned an error.
7808
7186
 
7809
- Examples:
7810
-
7187
+ Examples
7811
7188
  >>> from meilisearch_python_sdk import Client
7812
7189
  >>> client = Client("http://localhost.com", "masterKey")
7813
7190
  >>> index = client.index("movies")
@@ -7825,16 +7202,13 @@ class Index(_BaseIndex):
7825
7202
  """Reset an index's faceting settings to their default value.
7826
7203
 
7827
7204
  Returns:
7828
-
7829
7205
  The details of the task status.
7830
7206
 
7831
7207
  Raises:
7832
-
7833
7208
  MeilisearchCommunicationError: If there was an error communicating with the server.
7834
7209
  MeilisearchApiError: If the Meilisearch API returned an error.
7835
7210
 
7836
- Examples:
7837
-
7211
+ Examples
7838
7212
  >>> from meilisearch_python_sdk import Client
7839
7213
  >>> client = Client("http://localhost.com", "masterKey")
7840
7214
  >>> index = client.index("movies")
@@ -7848,16 +7222,13 @@ class Index(_BaseIndex):
7848
7222
  """Get pagination settings for the index.
7849
7223
 
7850
7224
  Returns:
7851
-
7852
7225
  Pagination for the index.
7853
7226
 
7854
7227
  Raises:
7855
-
7856
7228
  MeilisearchCommunicationError: If there was an error communicating with the server.
7857
7229
  MeilisearchApiError: If the Meilisearch API returned an error.
7858
7230
 
7859
- Examples:
7860
-
7231
+ Examples
7861
7232
  >>> from meilisearch_async_client import Client
7862
7233
  >>> client = Client("http://localhost.com", "masterKey")
7863
7234
  >>> index = client.index("movies")
@@ -7871,21 +7242,17 @@ class Index(_BaseIndex):
7871
7242
  """Partially update the pagination settings for an index.
7872
7243
 
7873
7244
  Args:
7874
-
7875
7245
  settings: settings for pagination.
7876
7246
  compress: If set to True the data will be sent in gzip format. Defaults to False.
7877
7247
 
7878
7248
  Returns:
7879
-
7880
7249
  Task to track the action.
7881
7250
 
7882
7251
  Raises:
7883
-
7884
7252
  MeilisearchCommunicationError: If there was an error communicating with the server.
7885
7253
  MeilisearchApiError: If the Meilisearch API returned an error.
7886
7254
 
7887
- Examples:
7888
-
7255
+ Examples
7889
7256
  >>> from meilisearch_python_sdk import Client
7890
7257
  >>> from meilisearch_python_sdk.models.settings import Pagination
7891
7258
  >>> client = Client("http://localhost.com", "masterKey")
@@ -7904,16 +7271,13 @@ class Index(_BaseIndex):
7904
7271
  """Reset an index's pagination settings to their default value.
7905
7272
 
7906
7273
  Returns:
7907
-
7908
7274
  The details of the task status.
7909
7275
 
7910
7276
  Raises:
7911
-
7912
7277
  MeilisearchCommunicationError: If there was an error communicating with the server.
7913
7278
  MeilisearchApiError: If the Meilisearch API returned an error.
7914
7279
 
7915
- Examples:
7916
-
7280
+ Examples
7917
7281
  >>> from meilisearch_async_client import Client
7918
7282
  >>> client = Client("http://localhost.com", "masterKey")
7919
7283
  >>> index = client.index("movies")
@@ -7927,16 +7291,13 @@ class Index(_BaseIndex):
7927
7291
  """Get separator token settings for the index.
7928
7292
 
7929
7293
  Returns:
7930
-
7931
7294
  Separator tokens for the index.
7932
7295
 
7933
7296
  Raises:
7934
-
7935
7297
  MeilisearchCommunicationError: If there was an error communicating with the server.
7936
7298
  MeilisearchApiError: If the Meilisearch API returned an error.
7937
7299
 
7938
- Examples:
7939
-
7300
+ Examples
7940
7301
  >>> from meilisearch_async_client import Client
7941
7302
  >>> client = Client("http://localhost.com", "masterKey")
7942
7303
  >>> index = client.index("movies")
@@ -7952,21 +7313,17 @@ class Index(_BaseIndex):
7952
7313
  """Update the separator tokens settings for an index.
7953
7314
 
7954
7315
  Args:
7955
-
7956
7316
  separator_tokens: List of separator tokens.
7957
7317
  compress: If set to True the data will be sent in gzip format. Defaults to False.
7958
7318
 
7959
7319
  Returns:
7960
-
7961
7320
  Task to track the action.
7962
7321
 
7963
7322
  Raises:
7964
-
7965
7323
  MeilisearchCommunicationError: If there was an error communicating with the server.
7966
7324
  MeilisearchApiError: If the Meilisearch API returned an error.
7967
7325
 
7968
- Examples:
7969
-
7326
+ Examples
7970
7327
  >>> from meilisearch_python_sdk import Client
7971
7328
  >>> client = Client("http://localhost.com", "masterKey")
7972
7329
  >>> index = client.index("movies")
@@ -7982,16 +7339,13 @@ class Index(_BaseIndex):
7982
7339
  """Reset an index's separator tokens settings to the default value.
7983
7340
 
7984
7341
  Returns:
7985
-
7986
7342
  The details of the task status.
7987
7343
 
7988
7344
  Raises:
7989
-
7990
7345
  MeilisearchCommunicationError: If there was an error communicating with the server.
7991
7346
  MeilisearchApiError: If the Meilisearch API returned an error.
7992
7347
 
7993
- Examples:
7994
-
7348
+ Examples
7995
7349
  >>> from meilisearch_async_client import Client
7996
7350
  >>> client = Client("http://localhost.com", "masterKey")
7997
7351
  >>> index = client.index("movies")
@@ -8005,16 +7359,13 @@ class Index(_BaseIndex):
8005
7359
  """Get non-separator token settings for the index.
8006
7360
 
8007
7361
  Returns:
8008
-
8009
7362
  Non-separator tokens for the index.
8010
7363
 
8011
7364
  Raises:
8012
-
8013
7365
  MeilisearchCommunicationError: If there was an error communicating with the server.
8014
7366
  MeilisearchApiError: If the Meilisearch API returned an error.
8015
7367
 
8016
- Examples:
8017
-
7368
+ Examples
8018
7369
  >>> from meilisearch_async_client import Client
8019
7370
  >>> client = Client("http://localhost.com", "masterKey")
8020
7371
  >>> index = client.index("movies")
@@ -8030,21 +7381,17 @@ class Index(_BaseIndex):
8030
7381
  """Update the non-separator tokens settings for an index.
8031
7382
 
8032
7383
  Args:
8033
-
8034
7384
  non_separator_tokens: List of non-separator tokens.
8035
7385
  compress: If set to True the data will be sent in gzip format. Defaults to False.
8036
7386
 
8037
7387
  Returns:
8038
-
8039
7388
  Task to track the action.
8040
7389
 
8041
7390
  Raises:
8042
-
8043
7391
  MeilisearchCommunicationError: If there was an error communicating with the server.
8044
7392
  MeilisearchApiError: If the Meilisearch API returned an error.
8045
7393
 
8046
- Examples:
8047
-
7394
+ Examples
8048
7395
  >>> from meilisearch_python_sdk import Client
8049
7396
  >>> client = Client("http://localhost.com", "masterKey")
8050
7397
  >>> index = client.index("movies")
@@ -8060,16 +7407,13 @@ class Index(_BaseIndex):
8060
7407
  """Reset an index's non-separator tokens settings to the default value.
8061
7408
 
8062
7409
  Returns:
8063
-
8064
7410
  The details of the task status.
8065
7411
 
8066
7412
  Raises:
8067
-
8068
7413
  MeilisearchCommunicationError: If there was an error communicating with the server.
8069
7414
  MeilisearchApiError: If the Meilisearch API returned an error.
8070
7415
 
8071
- Examples:
8072
-
7416
+ Examples
8073
7417
  >>> from meilisearch_async_client import Client
8074
7418
  >>> client = Client("http://localhost.com", "masterKey")
8075
7419
  >>> index = client.index("movies")
@@ -8083,16 +7427,13 @@ class Index(_BaseIndex):
8083
7427
  """Get search cutoff time in ms.
8084
7428
 
8085
7429
  Returns:
8086
-
8087
7430
  Integer representing the search cutoff time in ms, or None.
8088
7431
 
8089
7432
  Raises:
8090
-
8091
7433
  MeilisearchCommunicationError: If there was an error communicating with the server.
8092
7434
  MeilisearchApiError: If the Meilisearch API returned an error.
8093
7435
 
8094
- Examples:
8095
-
7436
+ Examples
8096
7437
  >>> from meilisearch_async_client import Client
8097
7438
  >>> client = Client("http://localhost.com", "masterKey")
8098
7439
  >>> index = client.index("movies")
@@ -8106,21 +7447,17 @@ class Index(_BaseIndex):
8106
7447
  """Update the search cutoff for an index.
8107
7448
 
8108
7449
  Args:
8109
-
8110
7450
  search_cutoff_ms: Integer value of the search cutoff time in ms.
8111
7451
  compress: If set to True the data will be sent in gzip format. Defaults to False.
8112
7452
 
8113
7453
  Returns:
8114
-
8115
7454
  Task to track the action.
8116
7455
 
8117
7456
  Raises:
8118
-
8119
7457
  MeilisearchCommunicationError: If there was an error communicating with the server.
8120
7458
  MeilisearchApiError: If the Meilisearch API returned an error.
8121
7459
 
8122
- Examples:
8123
-
7460
+ Examples
8124
7461
  >>> from meilisearch_python_sdk import Client
8125
7462
  >>> client = Client("http://localhost.com", "masterKey")
8126
7463
  >>> index = client.index("movies")
@@ -8136,16 +7473,13 @@ class Index(_BaseIndex):
8136
7473
  """Reset the search cutoff time to the default value.
8137
7474
 
8138
7475
  Returns:
8139
-
8140
7476
  The details of the task status.
8141
7477
 
8142
7478
  Raises:
8143
-
8144
7479
  MeilisearchCommunicationError: If there was an error communicating with the server.
8145
7480
  MeilisearchApiError: If the Meilisearch API returned an error.
8146
7481
 
8147
- Examples:
8148
-
7482
+ Examples
8149
7483
  >>> from meilisearch_async_client import Client
8150
7484
  >>> client = Client("http://localhost.com", "masterKey")
8151
7485
  >>> index = client.index("movies")
@@ -8159,16 +7493,13 @@ class Index(_BaseIndex):
8159
7493
  """Get word dictionary settings for the index.
8160
7494
 
8161
7495
  Returns:
8162
-
8163
7496
  Word dictionary for the index.
8164
7497
 
8165
7498
  Raises:
8166
-
8167
7499
  MeilisearchCommunicationError: If there was an error communicating with the server.
8168
7500
  MeilisearchApiError: If the Meilisearch API returned an error.
8169
7501
 
8170
- Examples:
8171
-
7502
+ Examples
8172
7503
  >>> from meilisearch_async_client import Client
8173
7504
  >>> client = Client("http://localhost.com", "masterKey")
8174
7505
  >>> index = client.index("movies")
@@ -8182,21 +7513,17 @@ class Index(_BaseIndex):
8182
7513
  """Update the word dictionary settings for an index.
8183
7514
 
8184
7515
  Args:
8185
-
8186
7516
  dictionary: List of dictionary values.
8187
7517
  compress: If set to True the data will be sent in gzip format. Defaults to False.
8188
7518
 
8189
7519
  Returns:
8190
-
8191
7520
  Task to track the action.
8192
7521
 
8193
7522
  Raises:
8194
-
8195
7523
  MeilisearchCommunicationError: If there was an error communicating with the server.
8196
7524
  MeilisearchApiError: If the Meilisearch API returned an error.
8197
7525
 
8198
- Examples:
8199
-
7526
+ Examples
8200
7527
  >>> from meilisearch_python_sdk import Client
8201
7528
  >>> client = Client("http://localhost.com", "masterKey")
8202
7529
  >>> index = client.index("movies")
@@ -8212,16 +7539,13 @@ class Index(_BaseIndex):
8212
7539
  """Reset an index's word dictionary settings to the default value.
8213
7540
 
8214
7541
  Returns:
8215
-
8216
7542
  The details of the task status.
8217
7543
 
8218
7544
  Raises:
8219
-
8220
7545
  MeilisearchCommunicationError: If there was an error communicating with the server.
8221
7546
  MeilisearchApiError: If the Meilisearch API returned an error.
8222
7547
 
8223
- Examples:
8224
-
7548
+ Examples
8225
7549
  >>> from meilisearch_async_client import Client
8226
7550
  >>> client = Client("http://localhost.com", "masterKey")
8227
7551
  >>> index = client.index("movies")
@@ -8235,16 +7559,13 @@ class Index(_BaseIndex):
8235
7559
  """Get proximity precision settings for the index.
8236
7560
 
8237
7561
  Returns:
8238
-
8239
7562
  Proximity precision for the index.
8240
7563
 
8241
7564
  Raises:
8242
-
8243
7565
  MeilisearchCommunicationError: If there was an error communicating with the server.
8244
7566
  MeilisearchApiError: If the Meilisearch API returned an error.
8245
7567
 
8246
- Examples:
8247
-
7568
+ Examples
8248
7569
  >>> from meilisearch_async_client import Client
8249
7570
  >>> client = Client("http://localhost.com", "masterKey")
8250
7571
  >>> index = client.index("movies")
@@ -8260,21 +7581,17 @@ class Index(_BaseIndex):
8260
7581
  """Update the proximity precision settings for an index.
8261
7582
 
8262
7583
  Args:
8263
-
8264
7584
  proximity_precision: The proximity precision value.
8265
7585
  compress: If set to True the data will be sent in gzip format. Defaults to False.
8266
7586
 
8267
7587
  Returns:
8268
-
8269
7588
  Task to track the action.
8270
7589
 
8271
7590
  Raises:
8272
-
8273
7591
  MeilisearchCommunicationError: If there was an error communicating with the server.
8274
7592
  MeilisearchApiError: If the Meilisearch API returned an error.
8275
7593
 
8276
- Examples:
8277
-
7594
+ Examples
8278
7595
  >>> from meilisearch_python_sdk import Client
8279
7596
  >>> from meilisearch_python_sdk.models.settings import ProximityPrecision
8280
7597
  >>> client = Client("http://localhost.com", "masterKey")
@@ -8293,16 +7610,13 @@ class Index(_BaseIndex):
8293
7610
  """Reset an index's proximity precision settings to the default value.
8294
7611
 
8295
7612
  Returns:
8296
-
8297
7613
  The details of the task status.
8298
7614
 
8299
7615
  Raises:
8300
-
8301
7616
  MeilisearchCommunicationError: If there was an error communicating with the server.
8302
7617
  MeilisearchApiError: If the Meilisearch API returned an error.
8303
7618
 
8304
- Examples:
8305
-
7619
+ Examples
8306
7620
  >>> from meilisearch_async_client import Client
8307
7621
  >>> client = Client("http://localhost.com", "masterKey")
8308
7622
  >>> index = client.index("movies")
@@ -8316,16 +7630,13 @@ class Index(_BaseIndex):
8316
7630
  """Get embedder settings for the index.
8317
7631
 
8318
7632
  Returns:
8319
-
8320
7633
  Embedders for the index.
8321
7634
 
8322
7635
  Raises:
8323
-
8324
7636
  MeilisearchCommunicationError: If there was an error communicating with the server.
8325
7637
  MeilisearchApiError: If the Meilisearch API returned an error.
8326
7638
 
8327
- Examples:
8328
-
7639
+ Examples
8329
7640
  >>> from meilisearch_async_client import Client
8330
7641
  >>> client = Client("http://localhost.com", "masterKey")
8331
7642
  >>> index = client.index("movies")
@@ -8339,21 +7650,17 @@ class Index(_BaseIndex):
8339
7650
  """Update the embedders settings for an index.
8340
7651
 
8341
7652
  Args:
8342
-
8343
7653
  embedders: The embedders value.
8344
7654
  compress: If set to True the data will be sent in gzip format. Defaults to False.
8345
7655
 
8346
7656
  Returns:
8347
-
8348
7657
  Task to track the action.
8349
7658
 
8350
7659
  Raises:
8351
-
8352
7660
  MeilisearchCommunicationError: If there was an error communicating with the server.
8353
7661
  MeilisearchApiError: If the Meilisearch API returned an error.
8354
7662
 
8355
- Examples:
8356
-
7663
+ Examples
8357
7664
  >>> from meilisearch_python_sdk import Client
8358
7665
  >>> from meilisearch_python_sdk.models.settings import Embedders, UserProvidedEmbedder
8359
7666
  >>> client = Client("http://localhost.com", "masterKey")
@@ -8379,16 +7686,13 @@ class Index(_BaseIndex):
8379
7686
  """Reset an index's embedders settings to the default value.
8380
7687
 
8381
7688
  Returns:
8382
-
8383
7689
  The details of the task status.
8384
7690
 
8385
7691
  Raises:
8386
-
8387
7692
  MeilisearchCommunicationError: If there was an error communicating with the server.
8388
7693
  MeilisearchApiError: If the Meilisearch API returned an error.
8389
7694
 
8390
- Examples:
8391
-
7695
+ Examples
8392
7696
  >>> from meilisearch_async_client import Client
8393
7697
  >>> client = AsyncClient("http://localhost.com", "masterKey")
8394
7698
  >>> index = client.index("movies")
@@ -8402,16 +7706,13 @@ class Index(_BaseIndex):
8402
7706
  """Get localized attributes settings for the index.
8403
7707
 
8404
7708
  Returns:
8405
-
8406
7709
  Localized attributes for the index.
8407
7710
 
8408
7711
  Raises:
8409
-
8410
7712
  MeilisearchCommunicationError: If there was an error communicating with the server.
8411
7713
  MeilisearchApiError: If the Meilisearch API returned an error.
8412
7714
 
8413
- Examples:
8414
-
7715
+ Examples
8415
7716
  >>> from meilisearch_async_client import AsyncClient
8416
7717
  >>> client = Client("http://localhost.com", "masterKey")
8417
7718
  >>> index = client.index("movies")
@@ -8430,21 +7731,17 @@ class Index(_BaseIndex):
8430
7731
  """Update the localized attributes settings for an index.
8431
7732
 
8432
7733
  Args:
8433
-
8434
7734
  localized_attributes: The localized attributes value.
8435
7735
  compress: If set to True the data will be sent in gzip format. Defaults to False.
8436
7736
 
8437
7737
  Returns:
8438
-
8439
7738
  Task to track the action.
8440
7739
 
8441
7740
  Raises:
8442
-
8443
7741
  MeilisearchCommunicationError: If there was an error communicating with the server.
8444
7742
  MeilisearchApiError: If the Meilisearch API returned an error.
8445
7743
 
8446
- Examples:
8447
-
7744
+ Examples
8448
7745
  >>> from meilisearch_python_sdk import AsyncClient
8449
7746
  >>> from meilisearch_python_sdk.models.settings import LocalizedAttributes
8450
7747
  >>>
@@ -8467,16 +7764,13 @@ class Index(_BaseIndex):
8467
7764
  """Reset an index's localized attributes settings to the default value.
8468
7765
 
8469
7766
  Returns:
8470
-
8471
7767
  The details of the task status.
8472
7768
 
8473
7769
  Raises:
8474
-
8475
7770
  MeilisearchCommunicationError: If there was an error communicating with the server.
8476
7771
  MeilisearchApiError: If the Meilisearch API returned an error.
8477
7772
 
8478
- Examples:
8479
-
7773
+ Examples
8480
7774
  >>> from meilisearch_async_client import AsyncClient
8481
7775
  >>> Client("http://localhost.com", "masterKey") as client:
8482
7776
  >>> index = client.index("movies")