From cff243343174f762341ce9574204d6e67367bb80 Mon Sep 17 00:00:00 2001 From: meili-bot <74670311+meili-bot@users.noreply.github.com> Date: Mon, 4 Jul 2022 23:03:13 +0200 Subject: [PATCH 1/6] Update .code-samples.meilisearch.yaml --- .code-samples.meilisearch.yaml | 41 ++++++++++++++++++++++------------ 1 file changed, 27 insertions(+), 14 deletions(-) diff --git a/.code-samples.meilisearch.yaml b/.code-samples.meilisearch.yaml index ea0baa51..61ad4f46 100644 --- a/.code-samples.meilisearch.yaml +++ b/.code-samples.meilisearch.yaml @@ -3,9 +3,22 @@ # the documentation on build # You can read more on https://github.com/meilisearch/documentation/tree/master/.vuepress/code-samples --- +get_all_tasks_filtering_1: |- +get_all_tasks_filtering_2: |- +get_all_tasks_paginating_1: |- +get_all_tasks_paginating_2: |- +get_pagination_settings_1: |- +update_pagination_settings_1: |- +reset_pagination_settings_1: |- +get_faceting_settings_1: |- +update_faceting_settings_1: |- +reset_faceting_settings_1: |- +settings_guide_faceting_1: |- +settings_guide_pagination_1: |- + get_one_index_1: |- client.get_index('movies') -list_all_indexes_1: |- +PLEASE_UPDATE_ME>>>>>>>>>>>>>list_all_indexes_1: |- client.get_indexes() create_an_index_1: |- client.create_index('movies', {'primaryKey': 'id'}) @@ -15,7 +28,7 @@ delete_an_index_1: |- client.delete_index('movies') // OR client.index('movies').delete() -get_one_document_1: |- +PLEASE_UPDATE_ME>>>>>>>>>>>>>get_one_document_1: |- client.index('movies').get_document(25684) get_documents_1: |- client.index('movies').get_documents({'limit':2}) @@ -41,17 +54,17 @@ delete_documents_1: |- client.index('movies').delete_documents([23488, 153738, 437035, 363869]) search_post_1: |- client.index('movies').search('American ninja') -get_task_by_index_1: |- +PLEASE_REMOVE_ME>>>>>>>>>>>>>get_task_by_index_1: |- client.index('movies').get_task(1) get_all_tasks_1: |- client.get_tasks() get_task_1: |- client.get_task(1) -get_all_tasks_by_index_1: |- +PLEASE_REMOVE_ME>>>>>>>>>>>>>get_all_tasks_by_index_1: |- client.index('movies').get_tasks() get_one_key_1: |- client.get_key('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4') -get_all_keys_1: |- +PLEASE_UPDATE_ME>>>>>>>>>>>>>get_all_keys_1: |- client.get_keys() create_a_key_1: |- client.create_key(options={ @@ -60,7 +73,7 @@ create_a_key_1: |- 'indexes': ['products'], 'expiresAt': '2042-04-02T00:42:42Z' }) -update_a_key_1: |- +PLEASE_UPDATE_ME>>>>>>>>>>>>>update_a_key_1: |- client.update_key(key='d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4', options={ 'description': 'Manage documents: Products/Reviews API key', @@ -68,11 +81,11 @@ update_a_key_1: |- 'indexes': ['products', 'reviews'], 'expiresAt': '2042-04-02T00:42:42Z' }) -delete_a_key_1: |- +PLEASE_UPDATE_ME>>>>>>>>>>>>>delete_a_key_1: |- client.delete_key('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4') get_settings_1: |- client.index('movies').get_settings() -update_settings_1: |- +PLEASE_UPDATE_ME>>>>>>>>>>>>>update_settings_1: |- client.index('movies').update_settings({ 'rankingRules': [ 'words', @@ -280,7 +293,7 @@ search_parameter_guide_highlight_tag_1: |- 'highlightPreTag': '', 'highlightPostTag': '' }) -search_parameter_guide_matches_1: |- +PLEASE_UPDATE_ME>>>>>>>>>>>>>search_parameter_guide_matches_1: |- client.index('movies').search('winter feast', { 'showMatchesPosition': 'true' }) @@ -390,7 +403,7 @@ documents_guide_add_movie_1: |- 'movie_id': '123sq178', 'title': 'Amélie Poulain' }]) -getting_started_check_task_status: |- +PLEASE_UPDATE_ME>>>>>>>>>>>>>PLEASE_UPDATE_ME>>>>>>>>>>>>>getting_started_check_task_status: |- client.index('movies').get_task(0) getting_started_add_documents_md: |- ```bash @@ -480,7 +493,7 @@ getting_started_configure_settings: |- getting_started_communicating_with_a_protected_instance: |- client = Client('http://127.0.0.1:7700', 'apiKey') client.index('movies').search() -faceted_search_update_settings_1: |- +faceted_search_PLEASE_UPDATE_ME>>>>>>>>>>>>>update_settings_1: |- client.index('movies').update_filterable_attributes([ 'director', 'genres', @@ -489,7 +502,7 @@ faceted_search_filter_1: |- client.index('movies').search('thriller', { 'filter': [['genres = Horror', 'genres = Mystery'], 'director = "Jordan Peele"'] }) -faceted_search_facets_distribution_1: |- +PLEASE_UPDATE_ME>>>>>>>>>>>>>faceted_search_facets_distribution_1: |- client.index('movies').search('Batman', { 'facets': ['genres'] }) @@ -566,7 +579,7 @@ primary_field_guide_add_document_primary_key: |- security_guide_search_key_1: |- client = Client('http://127.0.0.1:7700', 'apiKey') client.index('patient_medical_records').search() -security_guide_update_key_1: |- +PLEASE_UPDATE_ME>>>>>>>>>>>>>security_guide_update_key_1: |- client = Client('http://127.0.0.1:7700', 'masterKey') client.update_key(key='d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4', options={ 'indexes': ['doctors'] @@ -582,7 +595,7 @@ security_guide_create_key_1: |- security_guide_list_keys_1: |- client = Client('http://127.0.0.1:7700', 'masterKey') client.get_keys() -security_guide_delete_key_1: |- +PLEASE_UPDATE_ME>>>>>>>>>>>>>security_guide_delete_key_1: |- client = Client('http://127.0.0.1:7700', 'masterKey') client.delete_key('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4') authorization_header_1: |- From 9a06746454ec95a6295fdcc0104255f44a83c383 Mon Sep 17 00:00:00 2001 From: alallema Date: Wed, 6 Jul 2022 10:16:45 +0200 Subject: [PATCH 2/6] Update code-sample for v0.28 --- .code-samples.meilisearch.yaml | 176 ++++++++++++++++++++------------- 1 file changed, 106 insertions(+), 70 deletions(-) diff --git a/.code-samples.meilisearch.yaml b/.code-samples.meilisearch.yaml index 61ad4f46..53931b35 100644 --- a/.code-samples.meilisearch.yaml +++ b/.code-samples.meilisearch.yaml @@ -3,23 +3,10 @@ # the documentation on build # You can read more on https://github.com/meilisearch/documentation/tree/master/.vuepress/code-samples --- -get_all_tasks_filtering_1: |- -get_all_tasks_filtering_2: |- -get_all_tasks_paginating_1: |- -get_all_tasks_paginating_2: |- -get_pagination_settings_1: |- -update_pagination_settings_1: |- -reset_pagination_settings_1: |- -get_faceting_settings_1: |- -update_faceting_settings_1: |- -reset_faceting_settings_1: |- -settings_guide_faceting_1: |- -settings_guide_pagination_1: |- - get_one_index_1: |- client.get_index('movies') -PLEASE_UPDATE_ME>>>>>>>>>>>>>list_all_indexes_1: |- - client.get_indexes() +list_all_indexes_1: |- + client.get_indexes({'limit':3}) create_an_index_1: |- client.create_index('movies', {'primaryKey': 'id'}) update_an_index_1: |- @@ -28,8 +15,10 @@ delete_an_index_1: |- client.delete_index('movies') // OR client.index('movies').delete() -PLEASE_UPDATE_ME>>>>>>>>>>>>>get_one_document_1: |- - client.index('movies').get_document(25684) +get_one_document_1: |- + client.index('movies').get_document(25684, { + 'fields': ['id','title', 'poster', 'release_date'] + }) get_documents_1: |- client.index('movies').get_documents({'limit':2}) add_or_replace_documents_1: |- @@ -54,18 +43,14 @@ delete_documents_1: |- client.index('movies').delete_documents([23488, 153738, 437035, 363869]) search_post_1: |- client.index('movies').search('American ninja') -PLEASE_REMOVE_ME>>>>>>>>>>>>>get_task_by_index_1: |- - client.index('movies').get_task(1) get_all_tasks_1: |- client.get_tasks() get_task_1: |- client.get_task(1) -PLEASE_REMOVE_ME>>>>>>>>>>>>>get_all_tasks_by_index_1: |- - client.index('movies').get_tasks() get_one_key_1: |- - client.get_key('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4') -PLEASE_UPDATE_ME>>>>>>>>>>>>>get_all_keys_1: |- - client.get_keys() + client.get_key('6062abda-a5aa-4414-ac91-ecd7944c0f8d') +get_all_keys_1: |- + client.get_keys({'limit': 3}) create_a_key_1: |- client.create_key(options={ 'description': 'Add documents: Products API key', @@ -73,61 +58,65 @@ create_a_key_1: |- 'indexes': ['products'], 'expiresAt': '2042-04-02T00:42:42Z' }) -PLEASE_UPDATE_ME>>>>>>>>>>>>>update_a_key_1: |- - client.update_key(key='d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4', +update_a_key_1: |- + client.update_key(key_or_uid='6062abda-a5aa-4414-ac91-ecd7944c0f8d', options={ - 'description': 'Manage documents: Products/Reviews API key', - 'actions': ['documents.add', 'documents.delete'], - 'indexes': ['products', 'reviews'], - 'expiresAt': '2042-04-02T00:42:42Z' + 'name': 'Products/Reviews API key', + 'description': 'Manage documents: Products/Reviews API key' }) -PLEASE_UPDATE_ME>>>>>>>>>>>>>delete_a_key_1: |- - client.delete_key('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4') +delete_a_key_1: |- + client.delete_key('6062abda-a5aa-4414-ac91-ecd7944c0f8d') get_settings_1: |- client.index('movies').get_settings() -PLEASE_UPDATE_ME>>>>>>>>>>>>>update_settings_1: |- +update_settings_1: |- client.index('movies').update_settings({ 'rankingRules': [ - 'words', - 'typo', - 'proximity', - 'attribute', - 'sort', - 'exactness', - 'release_date:desc', - 'rank:desc' + 'words', + 'typo', + 'proximity', + 'attribute', + 'sort', + 'exactness', + 'release_date:desc', + 'rank:desc' ], 'distinctAttribute': 'movie_id', 'searchableAttributes': [ - 'title', - 'overview', - 'genres' + 'title', + 'overview', + 'genres' ], 'displayedAttributes': [ - 'title', - 'overview', - 'genres', - 'release_date' + 'title', + 'overview', + 'genres', + 'release_date' ], 'sortableAttributes': [ - 'title', - 'release_date' + 'title', + 'release_date' ], 'stopWords': [ - 'the', - 'a', - 'an' + 'the', + 'a', + 'an' ], 'synonyms': { - 'wolverine': ['xmen', 'logan'], - 'logan': ['wolverine'] + 'wolverine': ['xmen', 'logan'], + 'logan': ['wolverine'] }, 'typoTolerance': { - 'minWordSizeForTypos': { - 'oneTypo': 8, - 'twoTypos': 10 - }, - 'disableOnAttributes': ['title'] + 'minWordSizeForTypos': { + 'oneTypo': 8, + 'twoTypos': 10 + }, + 'disableOnAttributes': ['title'] + }, + 'pagination': { + 'maxTotalHits': 5000 + }, + 'faceting': { + 'maxValuesPerFacet': 200 } }) reset_settings_1: |- @@ -293,7 +282,7 @@ search_parameter_guide_highlight_tag_1: |- 'highlightPreTag': '', 'highlightPostTag': '' }) -PLEASE_UPDATE_ME>>>>>>>>>>>>>search_parameter_guide_matches_1: |- +search_parameter_guide_show_matches_position_1: |- client.index('movies').search('winter feast', { 'showMatchesPosition': 'true' }) @@ -403,8 +392,8 @@ documents_guide_add_movie_1: |- 'movie_id': '123sq178', 'title': 'Amélie Poulain' }]) -PLEASE_UPDATE_ME>>>>>>>>>>>>>PLEASE_UPDATE_ME>>>>>>>>>>>>>getting_started_check_task_status: |- - client.index('movies').get_task(0) +getting_started_check_task_status: |- + client.get_task(0) getting_started_add_documents_md: |- ```bash pip3 install meilisearch @@ -493,7 +482,7 @@ getting_started_configure_settings: |- getting_started_communicating_with_a_protected_instance: |- client = Client('http://127.0.0.1:7700', 'apiKey') client.index('movies').search() -faceted_search_PLEASE_UPDATE_ME>>>>>>>>>>>>>update_settings_1: |- +faceted_search_update_settings_1: |- client.index('movies').update_filterable_attributes([ 'director', 'genres', @@ -502,7 +491,7 @@ faceted_search_filter_1: |- client.index('movies').search('thriller', { 'filter': [['genres = Horror', 'genres = Mystery'], 'director = "Jordan Peele"'] }) -PLEASE_UPDATE_ME>>>>>>>>>>>>>faceted_search_facets_distribution_1: |- +faceted_search_facets_distribution_1: |- client.index('movies').search('Batman', { 'facets': ['genres'] }) @@ -579,10 +568,10 @@ primary_field_guide_add_document_primary_key: |- security_guide_search_key_1: |- client = Client('http://127.0.0.1:7700', 'apiKey') client.index('patient_medical_records').search() -PLEASE_UPDATE_ME>>>>>>>>>>>>>security_guide_update_key_1: |- +security_guide_update_key_1: |- client = Client('http://127.0.0.1:7700', 'masterKey') - client.update_key(key='d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4', options={ - 'indexes': ['doctors'] + client.update_key(key_or_uid='74c9c733-3368-4738-bbe5-1d18a5fecb37', options={ + 'description': 'Default Search API Key' }) security_guide_create_key_1: |- client = Client('http://127.0.0.1:7700', 'masterKey') @@ -595,9 +584,9 @@ security_guide_create_key_1: |- security_guide_list_keys_1: |- client = Client('http://127.0.0.1:7700', 'masterKey') client.get_keys() -PLEASE_UPDATE_ME>>>>>>>>>>>>>security_guide_delete_key_1: |- +security_guide_delete_key_1: |- client = Client('http://127.0.0.1:7700', 'masterKey') - client.delete_key('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4') + client.delete_key('ac5cd97d-5a4b-4226-a868-2d0eb6d197ab') authorization_header_1: |- client = Client('http://127.0.0.1:7700', 'masterKey') client.get_keys() @@ -614,3 +603,50 @@ tenant_token_guide_generate_sdk_1: |- tenant_token_guide_search_sdk_1: |- front_end_client = Client('http://127.0.0.1:7700', token) front_end_client.index('patient_medical_records').search('blood test') +get_all_tasks_filtering_1: |- + client.index.('movies').get_tasks() + // OR + client.get_tasks({'indexUid': ['movies']}) +get_all_tasks_filtering_2: |- + client.get_tasks({ + 'status': ['succeeded', 'failed'], + 'type': ['documentAdditionOrUpdate'] + }) +get_all_tasks_paginating_1: |- + client.get_tasks({ + 'limit': 2, + 'from': 10 + }) +get_all_tasks_paginating_2: |- + client.get_tasks({ + 'limit': 2, + 'from': 8 + }) +get_pagination_settings_1: |- +update_pagination_settings_1: |- + client.index('books').update_settings({ + 'pagination': { + 'maxTotalHits': 100 + } + }) +reset_pagination_settings_1: |- +get_faceting_settings_1: |- +update_faceting_settings_1: |- + client.index('books').update_settings({ + 'faceting': { + 'maxValuesPerFacet': 2 + } + }) +reset_faceting_settings_1: |- +settings_guide_faceting_1: |- + client.index('movies').update_settings({ + 'faceting': { + 'maxValuesPerFacet': 5 + } + }) +settings_guide_pagination_1: |- + client.index('movies').update_settings({ + 'pagination': { + 'maxTotalHits': 50 + } + }) From 6d1786361677660cc5e3d4e9f4a0bc427d370701 Mon Sep 17 00:00:00 2001 From: alallema Date: Thu, 7 Jul 2022 10:08:57 +0200 Subject: [PATCH 3/6] Fix boolean value in code-sample --- .code-samples.meilisearch.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.code-samples.meilisearch.yaml b/.code-samples.meilisearch.yaml index 53931b35..85fcf7ff 100644 --- a/.code-samples.meilisearch.yaml +++ b/.code-samples.meilisearch.yaml @@ -284,7 +284,7 @@ search_parameter_guide_highlight_tag_1: |- }) search_parameter_guide_show_matches_position_1: |- client.index('movies').search('winter feast', { - 'showMatchesPosition': 'true' + 'showMatchesPosition': True }) settings_guide_synonyms_1: |- client.index('tops').update_settings({ From eed607f0c1f2c7194ae1c5082ecd6f8983e368a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Am=C3=A9lie?= Date: Thu, 7 Jul 2022 10:09:19 +0200 Subject: [PATCH 4/6] Update .code-samples.meilisearch.yaml Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com> --- .code-samples.meilisearch.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.code-samples.meilisearch.yaml b/.code-samples.meilisearch.yaml index 85fcf7ff..ad411992 100644 --- a/.code-samples.meilisearch.yaml +++ b/.code-samples.meilisearch.yaml @@ -6,7 +6,7 @@ get_one_index_1: |- client.get_index('movies') list_all_indexes_1: |- - client.get_indexes({'limit':3}) + client.get_indexes({'limit': 3}) create_an_index_1: |- client.create_index('movies', {'primaryKey': 'id'}) update_an_index_1: |- From 37a47102e527a3790b54ecc7e200594b27e48e4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Am=C3=A9lie?= Date: Thu, 7 Jul 2022 10:09:30 +0200 Subject: [PATCH 5/6] Update .code-samples.meilisearch.yaml Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com> --- .code-samples.meilisearch.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.code-samples.meilisearch.yaml b/.code-samples.meilisearch.yaml index ad411992..437cbb3d 100644 --- a/.code-samples.meilisearch.yaml +++ b/.code-samples.meilisearch.yaml @@ -17,7 +17,7 @@ delete_an_index_1: |- client.index('movies').delete() get_one_document_1: |- client.index('movies').get_document(25684, { - 'fields': ['id','title', 'poster', 'release_date'] + 'fields': ['id', 'title', 'poster', 'release_date'] }) get_documents_1: |- client.index('movies').get_documents({'limit':2}) From 39ced5502a9c7befadd0d2b5cd80654e1fd35143 Mon Sep 17 00:00:00 2001 From: alallema Date: Thu, 7 Jul 2022 10:11:56 +0200 Subject: [PATCH 6/6] Rename code-sample faceted --- .code-samples.meilisearch.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.code-samples.meilisearch.yaml b/.code-samples.meilisearch.yaml index 437cbb3d..b0140655 100644 --- a/.code-samples.meilisearch.yaml +++ b/.code-samples.meilisearch.yaml @@ -491,7 +491,7 @@ faceted_search_filter_1: |- client.index('movies').search('thriller', { 'filter': [['genres = Horror', 'genres = Mystery'], 'director = "Jordan Peele"'] }) -faceted_search_facets_distribution_1: |- +faceted_search_facets_1: |- client.index('movies').search('Batman', { 'facets': ['genres'] })