UpdateSynonymsDicts_Elasticsearch_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
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
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

调用此接口时,请注意:

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求语法

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

路径参数

字段名称字段详情
InstanceIdstring

实例 ID。

示例值:es-cn-nif1q9o8r0008****

请求参数

字段名称字段详情
clientTokenstring

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

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

请求说明

RequestBody

RequestBody 中还需填入以下参数。

参数类型是否必须示例值描述
nameStringdic_0.txt上传的词典文件名称,必须为 TXT 类型。
ossObjectArrayOSS 的开放存储文件描述。当 sourceType 为 OSS 时,必填。
└bucketNameStringsearch-cloud-test-cn-****OSS 存储空间(Bucket)名称。
└keyStringoss/dic_0.txt词典文件在 OSS Bucket 中的存储路径。
sourceTypeStringOSS词典文件来源类型,可选值:OSS(使用 OSS 开放存储)、ORIGIN(保留之前已经上传的词典)。
注意:
本地文件需要先上传至 OSS,再通过 OSS 引用。
如果已经完成上传的词典不加 ORIGIN 进行配置,会被系统删除。
typeStringSYNONYMS要更新的词典类型,固定为 SYNONYMS。
说明 └表示子参数。

示例如下。

[
    {
        "name":"deploy_0.txt",
        "ossObject":{
            "bucketName":"search-cloud-test-cn-****",
            "key":"user_dict/dict_0.dic"
        },
        "sourceType":"OSS",
        "type":"SYNONYMS"
    },
    {
        "name":"SYSTEM_STOPWORD.txt",
        "sourceType":"ORIGIN",
        "type":"SYNONYMS"
    }
]

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:7C5622CC-B312-426F-85AA-B0271*******
Resultarray<object>

返回结果。

返回示例

变更历史

变更时间变更内容概要操作
2022-08-30
删除错误码400

相关示例