更新时间:2026-09-03 GMT+08:00

加载自定义词库

功能介绍

云搜索服务的词库用于对文本进行分词,使得一些特殊词语在分词的时候能够被识别出来,便于根据关键词搜索文本数据。例如,根据公司名称来查询;或者根据网络流行词来查询,如“喜大普奔”。也支持基于同义词词库,根据同义词搜索文本数据。CSS服务使用的分词器包括IK分词器和同义词分词器。IK分词器配备主词词库和停词词库;同义词分词器配备同义词词库。其中,IK分词器包含ik_max_word和ik_smart分词策略。同义词分词器使用的是ik_synonym分词策略。当预置词库不满足集群业务分词需求时,可以使用自定义词库,该接口用于加载存放于OBS的自定义词库。

调用方法

请参见如何调用API

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/thesaurus

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID和名称

约束限制

不涉及

取值范围

账户的项目ID。

默认取值

不涉及

cluster_id

String

参数解释

指定配置自定义词库的集群ID。获取方法请参见获取集群ID

约束限制

不涉及

取值范围

集群ID。

默认取值

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

bucket_name

String

参数解释

词库文件存放的OBS桶。

约束限制

桶类型必须为标准存储或者低频存储,不支持归档存储。

取值范围

不涉及

默认取值

不涉及

main_object

String

参数解释

主词词库文件对象。

约束限制

  • 必须为UTF-8无BOM编码的文本文件,一行一个分词,文件大小最大支持100M。

  • 7个词库参数至少修改一个词库。注:参数传递""空字符串为清空此词库,不传或传递null为不修改。

取值范围

不涉及

默认取值

不涉及

stop_object

String

参数解释

停词词库文件对象。

约束限制

  • 必须为UTF-8无BOM编码的文本文件,一行一个分词,文件大小最大支持100M。

  • 7个词库参数至少修改一个词库。注:参数传递""空字符串为清空此词库,不传或传递null为不修改。注:参数传递""空字符串为清空此词库,不传或传递null为不修改。

取值范围

不涉及

默认取值

不涉及

synonym_object

String

参数解释

同义词词库文件。

约束限制

  • 必须为UTF-8无BOM编码的文本文件,一行一个分词,文件大小最大支持100M。

  • 7个词库参数至少修改一个词库。注:参数传递""空字符串为清空此词库,不传或传递null为不修改。注:参数传递""空字符串为清空此词库,不传或传递null为不修改。

取值范围

不涉及

默认取值

不涉及

static_main_object

String

参数解释

静态主词词库文件。

约束限制

  • 必须为UTF-8无BOM编码的文本文件,一行一组分词,文件大小最大支持100M。

  • 7个词库参数至少修改一个词库。注:参数传递""空字符串为清空此词库,不传或传递null为不修改。仅支持此词库功能上线后的新集群。

取值范围

不涉及

默认取值

不涉及

static_stop_object

String

参数解释

静态停词词库文件。

约束限制

  • 必须为UTF-8无BOM编码的文本文件,一行一组分词,文件大小最大支持100M。

  • 7个词库参数至少修改一个词库。注:参数传递""空字符串为清空此词库,不传或传递null为不修改。仅支持此词库功能上线后的新集群。

取值范围

不涉及

默认取值

不涉及

extra_main_object

String

参数解释

Extra主词词库文件。

约束限制

  • 必须为UTF-8无BOM编码的文本文件,一行一组分词,文件大小最大支持100M。

  • 7个词库参数至少修改一个词库。注:参数传递""空字符串为清空此词库,不传或传递null为不修改。仅支持此词库功能上线后的新集群。

取值范围

不涉及

默认取值

不涉及

extra_stop_object

String

参数解释

Extra停词词库文件。

约束限制

  • 必须为UTF-8无BOM编码的文本文件,一行一组分词,文件大小最大支持100M。

  • 7个词库参数至少修改一个词库。注:参数传递""空字符串为清空此词库,不传或传递null为不修改。仅支持此词库功能上线后的新集群。

取值范围

不涉及

默认取值

不涉及

响应参数

状态码:200

请求成功。

请求示例

开启并配置词库信息。

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/thesaurus

{
  "bucket_name" : "test-bucket",
  "main_object" : "word/main.txt",
  "stop_object" : "word/stop.txt",
  "synonym_object" : "word/synonym.txt",
  "static_main_object" : "word/staticMain.txt",
  "static_stop_object" : "word/staticStop.txt",
  "extra_main_object" : "word/extraMain.txt",
  "extra_stop_object" : "word/extraStop.txt"
}

响应示例

状态码

状态码

描述

200

请求成功。

403

请求被拒绝访问。

返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。

500

表明服务端能被请求访问到,但是不能理解用户的请求。

错误码

请参见错误码