Skip to content

Commit 33b3ad2

Browse files
alallemaalallema
authored
Merge pull request #490 from meilisearch/meili-bot/code-samples-v0-28
Code samples changes related to Meilisearch release (v0.28.0)
2 parents 1d651a1 + 94c3501 commit 33b3ad2

File tree

1 file changed

+97
-48
lines changed

1 file changed

+97
-48
lines changed

‎.code-samples.meilisearch.yaml‎

Lines changed: 97 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
get_one_index_1: |-
77
client.get_index('movies')
88
list_all_indexes_1: |-
9-
client.get_indexes()
9+
client.get_indexes({'limit': 3})
1010
create_an_index_1: |-
1111
client.create_index('movies', {'primaryKey': 'id'})
1212
update_an_index_1: |-
@@ -16,7 +16,9 @@ delete_an_index_1: |-
1616
// OR
1717
client.index('movies').delete()
1818
get_one_document_1: |-
19-
client.index('movies').get_document(25684)
19+
client.index('movies').get_document(25684, {
20+
'fields': ['id', 'title', 'poster', 'release_date']
21+
})
2022
get_documents_1: |-
2123
client.index('movies').get_documents({'limit':2})
2224
add_or_replace_documents_1: |-
@@ -41,18 +43,14 @@ delete_documents_1: |-
4143
client.index('movies').delete_documents([23488, 153738, 437035, 363869])
4244
search_post_1: |-
4345
client.index('movies').search('American ninja')
44-
get_task_by_index_1: |-
45-
client.index('movies').get_task(1)
4646
get_all_tasks_1: |-
4747
client.get_tasks()
4848
get_task_1: |-
4949
client.get_task(1)
50-
get_all_tasks_by_index_1: |-
51-
client.index('movies').get_tasks()
5250
get_one_key_1: |-
53-
client.get_key('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4')
51+
client.get_key('6062abda-a5aa-4414-ac91-ecd7944c0f8d')
5452
get_all_keys_1: |-
55-
client.get_keys()
53+
client.get_keys({'limit': 3})
5654
create_a_key_1: |-
5755
client.create_key(options={
5856
'description': 'Add documents: Products API key',
@@ -61,60 +59,64 @@ create_a_key_1: |-
6159
'expiresAt': '2042-04-02T00:42:42Z'
6260
})
6361
update_a_key_1: |-
64-
client.update_key(key='d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4',
62+
client.update_key(key_or_uid='6062abda-a5aa-4414-ac91-ecd7944c0f8d',
6563
options={
66-
'description': 'Manage documents: Products/Reviews API key',
67-
'actions': ['documents.add', 'documents.delete'],
68-
'indexes': ['products', 'reviews'],
69-
'expiresAt': '2042-04-02T00:42:42Z'
64+
'name': 'Products/Reviews API key',
65+
'description': 'Manage documents: Products/Reviews API key'
7066
})
7167
delete_a_key_1: |-
72-
client.delete_key('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4')
68+
client.delete_key('6062abda-a5aa-4414-ac91-ecd7944c0f8d')
7369
get_settings_1: |-
7470
client.index('movies').get_settings()
7571
update_settings_1: |-
7672
client.index('movies').update_settings({
7773
'rankingRules': [
78-
'words',
79-
'typo',
80-
'proximity',
81-
'attribute',
82-
'sort',
83-
'exactness',
84-
'release_date:desc',
85-
'rank:desc'
74+
'words',
75+
'typo',
76+
'proximity',
77+
'attribute',
78+
'sort',
79+
'exactness',
80+
'release_date:desc',
81+
'rank:desc'
8682
],
8783
'distinctAttribute': 'movie_id',
8884
'searchableAttributes': [
89-
'title',
90-
'overview',
91-
'genres'
85+
'title',
86+
'overview',
87+
'genres'
9288
],
9389
'displayedAttributes': [
94-
'title',
95-
'overview',
96-
'genres',
97-
'release_date'
90+
'title',
91+
'overview',
92+
'genres',
93+
'release_date'
9894
],
9995
'sortableAttributes': [
100-
'title',
101-
'release_date'
96+
'title',
97+
'release_date'
10298
],
10399
'stopWords': [
104-
'the',
105-
'a',
106-
'an'
100+
'the',
101+
'a',
102+
'an'
107103
],
108104
'synonyms': {
109-
'wolverine': ['xmen', 'logan'],
110-
'logan': ['wolverine']
105+
'wolverine': ['xmen', 'logan'],
106+
'logan': ['wolverine']
111107
},
112108
'typoTolerance': {
113-
'minWordSizeForTypos': {
114-
'oneTypo': 8,
115-
'twoTypos': 10
116-
},
117-
'disableOnAttributes': ['title']
109+
'minWordSizeForTypos': {
110+
'oneTypo': 8,
111+
'twoTypos': 10
112+
},
113+
'disableOnAttributes': ['title']
114+
},
115+
'pagination': {
116+
'maxTotalHits': 5000
117+
},
118+
'faceting': {
119+
'maxValuesPerFacet': 200
118120
}
119121
})
120122
reset_settings_1: |-
@@ -280,9 +282,9 @@ search_parameter_guide_highlight_tag_1: |-
280282
'highlightPreTag': '<span class="highlight">',
281283
'highlightPostTag': '</span>'
282284
})
283-
search_parameter_guide_matches_1: |-
285+
search_parameter_guide_show_matches_position_1: |-
284286
client.index('movies').search('winter feast', {
285-
'showMatchesPosition': 'true'
287+
'showMatchesPosition': True
286288
})
287289
settings_guide_synonyms_1: |-
288290
client.index('tops').update_settings({
@@ -391,7 +393,7 @@ documents_guide_add_movie_1: |-
391393
'title': 'Amélie Poulain'
392394
}])
393395
getting_started_check_task_status: |-
394-
client.index('movies').get_task(0)
396+
client.get_task(0)
395397
getting_started_add_documents_md: |-
396398
```bash
397399
pip3 install meilisearch
@@ -489,7 +491,7 @@ faceted_search_filter_1: |-
489491
client.index('movies').search('thriller', {
490492
'filter': [['genres = Horror', 'genres = Mystery'], 'director = "Jordan Peele"']
491493
})
492-
faceted_search_facets_distribution_1: |-
494+
faceted_search_facets_1: |-
493495
client.index('movies').search('Batman', {
494496
'facets': ['genres']
495497
})
@@ -568,8 +570,8 @@ security_guide_search_key_1: |-
568570
client.index('patient_medical_records').search()
569571
security_guide_update_key_1: |-
570572
client = Client('http://127.0.0.1:7700', 'masterKey')
571-
client.update_key(key='d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4', options={
572-
'indexes': ['doctors']
573+
client.update_key(key_or_uid='74c9c733-3368-4738-bbe5-1d18a5fecb37', options={
574+
'description': 'Default Search API Key'
573575
})
574576
security_guide_create_key_1: |-
575577
client = Client('http://127.0.0.1:7700', 'masterKey')
@@ -584,7 +586,7 @@ security_guide_list_keys_1: |-
584586
client.get_keys()
585587
security_guide_delete_key_1: |-
586588
client = Client('http://127.0.0.1:7700', 'masterKey')
587-
client.delete_key('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4')
589+
client.delete_key('ac5cd97d-5a4b-4226-a868-2d0eb6d197ab')
588590
authorization_header_1: |-
589591
client = Client('http://127.0.0.1:7700', 'masterKey')
590592
client.get_keys()
@@ -601,3 +603,50 @@ tenant_token_guide_generate_sdk_1: |-
601603
tenant_token_guide_search_sdk_1: |-
602604
front_end_client = Client('http://127.0.0.1:7700', token)
603605
front_end_client.index('patient_medical_records').search('blood test')
606+
get_all_tasks_filtering_1: |-
607+
client.index.('movies').get_tasks()
608+
// OR
609+
client.get_tasks({'indexUid': ['movies']})
610+
get_all_tasks_filtering_2: |-
611+
client.get_tasks({
612+
'status': ['succeeded', 'failed'],
613+
'type': ['documentAdditionOrUpdate']
614+
})
615+
get_all_tasks_paginating_1: |-
616+
client.get_tasks({
617+
'limit': 2,
618+
'from': 10
619+
})
620+
get_all_tasks_paginating_2: |-
621+
client.get_tasks({
622+
'limit': 2,
623+
'from': 8
624+
})
625+
get_pagination_settings_1: |-
626+
update_pagination_settings_1: |-
627+
client.index('books').update_settings({
628+
'pagination': {
629+
'maxTotalHits': 100
630+
}
631+
})
632+
reset_pagination_settings_1: |-
633+
get_faceting_settings_1: |-
634+
update_faceting_settings_1: |-
635+
client.index('books').update_settings({
636+
'faceting': {
637+
'maxValuesPerFacet': 2
638+
}
639+
})
640+
reset_faceting_settings_1: |-
641+
settings_guide_faceting_1: |-
642+
client.index('movies').update_settings({
643+
'faceting': {
644+
'maxValuesPerFacet': 5
645+
}
646+
})
647+
settings_guide_pagination_1: |-
648+
client.index('movies').update_settings({
649+
'pagination': {
650+
'maxTotalHits': 50
651+
}
652+
})

0 commit comments

Comments
 (0)