Term Vectors API

Term Vectors API #

返回文档中特定字段的词项信息(词频、位置、偏移量等),用于文本分析和调试。

请求格式 #

GET /<index>/_termvectors/<_id>
POST /<index>/_termvectors/<_id>
GET /<index>/_termvectors          # 在请求体中提供临时文档
POST /<index>/_termvectors

批量获取:

GET /_mtermvectors
POST /_mtermvectors
GET /<index>/_mtermvectors
POST /<index>/_mtermvectors

路径参数 #

参数必需说明
<index>目标索引
<_id>文档 ID。省略时需在请求体中通过 doc 提供临时文档

查询参数 #

参数类型默认值说明
fieldsstring逗号分隔的字段列表
offsetsbooleantrue返回词项偏移量
positionsbooleantrue返回词项位置
payloadsbooleantrue返回词项负载
term_statisticsbooleanfalse返回词项的总词频和文档频率
field_statisticsbooleantrue返回文档计数、文档频率之和、总词频之和
realtimebooleantrue实时读取
routingstring路由值
preferencestring查询偏好

示例 #

GET /website/_termvectors/1?fields=title

在请求体中提供临时文档(无需事先索引):

POST /website/_termvectors
{
  "doc": {
    "title": "Easysearch is fast"
  },
  "per_field_analyzer": {
    "title": "standard"
  }
}

Multi Term Vectors #

POST /_mtermvectors
{
  "docs": [
    { "_index": "website", "_id": "1", "fields": ["title"] },
    { "_index": "website", "_id": "2", "fields": ["title", "text"] }
  ]
}

或简写:

POST /website/_mtermvectors
{
  "ids": ["1", "2"],
  "parameters": {
    "fields": ["title"],
    "term_statistics": true
  }
}

参考导航 #

需求参见
分析器调试映射与分析
检索单条文档Get API