Skip to content

Commit b5cc8f6

Browse files
alallemaalallema
committed
Update code-sample for v0.28
1 parent cff2433 commit b5cc8f6

File tree

1 file changed

+105
-69
lines changed

1 file changed

+105
-69
lines changed

‎.code-samples.meilisearch.yaml

Lines changed: 105 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,10 @@
33
# the documentation on build
44
# You can read more on https://github.com/meilisearch/documentation/tree/master/.vuepress/code-samples
55
---
6-
get_all_tasks_filtering_1: |-
7-
get_all_tasks_filtering_2: |-
8-
get_all_tasks_paginating_1: |-
9-
get_all_tasks_paginating_2: |-
10-
get_pagination_settings_1: |-
11-
update_pagination_settings_1: |-
12-
reset_pagination_settings_1: |-
13-
get_faceting_settings_1: |-
14-
update_faceting_settings_1: |-
15-
reset_faceting_settings_1: |-
16-
settings_guide_faceting_1: |-
17-
settings_guide_pagination_1: |-
18-
196
get_one_index_1: |-
207
client.get_index('movies')
21-
PLEASE_UPDATE_ME>>>>>>>>>>>>>list_all_indexes_1: |-
22-
client.get_indexes()
8+
list_all_indexes_1: |-
9+
client.get_indexes({'limit':3})
2310
create_an_index_1: |-
2411
client.create_index('movies', {'primaryKey': 'id'})
2512
update_an_index_1: |-
@@ -28,8 +15,10 @@ delete_an_index_1: |-
2815
client.delete_index('movies')
2916
// OR
3017
client.index('movies').delete()
31-
PLEASE_UPDATE_ME>>>>>>>>>>>>>get_one_document_1: |-
32-
client.index('movies').get_document(25684)
18+
get_one_document_1: |-
19+
client.index('movies').get_document(25684, {
20+
'fields': ['id','title', 'poster', 'release_date']
21+
})
3322
get_documents_1: |-
3423
client.index('movies').get_documents({'limit':2})
3524
add_or_replace_documents_1: |-
@@ -54,80 +43,80 @@ delete_documents_1: |-
5443
client.index('movies').delete_documents([23488, 153738, 437035, 363869])
5544
search_post_1: |-
5645
client.index('movies').search('American ninja')
57-
PLEASE_REMOVE_ME>>>>>>>>>>>>>get_task_by_index_1: |-
58-
client.index('movies').get_task(1)
5946
get_all_tasks_1: |-
6047
client.get_tasks()
6148
get_task_1: |-
6249
client.get_task(1)
63-
PLEASE_REMOVE_ME>>>>>>>>>>>>>get_all_tasks_by_index_1: |-
64-
client.index('movies').get_tasks()
6550
get_one_key_1: |-
6651
client.get_key('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4')
67-
PLEASE_UPDATE_ME>>>>>>>>>>>>>get_all_keys_1: |-
68-
client.get_keys()
52+
get_all_keys_1: |-
53+
client.get_keys({'limit': 3})
6954
create_a_key_1: |-
7055
client.create_key(options={
7156
'description': 'Add documents: Products API key',
7257
'actions': ['documents.add'],
7358
'indexes': ['products'],
7459
'expiresAt': '2042-04-02T00:42:42Z'
7560
})
76-
PLEASE_UPDATE_ME>>>>>>>>>>>>>update_a_key_1: |-
77-
client.update_key(key='d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4',
61+
update_a_key_1: |-
62+
client.update_key(key_or_uid='d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4',
7863
options={
79-
'description': 'Manage documents: Products/Reviews API key',
80-
'actions': ['documents.add', 'documents.delete'],
81-
'indexes': ['products', 'reviews'],
82-
'expiresAt': '2042-04-02T00:42:42Z'
64+
'name': 'Products/Reviews API key',
65+
'description': 'Manage documents: Products/Reviews API key'
8366
})
84-
PLEASE_UPDATE_ME>>>>>>>>>>>>>delete_a_key_1: |-
85-
client.delete_key('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4')
67+
delete_a_key_1: |-
68+
client.delete_key('6062abda-a5aa-4414-ac91-ecd7944c0f8d')
8669
get_settings_1: |-
8770
client.index('movies').get_settings()
88-
PLEASE_UPDATE_ME>>>>>>>>>>>>>update_settings_1: |-
71+
update_settings_1: |-
8972
client.index('movies').update_settings({
9073
'rankingRules': [
91-
'words',
92-
'typo',
93-
'proximity',
94-
'attribute',
95-
'sort',
96-
'exactness',
97-
'release_date:desc',
98-
'rank:desc'
74+
'words',
75+
'typo',
76+
'proximity',
77+
'attribute',
78+
'sort',
79+
'exactness',
80+
'release_date:desc',
81+
'rank:desc'
9982
],
10083
'distinctAttribute': 'movie_id',
10184
'searchableAttributes': [
102-
'title',
103-
'overview',
104-
'genres'
85+
'title',
86+
'overview',
87+
'genres'
10588
],
10689
'displayedAttributes': [
107-
'title',
108-
'overview',
109-
'genres',
110-
'release_date'
90+
'title',
91+
'overview',
92+
'genres',
93+
'release_date'
11194
],
11295
'sortableAttributes': [
113-
'title',
114-
'release_date'
96+
'title',
97+
'release_date'
11598
],
11699
'stopWords': [
117-
'the',
118-
'a',
119-
'an'
100+
'the',
101+
'a',
102+
'an'
120103
],
121104
'synonyms': {
122-
'wolverine': ['xmen', 'logan'],
123-
'logan': ['wolverine']
105+
'wolverine': ['xmen', 'logan'],
106+
'logan': ['wolverine']
124107
},
125108
'typoTolerance': {
126-
'minWordSizeForTypos': {
127-
'oneTypo': 8,
128-
'twoTypos': 10
129-
},
130-
'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
131120
}
132121
})
133122
reset_settings_1: |-
@@ -293,7 +282,7 @@ search_parameter_guide_highlight_tag_1: |-
293282
'highlightPreTag': '<span class="highlight">',
294283
'highlightPostTag': '</span>'
295284
})
296-
PLEASE_UPDATE_ME>>>>>>>>>>>>>search_parameter_guide_matches_1: |-
285+
search_parameter_guide_show_matches_position_1: |-
297286
client.index('movies').search('winter feast', {
298287
'showMatchesPosition': 'true'
299288
})
@@ -403,8 +392,8 @@ documents_guide_add_movie_1: |-
403392
'movie_id': '123sq178',
404393
'title': 'Amélie Poulain'
405394
}])
406-
PLEASE_UPDATE_ME>>>>>>>>>>>>>PLEASE_UPDATE_ME>>>>>>>>>>>>>getting_started_check_task_status: |-
407-
client.index('movies').get_task(0)
395+
getting_started_check_task_status: |-
396+
client.get_task(0)
408397
getting_started_add_documents_md: |-
409398
```bash
410399
pip3 install meilisearch
@@ -493,7 +482,7 @@ getting_started_configure_settings: |-
493482
getting_started_communicating_with_a_protected_instance: |-
494483
client = Client('http://127.0.0.1:7700', 'apiKey')
495484
client.index('movies').search()
496-
faceted_search_PLEASE_UPDATE_ME>>>>>>>>>>>>>update_settings_1: |-
485+
faceted_search_update_settings_1: |-
497486
client.index('movies').update_filterable_attributes([
498487
'director',
499488
'genres',
@@ -502,7 +491,7 @@ faceted_search_filter_1: |-
502491
client.index('movies').search('thriller', {
503492
'filter': [['genres = Horror', 'genres = Mystery'], 'director = "Jordan Peele"']
504493
})
505-
PLEASE_UPDATE_ME>>>>>>>>>>>>>faceted_search_facets_distribution_1: |-
494+
faceted_search_facets_distribution_1: |-
506495
client.index('movies').search('Batman', {
507496
'facets': ['genres']
508497
})
@@ -579,10 +568,10 @@ primary_field_guide_add_document_primary_key: |-
579568
security_guide_search_key_1: |-
580569
client = Client('http://127.0.0.1:7700', 'apiKey')
581570
client.index('patient_medical_records').search()
582-
PLEASE_UPDATE_ME>>>>>>>>>>>>>security_guide_update_key_1: |-
571+
security_guide_update_key_1: |-
583572
client = Client('http://127.0.0.1:7700', 'masterKey')
584-
client.update_key(key='d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4', options={
585-
'indexes': ['doctors']
573+
client.update_key(key_or_uid='74c9c733-3368-4738-bbe5-1d18a5fecb37', options={
574+
'description': 'Default Search API Key'
586575
})
587576
security_guide_create_key_1: |-
588577
client = Client('http://127.0.0.1:7700', 'masterKey')
@@ -595,9 +584,9 @@ security_guide_create_key_1: |-
595584
security_guide_list_keys_1: |-
596585
client = Client('http://127.0.0.1:7700', 'masterKey')
597586
client.get_keys()
598-
PLEASE_UPDATE_ME>>>>>>>>>>>>>security_guide_delete_key_1: |-
587+
security_guide_delete_key_1: |-
599588
client = Client('http://127.0.0.1:7700', 'masterKey')
600-
client.delete_key('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4')
589+
client.delete_key('ac5cd97d-5a4b-4226-a868-2d0eb6d197ab')
601590
authorization_header_1: |-
602591
client = Client('http://127.0.0.1:7700', 'masterKey')
603592
client.get_keys()
@@ -614,3 +603,50 @@ tenant_token_guide_generate_sdk_1: |-
614603
tenant_token_guide_search_sdk_1: |-
615604
front_end_client = Client('http://127.0.0.1:7700', token)
616605
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)