Skip to content

Commit 1ddccd7

Browse files
qdequeleqdequele
committed
Add Getting started section with SDKs, frameworks, and integrations
Import the Getting started tab with overview, features catalog, 10 SDK quick starts, 4 framework guides, 4 instant-meilisearch guides, and 6 integration guides. Fix ~120 broken internal links from the import and expand features page to cover all Meilisearch capabilities. Entire-Checkpoint: 9c68757644a6
1 parent 31c4e55 commit 1ddccd7

27 files changed

Lines changed: 4170 additions & 0 deletions

‎docs.json‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,62 @@
155155
{
156156
"version": "latest",
157157
"tabs": [
158+
{
159+
"tab": "Getting started",
160+
"groups": [
161+
{
162+
"group": "Introduction",
163+
"pages": [
164+
"getting_started/overview",
165+
"getting_started/features"
166+
]
167+
},
168+
{
169+
"group": "Back-end SDKs",
170+
"pages": [
171+
"getting_started/sdks/javascript",
172+
"getting_started/sdks/python",
173+
"getting_started/sdks/php",
174+
"getting_started/sdks/ruby",
175+
"getting_started/sdks/go",
176+
"getting_started/sdks/rust",
177+
"getting_started/sdks/java",
178+
"getting_started/sdks/dotnet",
179+
"getting_started/sdks/swift",
180+
"getting_started/sdks/dart"
181+
]
182+
},
183+
{
184+
"group": "Instant-meilisearch",
185+
"pages": [
186+
"getting_started/instant_meilisearch/javascript",
187+
"getting_started/instant_meilisearch/react",
188+
"getting_started/instant_meilisearch/vue",
189+
"getting_started/instant_meilisearch/docsearch"
190+
]
191+
},
192+
{
193+
"group": "Framework integrations",
194+
"pages": [
195+
"getting_started/frameworks/laravel",
196+
"getting_started/frameworks/strapi",
197+
"getting_started/frameworks/rails",
198+
"getting_started/frameworks/symfony"
199+
]
200+
},
201+
{
202+
"group": "Integrations",
203+
"pages": [
204+
"getting_started/integrations/firebase",
205+
"getting_started/integrations/gatsby",
206+
"getting_started/integrations/vercel",
207+
"getting_started/integrations/postman",
208+
"getting_started/integrations/meilisearch_importer",
209+
"getting_started/integrations/meilisync"
210+
]
211+
}
212+
]
213+
},
158214
{
159215
"tab": "Learn",
160216
"groups": [

‎getting_started/features.mdx‎

Lines changed: 209 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,209 @@
1+
---
2+
title: Features
3+
sidebarTitle: Features
4+
description: Explore all Meilisearch capabilities - from full-text search to AI-powered semantic search.
5+
---
6+
7+
Meilisearch provides a comprehensive set of search features designed to deliver fast, relevant results for any use case.
8+
9+
## Search capabilities
10+
11+
### Full-text search
12+
13+
Lightning-fast keyword search with typo tolerance and customizable relevancy.
14+
15+
| Feature | Description |
16+
|---------|-------------|
17+
| Sub-50ms responses | Fast search regardless of dataset size |
18+
| [Typo tolerance](/learn/relevancy/typo_tolerance_settings) | Get relevant results even with spelling mistakes |
19+
| [Ranking rules](/learn/relevancy/ranking_rules) | 6 default rules plus custom ranking |
20+
| [Ranking score](/learn/relevancy/ranking_score) | Relevancy scores with optional detailed breakdown |
21+
| [Synonyms](/learn/relevancy/synonyms) | Define equivalent terms for better recall |
22+
| [Stop words](/reference/api/settings/get-stopwords) | Ignore common words like "the" or "and" |
23+
| [Distinct attribute](/learn/relevancy/distinct_attribute) | Deduplicate results by a specific field |
24+
| [Prefix search](/learn/engine/prefix) | Results update as users type |
25+
| [Matching strategy](/reference/api/search/search-with-post#body-matching-strategy) | Control how query terms are matched: `last`, `all`, or `frequency` |
26+
| [Phrase search](/reference/api/search/search-with-post) | Use double quotes to search for an exact phrase |
27+
| [Negative search](/reference/api/search/search-with-post) | Exclude terms from results using the minus operator |
28+
| [Placeholder search](/reference/api/search/search-with-post) | Return all results when the query is empty |
29+
30+
### Querying and result formatting
31+
32+
| Feature | Description |
33+
|---------|-------------|
34+
| [Highlighting](/reference/api/search/search-with-post#highlight-tags) | Emphasize query matches in results with customizable tags |
35+
| [Cropping](/reference/api/search/search-with-post#body-attributes-to-crop) | Return only the relevant portion of long text fields |
36+
| [Matches position](/reference/api/search/search-with-post#body-show-matches-position) | Get byte positions and lengths of matched terms |
37+
| [Search cutoff](/reference/api/settings/get-searchcutoffms) | Set a maximum time limit for search queries |
38+
| [Tokenization](/learn/indexing/tokenization) | Customize how queries are broken into tokens, with custom separators and dictionaries |
39+
40+
### AI-powered search
41+
42+
Semantic and hybrid search using vector embeddings for meaning-based results.
43+
44+
| Feature | Description |
45+
|---------|-------------|
46+
| [Hybrid search](/learn/ai_powered_search/getting_started_with_ai_search) | Combine keyword and semantic search |
47+
| [Embedders](/learn/ai_powered_search/choose_an_embedder) | OpenAI, Hugging Face, Cohere, Mistral, Voyage, Gemini, Cloudflare, Ollama, and custom REST |
48+
| [Similar documents](/learn/ai_powered_search/retrieve_related_search_results) | Find related content automatically |
49+
| [Image search](/learn/ai_powered_search/image_search_with_multimodal_embeddings) | Search images with multimodal embeddings |
50+
| [Multi-embedder](/reference/api/settings/get-embedders) | Multiple embedding models on the same document |
51+
| [User-provided vectors](/learn/ai_powered_search/search_with_user_provided_embeddings) | Bring your own pre-generated embeddings |
52+
53+
### Conversational search
54+
55+
Build chat interfaces powered by your search data with LLM integration.
56+
57+
| Feature | Description |
58+
|---------|-------------|
59+
| [Chat completions](/learn/chat/getting_started_with_chat) | RAG-powered conversational search |
60+
| [LLM providers](/learn/chat/chat_tooling_reference) | OpenAI, Azure OpenAI, Mistral, Google Gemini, vLLM, and custom providers |
61+
| [Streaming responses](/reference/api/chats/chat-completions) | Stream chat responses in real time |
62+
| [Chat workspaces](/reference/api/chats/get-chat-settings) | Configure chat settings per index |
63+
64+
### Personalization
65+
66+
| Feature | Description |
67+
|---------|-------------|
68+
| [User preference ranking](/reference/api/search/search-with-post#body-personalize-one-of-1) | Re-rank results based on individual user preferences using AI embeddings |
69+
| Real-time adaptation | Adjust results as user preferences evolve |
70+
71+
### Filtering and faceting
72+
73+
Refine search results with powerful filters and build faceted navigation.
74+
75+
| Feature | Description |
76+
|---------|-------------|
77+
| [Filters](/learn/filtering_and_sorting/filter_search_results) | Filter by any attribute with complex expressions (AND/OR) |
78+
| [Facets](/learn/filtering_and_sorting/search_with_facet_filters) | Build faceted navigation interfaces |
79+
| [Facet types](/learn/filtering_and_sorting/facet_types) | AND/OR operators, numeric, boolean, and date facets |
80+
| [Sorting](/learn/filtering_and_sorting/sort_search_results) | Sort results by any field |
81+
| [Geo search](/learn/filtering_and_sorting/geosearch) | Geo radius, bounding box, geo sorting, and distance calculation |
82+
83+
### Multi-search and federation
84+
85+
Query multiple indexes in a single request for complex search scenarios.
86+
87+
| Feature | Description |
88+
|---------|-------------|
89+
| [Multi-search](/learn/multi_search/multi_search_vs_federated_search) | Query multiple indexes at once |
90+
| [Federated search](/learn/multi_search/performing_federated_search) | Merge results from multiple sources with configurable weights |
91+
92+
## Scaling
93+
94+
Scale Meilisearch horizontally across multiple instances or optimize resource usage on a single node.
95+
96+
| Feature | Description |
97+
|---------|-------------|
98+
| [Sharding](/learn/multi_search/implement_sharding) | Distribute documents across multiple instances for horizontal scaling |
99+
| [Replication](/reference/api/experimental-features/get-network-topology) | Replicate data across multiple instances for high availability |
100+
| [Remote federation](/reference/api/experimental-features/get-network-topology) | Federate search across multiple Meilisearch instances |
101+
| Memory mapping | Efficient memory usage through memory-mapped storage |
102+
103+
## Database
104+
105+
### Document database
106+
107+
| Feature | Description |
108+
|---------|-------------|
109+
| [Schemaless](/learn/getting_started/documents) | Index documents without a predefined schema |
110+
| [Documents](/learn/getting_started/documents) | Add, replace, update, and delete documents |
111+
| [Delete by filter](/reference/api/documents/delete-documents-by-filter) | Delete documents matching a filter expression |
112+
| [Update by function](/reference/api/documents/edit-documents-by-function) | Partial updates to documents using functions |
113+
| [Searchable attributes](/learn/relevancy/displayed_searchable_attributes) | Configure which fields are searchable and their priority |
114+
| [Displayed attributes](/learn/relevancy/displayed_searchable_attributes) | Control which fields are returned in results |
115+
| [Filterable attributes](/learn/filtering_and_sorting/filter_search_results) | Define which fields can be used in filters |
116+
| [Sortable attributes](/learn/filtering_and_sorting/sort_search_results) | Define which fields can be used for sorting |
117+
| [Index swap](/reference/api/indexes/swap-indexes) | Swap indexes to perform updates without downtime |
118+
119+
### Vector database
120+
121+
| Feature | Description |
122+
|---------|-------------|
123+
| [Similar documents](/learn/ai_powered_search/retrieve_related_search_results) | Find semantically similar documents using vector embeddings |
124+
| [Binary quantization](/reference/api/settings/get-embedders) | Compress vectors to save storage |
125+
| DiskANN | Disk-based approximate nearest neighbors for large datasets |
126+
| [Auto embedding](/reference/api/settings/get-embedders) | Automatically generate embeddings without manual input |
127+
128+
## Platform features
129+
130+
### Security
131+
132+
Protect your data with API keys and multi-tenant access control.
133+
134+
| Feature | Description |
135+
|---------|-------------|
136+
| [API keys](/learn/security/basic_security) | Admin, search, and chat key types for different access levels |
137+
| [Tenant tokens](/learn/security/multitenancy_tenant_tokens) | Secure multi-tenant applications with document-level access control |
138+
| [Search rules](/learn/security/tenant_token_reference) | Restrict which documents users can access |
139+
140+
### Tasks and monitoring
141+
142+
Monitor indexing operations and receive notifications.
143+
144+
| Feature | Description |
145+
|---------|-------------|
146+
| [Task management](/learn/async/working_with_tasks) | Track and manage async operations |
147+
| [Batches](/learn/async/asynchronous_operations#task-batches) | Automatic task batching for efficient processing |
148+
| [Webhooks](/learn/async/task_webhook) | Get notified when tasks complete |
149+
| Diff indexing | Only index differences between datasets |
150+
151+
### Analytics (Cloud)
152+
153+
Track search behavior and optimize relevancy with built-in analytics.
154+
155+
| Feature | Description |
156+
|---------|-------------|
157+
| [Search analytics](/learn/analytics/configure_analytics_events) | Monitor search patterns, no-result rates, and top queries |
158+
| [Click tracking](/learn/analytics/bind_events_user) | Track which results users engage with |
159+
| [Metrics reference](/learn/analytics/analytics_metrics_reference) | Click-through rate, conversion rate, average click position |
160+
| Monitoring | Search latency, indexing latency, bandwidth, and API health |
161+
162+
### Pagination
163+
164+
| Feature | Description |
165+
|---------|-------------|
166+
| [Pagination](/guides/front_end/pagination) | Offset/limit and cursor-based pagination |
167+
168+
## Language support
169+
170+
Meilisearch provides optimized support for many languages:
171+
172+
- **Latin-based languages**: English, French, Spanish, German, Italian, Portuguese, etc.
173+
- **CJK**: Chinese, Japanese, Korean with specialized tokenization
174+
- **RTL languages**: Hebrew, Arabic
175+
- **Others**: Thai, Greek, and more
176+
177+
[See full language support →](/learn/resources/language)
178+
179+
## Cloud features
180+
181+
These features are available exclusively on Meilisearch Cloud.
182+
183+
| Feature | Description |
184+
|---------|-------------|
185+
| Crawler | Crawl web pages with JS rendering, DocSearch mode, and schema extraction |
186+
| [Search preview](/learn/getting_started/search_preview) | Visual search interface with filtering, sorting, and document CRUD |
187+
| [Teams](/learn/teams/teams) | Organize projects and members into team workspaces |
188+
| [Enterprise SSO/SCIM](/learn/self_hosted/enterprise_edition) | SAML 2.0 SSO and automated user provisioning |
189+
| Autoscale disk | Automatically scale storage as data grows |
190+
| Automatic backups | Scheduled backups for data safety |
191+
| One-click upgrade | Upgrade Meilisearch version with a single click |
192+
| Up to 99.999% SLA | Industry-leading service level agreement |
193+
194+
## Self-hosting
195+
196+
| Feature | Description |
197+
|---------|-------------|
198+
| [Configuration](/learn/self_hosted/configure_meilisearch_at_launch) | CLI flags and environment variables |
199+
| [Snapshots](/learn/data_backup/snapshots) | Full binary copies for fast restoration |
200+
| [Dumps](/learn/data_backup/dumps) | Portable JSON exports for migration |
201+
| [Master key](/learn/security/basic_security) | Secure your instance with a master key |
202+
203+
## Integration options
204+
205+
| Option | Description |
206+
|--------|-------------|
207+
| [REST API](/reference/api/openapi) | Direct HTTP integration |
208+
| [Official SDKs](/learn/resources/sdks) | 10+ language SDKs |
209+
| [Frameworks](/learn/resources/sdks#framework-integrations) | Laravel, Rails, Strapi, Symfony |

0 commit comments

Comments
 (0)