UpdateDict
更新Elasticsearch实例的用户词典
服务地址：
华东1 金融云
输入参数
只看必填
InstanceId实例ID
clientToken用于保证请求的幂等性
body
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

接口说明

调用此接口时，请注意：

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

请求语法

PUT /openapi/instances/{InstanceId}/dict HTTP/1.1

路径参数

字段名称字段详情
InstanceIdstring

实例 ID。

示例值:es-cn-nif1q9o8r0008****参考取值来源:
    ListInstance

请求参数

字段名称字段详情
clientTokenstring

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

示例值:5A2CFF0E-5718-45B5-9D4D-70B3FF****
bodystring

请求说明

RequestBody

RequestBody 中还需填入以下参数。

参数类型是否必须示例值描述
nameString是dic_0.dic上传的词典文件名称。
ossObjectArray是OSS 的开放存储文件描述。当 sourceType 为 OSS 时，必填。
└bucketNameString是search-cloud-test-cn-****OSS 存储空间（Bucket）名称。
└keyString是oss/dic_0.dic词典文件在 OSS Bucket 中的存储路径。
sourceTypeString是OSS词典文件来源类型，可选值：OSS（使用 OSS 开放存储）、ORIGIN（保留之前已经上传的词典）。
注意：
本地文件需要先上传至 OSS，再通过 OSS 引用。
如果之前已经完成上传的词典不加 ORIGIN 进行配置，会被系统删除。
typeString是MAIN要更新的词典类型。可选值：MAIN（IK 主分词词库）或 STOP（IK 停用词库）。
说明 └表示子参数。

示例如下。

[
    {
        "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"
    }
]

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****
Resultarray<object>

返回结果。

变更历史
暂无变更历史