调用UpdateSynonymsDicts,上传词典,设置同义词。

调试

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

请求头

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

请求语法

PUT /openapi/instances/[InstanceId]/synonymsDict HTTPS|HTTP

请求参数

名称 类型 是否必选 示例值 描述
InstanceId String es-xx-b8ps5vthlfdf029***

实例ID。

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

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

返回数据

名称 类型 示例值 描述
RequestId String 7C5622CC-B312-426F-85AA-B0271*******

请求ID。

Result Array

返回结果。

fileSize Long 220

文件大小。

name String deploy_0.dic

上传的文件名称。

ossObject Struct

OSS开放存储文件描述。

bucketName String search-cloud-test-cn-****

OSS命名空间名称。

etag String "5B3C1A2E053D763E1B002CC607C5A0FE1****"

在Bucket的每个Object生成时创建,用于标示一个Object的内容。

key String synonym_txt/0.txt

Object的Key,即开放存储的ObjectKey。

sourceType String OSS

同义词来源类型,支持:

  • UPLOAD:上传文件。
  • OSS:OSS开放存储。
  • ORIGIN:开源ES。
type String 词典类型

词典类型,支持:

  • STOP:停用词。
  • MAIN:主词典。
  • SYNONYMS:同义词。
  • ALI_WS:阿里词典。

示例

请求示例

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

正常返回示例

XML 格式

<0>
    <name>deploy_0.dic</name>
    <fileSize>220</fileSize>
    <sourceType>OSS</sourceType>
    <type>MAIN</type>
</0>
<1>
    <name>SYSTEM_MAIN.dic</name>
    <fileSize>2782602</fileSize>
    <sourceType>ORIGIN</sourceType>
    <type>MAIN</type>
</1>
<2>
    <name>SYSTEM_STOPWORD.dic</name>
    <fileSize>132</fileSize>
    <sourceType>ORIGIN</sourceType>
    <type>STOP</type>
</2>

JSON 格式

[
        {
            "name":"deploy_0.dic",
            "fileSize":220,
            "sourceType":"OSS",
            "type":"MAIN"
        },
        {
            "name":"SYSTEM_MAIN.dic",
            "fileSize":2782602,
            "sourceType":"ORIGIN",
            "type":"MAIN"
        },
        {
            "name":"SYSTEM_STOPWORD.dic",
            "fileSize":132,
            "sourceType":"ORIGIN",
            "type":"STOP"
        }
    ]

错误码

HttpCode 错误码 错误信息 描述
400 InstanceNotFound The instanceId provided does not exist 实例找不到,请核对实例状态

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