Motore di ricerca Meilisearch
Header
Qualsiasi chiamata deve avere il seguente Header
| authorization: Bearer {access_token} | Token di accesso |
Server
Web interface
http://10.0.0.8:7700Disponibile solo in DEV mode e non in PRODUCTION
Preleva le chiavi del server
POST: https://rest.ene.si/meilisearch/getKeysPer info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/keys.html#get-keys
Info indici
POST: https://rest.ene.si/meilisearch/statsPer info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/stats.html#get-stats-of-all-indexes
Stato servizi
POST: https://rest.ene.si/meilisearch/healthPer info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/health.html#get-health
Versione
POST: https://rest.ene.si/meilisearch/versionPer info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/version.html
Ricerca
Esegue una ricerca su un indice
POST: https://rest.ene.si/meilisearch/search/{index_uid}Parametri
| query | obbligatorio | termine/i di ricerca |
| parameters | opzionale | array contenente le impostazioni di ricerca - vedere tabella successiva |
Impostazioni di ricerca
| Variable | Type | Description | Default value |
|---|---|---|---|
| offset | Integer | Number of documents to skip | 0 |
| limit | Integer | Maximum number of documents returned | 20 |
| filter | String OR [Strings OR [Strings]] | Filter queries by an attribute value | null |
| facetsDistribution | [Strings] | Facets for which to retrieve the matching count | null |
| attributesToRetrieve | [Strings] | Attributes to display in the returned documents | ["*"] |
| attributesToCrop | [Strings] | Attributes whose values have to be cropped | null |
| cropLength | Integer | Length used to crop field values | 200 |
| attributesToHighlight | [Strings] | Attributes whose values will contain highlighted matching terms | null |
| matches | Boolean | Defines whether an object that contains information about the matches should be returned or not | false |
| sort | [Strings] | Sort search results according to the attributes and sorting order (asc or desc) specified | null |
Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/search.html#search-in-an-index-with-post-route
Indici
Lista indici
POST: https://rest.ene.si/meilisearch/getAllIndexesPer info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/indexes.html#list-all-indexes
Seleziona indice
POST: https://rest.ene.si/meilisearch/getIndex/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/indexes.html#get-one-index
Crea un indice
POST: https://rest.ene.si/meilisearch/createIndex/{index_uid}Parametri
| primaryKey | opzionale default: id | chiave primaria dei documenti indicizzati |
Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/indexes.html#create-an-index
Elimina un indice
POST: https://rest.ene.si/meilisearch/deleteIndex/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/indexes.html#delete-an-index
Info su un indice
POST: https://rest.ene.si/meilisearch/indexStats/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/stats.html#get-stats-of-an-index
Stato dell'indicizzazione
POST: https://rest.ene.si/meilisearch/getAllUpdateStatus/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/updates.html#get-all-update-status
Stato dell'indicizzazione di un singolo aggiornamento
POST: https://rest.ene.si/meilisearch/getUpdateStatus/{index_uid}Parametri
| update_id | obbligatorio | id dell'aggiornamento |
Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status
Documenti
Preleva tutti i documenti di un indice
POST: https://rest.ene.si/meilisearch/getDocuments/{index_uid}Parametri
| parameters | obbligatorio | array contentente i parametri passabili (vedi documentazione ufficiale) |
Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/documents.html#get-documents
Preleva un documento
POST: https://rest.ene.si/meilisearch/getDocument/{index_uid}/{document_id}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/documents.html#get-one-document
Aggiungi o sostituisci documenti all'indice
POST: https://rest.ene.si/meilisearch/addDocuments/{index_uid}Parametri
| documents | obbligatorio | array contentente i documenti da salvare |
Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/documents.html#add-or-replace-documents
Aggiorna o sostituisci documenti all'indice
POST: https://rest.ene.si/meilisearch/updateDocuments/{index_uid}Parametri
| documents | obbligatorio | array contentente i documenti da salvare |
Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/documents.html#add-or-update-documents
Elimina tutti i documenti di un indice
POST: https://rest.ene.si/meilisearch/deleteAllDocuments/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/documents.html#delete-all-documents
Elimina un documento di un indice
POST: https://rest.ene.si/meilisearch/deleteDocument/{index_uid}/{document_id}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/documents.html#delete-one-document
Elimina specifici documenti dall'indice
POST: https://rest.ene.si/meilisearch/deleteDocuments/{index_uid}Parametri
| arr_documents_id | obbligatorio | array contentente le chiavi primarie dei documenti da eliminare |
Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/documents.html#delete-documents
Impostazioni
Preleva le impostazioni di un indice
POST: https://rest.ene.si/meilisearch/getSettings/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/settings.html#get-settings
Aggiorna le impostazioni di un indice
POST: https://rest.ene.si/meilisearch/updateSettings/{index_uid}Parametri
| settings | obbligatorio | array contentente i parametri aggiornabili (vedi documentazione ufficiale) |
Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/settings.html#update-settings
Resetta le impostazioni di un indice
POST: https://rest.ene.si/meilisearch/resetSettings/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/settings.html#reset-settings
Attributi visualizzati
Campi da restituire in ricerca. Da impostare se si vuole restituire solo un determinato sottoinsieme di campi invece che tutti i campi
Lista
POST: https://rest.ene.si/meilisearch/getDisplayedAttributes/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/displayed_attributes.html#get-displayed-attributes
Aggiorna
POST: https://rest.ene.si/meilisearch/updateDisplayedAttributes/{index_uid}Parametri
| attributes | obbligatorio | array contentente nomi di campi |
Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/displayed_attributes.html#update-displayed-attributes
Resetta
POST: https://rest.ene.si/meilisearch/resetDisplayedAttributes/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/displayed_attributes.html#reset-displayed-attributes
Attributo DISTINCT
L'attributo DISTINCT è un campo il cui valore sarà sempre unico nei documenti restituiti
Lista
POST: https://rest.ene.si/meilisearch/getDistinctAttribute/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/distinct_attribute.html#get-distinct-attribute
Aggiorna
POST: https://rest.ene.si/meilisearch/updateDistinctAttribute/{index_uid}Parametri
| distinctAttribute | obbligatorio | nome del campo da considerare come DISTINCT |
Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/distinct_attribute.html#update-distinct-attribute
Resetta
POST: https://rest.ene.si/meilisearch/resetDistinctAttribute/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/distinct_attribute.html#reset-distinct-attribute
Attributi filtrabili
Attributi che possono essere utilizzati insieme al parametro di ricerca filter
Lista
POST: https://rest.ene.si/meilisearch/getFilterableAttributes/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/filterable_attributes.html#get-filterable-attributes
Aggiorna
POST: https://rest.ene.si/meilisearch/updateFilterableAttributes/{index_uid}Parametri
| filterableAttributes | obbligatorio | array contentente nomi di campi |
Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/filterable_attributes.html#update-filterable-attributes
Resetta
POST: https://rest.ene.si/meilisearch/resetFilterableAttributes/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/filterable_attributes.html#reset-filterable-attributes
Attributi ricercabili
Attributi utilizzati per la ricerca. L'ordine dell'elenco determina anche l'ordine di classificazione degli attributi.
Lista
POST: https://rest.ene.si/meilisearch/getSearchableAttributes/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/searchable_attributes.html#get-searchable-attributes
Aggiorna
POST: https://rest.ene.si/meilisearch/updateSearchableAttributes/{index_uid}Parametri
| searchableAttributes | obbligatorio | array contentente nomi di campi |
Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/searchable_attributes.html#update-searchable-attributes
Resetta
POST: https://rest.ene.si/meilisearch/resetSearchableAttributes/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/searchable_attributes.html#reset-searchable-attributes
Attributi per ordinamento
Attributi che possono essere utilizzati insieme al parametro di ricerca sort
Lista
POST: https://rest.ene.si/meilisearch/getSortableAttributes/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/sortable_attributes.html#get-sortable-attributes
Aggiorna
POST: https://rest.ene.si/meilisearch/updateSortableAttributes/{index_uid}Parametri
| sortableAttributes | obbligatorio | array contentente nomi di campi |
Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/sortable_attributes.html#update-sortable-attributes
Resetta
POST: https://rest.ene.si/meilisearch/resetSortableAttributes/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/sortable_attributes.html#reset-sortable-attributes
Ranking rules
Le ranking rules sono regole integrate che consentono di personalizzare la pertinenza dei risultati di ricerca. Sono memorizzati in un array e applicati in ordine di apparizione.
Lista
POST: https://rest.ene.si/meilisearch/getRankingRules/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/ranking_rules.html#get-ranking-rules
Aggiorna
POST: https://rest.ene.si/meilisearch/updateRankingRules/{index_uid}Parametri
| rankingRules | obbligatorio | array contentente le regole |
Regole applicabili
https://docs.meilisearch.com/learn/core_concepts/relevancy.html#ranking-rules
| Words |
| Typo |
| Proximity |
| Attribute |
| Sort |
| Exactness |
Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/ranking_rules.html#update-ranking-rules
Resetta
POST: https://rest.ene.si/meilisearch/resetRankingRules/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/ranking_rules.html#reset-ranking-rules
Stop-words
Elenco di parole che verranno ignorate nelle query di ricerca.
Lista
POST: https://rest.ene.si/meilisearch/getStopWords/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/stop_words.html#get-stop-words
Aggiorna
POST: https://rest.ene.si/meilisearch/updateStopWords/{index_uid}Parametri
| stopWords | obbligatorio | array contentente parole da ignorare |
Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/stop_words.html#update-stop-words
Resetta
POST: https://rest.ene.si/meilisearch/resetStopWords/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/stop_words.html#reset-stop-wordss
Sinonimi
Oggetto contenente parole e i rispettivi sinonimi. Un sinonimo in MeiliSearch è considerato uguale alla parola associata in una query di ricerca.
Lista
POST: https://rest.ene.si/meilisearch/getSynonyms/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/synonyms.html#get-synonyms
Aggiorna
POST: https://rest.ene.si/meilisearch/updateSynonyms/{index_uid}Parametri
| synonyms | obbligatorio | array contentente parole e relativi sinonimi (ad esempio: ['wolverine' => ['xmen', 'logan'],'logan' => ['wolverine', 'xmen'],'wow' => ['world of warcraft']]) |
Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/synonyms.html#update-synonyms
Resetta
POST: https://rest.ene.si/meilisearch/resetSynonyms/{index_uid}Per info aggiuntive, consultare la documentazione qui: https://docs.meilisearch.com/reference/api/synonyms.html#reset-synonyms