Meilisearch 全栈实战指南

3.1 文档管理

在 Meilisearch 中，数据以文档（documents）形式存储。文档是 JSON 对象，每个文档必须有一个唯一标识符。

添加文档

以下是使用 HTTP API 添加文档的示例：

curl \
  -X POST 'http://localhost:7700/indexes/movies/documents' \
  -H 'Content-Type: application/json' \
  --data-binary '[
    {
      "id": 1,
      "title": "卧虎藏龙",
      "director": "李安",
      "genres": ["动作", "冒险", "奇幻"],
      "release_year": 2000
    },
    {
      "id": 2,
      "title": "红高粱",
      "director": "张艺谋",
      "genres": ["剧情", "历史", "爱情"],
      "release_year": 1988
    }
  ]'

使用 JavaScript 客户端库添加文档：

import { MeiliSearch } from 'meilisearch'

const client = new MeiliSearch({
  host: 'http://localhost:7700'
})

const documents = [
  {
    id: 1,
    title: '卧虎藏龙',
    director: '李安',
    genres: ['动作', '冒险', '奇幻'],
    release_year: 2000
  },
  {
    id: 2,
    title: '红高粱',
    director: '张艺谋',
    genres: ['剧情', '历史', '爱情'],
    release_year: 1988
  }
]

// 如果索引不存在，会自动创建
client.index('movies').addDocuments(documents)
  .then((res) => console.log(res))
  .catch((err) => console.error(err))

更新文档

更新文档与添加类似，如果文档 ID 已存在，则会更新该文档：

client.index('movies').updateDocuments([
  {
    id: 1,
    rating: 8.9  // 只更新 rating 字段
  }
])

删除文档

通过 ID 删除单个或多个文档：

// 删除单个文档
client.index('movies').deleteDocument(1)

// 删除多个文档
client.index('movies').deleteDocuments([1, 2, 3])

或使用 HTTP API：

curl -X DELETE 'http://localhost:7700/indexes/movies/documents/1'

3.2 索引操作

索引（index）是 Meilisearch 中存储文档的容器。每个索引都有自己的设置和配置。

创建索引

client.createIndex('books', { primaryKey: 'isbn' })
  .then((index) => {
    console.log(`Index ${index.uid} 创建成功！`)
  })

使用 HTTP API：

curl \
  -X POST 'http://localhost:7700/indexes' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "uid": "books",
    "primaryKey": "isbn"
  }'

获取索引信息

client.getIndex('books')
  .then((index) => {
    console.log(index)
  })

列出所有索引

client.getIndexes().then((indexes) => {
  console.log(indexes)
})

删除索引

client.deleteIndex('books')

3.3 搜索功能

搜索是 Meilisearch 的核心功能，支持多种搜索选项和过滤器。

基本搜索

最简单的搜索只需要一个查询字符串：

client.index('movies').search('张艺谋')
  .then((res) => {
    console.log(res.hits)  // 搜索结果
    console.log(res.nbHits) // 结果总数
    console.log(res.processingTimeMs) // 处理时间
  })

使用 HTTP API：

curl -X GET 'http://localhost:7700/indexes/movies/search?q=张艺谋'

高级搜索选项

Meilisearch 支持多种高级搜索选项：

client.index('movies').search('红', {
  limit: 20,  // 返回结果数量限制
  offset: 0,  // 分页起始位置
  attributesToRetrieve: ['title', 'director', 'release_year'],  // 返回的字段
  attributesToHighlight: ['title'],  // 高亮匹配的字段
  filter: 'release_year > 1990',  // 过滤条件
  sort: ['release_year:desc']  // 排序条件
})

4.1 相关性调优

相关性调优是提高搜索结果质量的关键。Meilisearch 提供了多种方法来调整搜索结果的相关性。

使用 ranking rules

Meilisearch 允许你定义自己的 ranking rules，以控制搜索结果的排序。

client.index('movies').updateRankingRules([
  {
    "name": "custom_rule",
    "type": "words",
    "value": {
      "words": ["张艺谋"],
      "typo": true
    }
  }
])

使用 filterable attributes

通过指定 filterable attributes，可以限制搜索结果的范围。

client.index('movies').updateFilterableAttributes(['director'])

使用 searchable attributes

通过指定 searchable attributes，可以控制哪些字段可以被搜索。

client.index('movies').updateSearchableAttributes(['title', 'director'])

4.2 分面搜索

分面搜索是一种强大的搜索功能，可以按不同的维度对搜索结果进行分类和过滤。

使用 facets

通过使用 facets，可以按不同的属性对搜索结果进行过滤和聚合。

client.index('movies').search('张艺谋', {
  facets: ['director']
})

使用 facet exclusion

通过使用 facet exclusion，可以排除某些分面，从而缩小搜索结果的范围。

client.index('movies').search('张艺谋', {
  facets: ['director'],
  facetFilters: ['!director:李安']
})

4.3 拼写容错

拼写容错是提高搜索体验的重要功能，可以处理用户输入中的拼写错误。

使用 typo tolerance

通过使用 typo tolerance，可以处理用户输入中的拼写错误，并返回相关的结果。

client.index('movies').search('张艺谋', {
  typoTolerance: {
    enabled: true,
    minWordSize: {
      oneTypo: 3,
      twoTypos: 7
    },
    disableOnAttributes: ['director']
  }
})