全部产品
Search
文档中心

检索分析服务Elasticsearch版:UpdateHotIkDicts

更新时间:Dec 15, 2023

调用UpdateHotIkDicts,热更新阿里云Elasticsearch实例的IK分词插件,包括IK主分词词库和IK停用词词库。

调用此接口时,请注意:

  • 如果词典文件来源于OSS,需要确保OSS存储空间为公共可读。
  • 如果已经上传的词典不加ORIGIN配置,调用此接口后,词典文件会被删除。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

PUT /openapi/instances/{InstanceId}/ik-hot-dict HTTP/1.1

请求参数

名称

类型

位置

是否必选

示例值

描述

InstanceId String Path es-cn-oew1q8bev0002****

实例ID。

clientToken String Query 5A2CFF0E-5718-45B5-9D4D-70B3FF****

用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过64个ASCII字符。

String Body 请参见RequestBody中的示例

RequestBody

RequestBody

RequestBody中还需填入以下参数。

参数

类型

是否必须

示例值

描述

name

String

dic_0.dic

上传的词典文件名称。

ossObject

Array

OSS的开放存储文件描述。当sourceType为OSS时,必填。

└bucketName

String

search-cloud-test-cn-****

OSS存储空间(Bucket)名称。

└key

String

oss/dic_0.dic

词典文件在OSS Bucket中的存储路径。

sourceType

String

OSS

词典文件来源类型,可选值:OSS(使用OSS开放存储)、ORIGIN(保留之前已经上传的词典)。

注意

本地文件需要先上传至OSS,再通过OSS引用。

如果之前已经完成上传的词典不加ORIGIN进行配置,会被系统删除。

type

String

MAIN

要更新的词典类型。可选值:MAIN(IK主分词词库)、STOP(IK停用词库)。

  • └表示子参数。
  • RequestBody要添加全量API参数。例如,添加停用词时,默认或已安装词库中的词典文件都需要写入RequestBody,以下示例中"sourceType":"ORIGIN"就是存量词典文件。
[
    {
        "name":"deploy_0.dic",
        "ossObject":{
            "bucketName":"search-cloud-test-cn-****",
            "key":"user_dict/dict_0.dic"
        },
        "sourceType":"OSS",
        "type":"MAIN"
    },
    {
        "name":"deploy_2.dic",
        "ossObject":{
            "bucketName":"search-cloud-test-cn-****",
            "key":"user_dict/dict_2.dic"
        },
        "sourceType":"OSS",
        "type":"STOP"
    },
    {
        "name":"SYSTEM_MAIN.dic",
        "sourceType":"ORIGIN",
         "type":"MAIN"
    },
    {
        "name":"SYSTEM_STOPWORD.dic",
        "sourceType":"ORIGIN",
        "type":"STOP"
    }
]

返回数据

名称

类型

示例值

描述

RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

请求ID。

Result Array of DictList

返回结果。

fileSize Long 6

词典文件大小,单位:Byte。

sourceType String OSS

词典文件来源类型,支持:

  • OSS:使用OSS开放存储
  • ORIGIN:保留之前已经上传的词典
name String deploy_0.dic

词典文件名。

type String MAIN

词典类型,支持:

  • MAIN:IK主分词词库
  • STOP:IK停用词词库

示例

请求示例

PUT /openapi/instances/es-cn-oew1q8bev0002****/ik-hot-dict HTTP/1.1
公共请求头
[
    {
        "name":"deploy_0.dic",
        "ossObject":{
            "bucketName":"search-cloud-test-cn-****",
            "key":"user_dict/dict_0.dic"
        },
        "sourceType":"OSS",
        "type":"MAIN"
    },
    {
        "name":"deploy_2.dic",
        "ossObject":{
            "bucketName":"search-cloud-test-cn-****",
            "key":"user_dict/dict_2.dic"
        },
        "sourceType":"OSS",
        "type":"STOP"
    },
    {
        "name":"SYSTEM_MAIN.dic",
        "sourceType":"ORIGIN",
         "type":"MAIN"
    },
    {
        "name":"SYSTEM_STOPWORD.dic",
        "sourceType":"ORIGIN",
       "type":"STOP"
    }
]

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : [ {
    "name" : "deploy_0.dic",
    "ossObject" : {
      "bucketName" : "search-cloud-test-cn-****",
      "key" : "user_dict/dict_0.dic"
    },
    "sourceType" : "OSS",
    "type" : "MAIN"
  }, {
    "name" : "deploy_2.dic",
    "ossObject" : {
      "bucketName" : "search-cloud-test-cn-****",
      "key" : "user_dict/dict_2.dic"
    },
    "sourceType" : "OSS",
    "type" : "STOP"
  }, {
    "name" : "SYSTEM_MAIN.dic",
    "sourceType" : "ORIGIN",
    "type" : "MAIN"
  }, {
    "name" : "SYSTEM_STOPWORD.dic",
    "sourceType" : "ORIGIN",
    "type" : "STOP"
  } ],
  "RequestId" : "E1F6991B-1F77-47EA-9666-593F11E3****"
}

错误码

访问错误中心查看更多错误码。