调用UpdateAliwsDict,更新AliNLP分词插件(analysis-aliws)的词典文件。支持自定义词库配置。

调用此接口时,请注意:

  • 5.x版本的实例不支持AliNLP分词插件。
  • 如果词典文件来源于OSS,需要确保OSS存储空间为公共可读。
  • 如果已经上传的词典不加ORIGIN配置,调用此接口后,词典文件会被删除。

调试

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

请求头

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

请求语法

PUT /openapi/instances/[InstanceId]/aliws-dict HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
InstanceId String Path es-cn-n6w1o1x0w001c****

实例ID。

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

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

RequestBody

RequestBody中还需填入以下参数。

参数

类型

是否必须

示例值

描述

name

String

aliws_ext_dict.txt

上传的词典文件名称。

ossObject

Array

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

└bucketName

String

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

OSS存储空间(Bucket)名称。

└key

String

oss/aliws_ext_dict.txt

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

sourceType

String

OSS

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

注意:

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

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

type

String

ALI_WS

词典类型,固定值:ALI_WS(AliNLP分词)。

说明 └表示子参数。

示例如下。


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

返回数据

名称 类型 示例值 描述
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

请求ID。

Result Array of DictList

返回结果。

fileSize Long 6226

文件大小,单位:Byte。

name String aliws_ext_dict.txt

上传的文件名称。

sourceType String OSS

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

  • OSS:使用OSS开放存储
  • ORIGIN:保留之前已经上传的词典
type String ALI_WS

词典类型,支持:ALI_WS(AliNLP分词)。

示例

请求示例

PUT /openapi/instances/es-cn-n6w1o1x0w001c****/aliws-dict HTTP/1.1
公共请求头
[
    {
        "name":"deploy_0.txt",
        "ossObject":{
            "bucketName":"search-cloud-test-cn-****",
            "key":"user_dict/dict_0.txt"
        },
        "sourceType":"OSS",
        "type":"ALI_WS"
    },
    {
        "name":"aliws_ext_dict.txt",
        "sourceType":"ORIGIN",
       "type":"ALI_WS"
    }
]

正常返回示例

XML格式

<Result>
    <name>aliws_ext_dict.txt</name>
    <fileSize>6243</fileSize>
    <sourceType>OSS</sourceType>
    <type>ALI_WS</type>
</Result>
<RequestId>6A185DDB-3E87-448B-8932-8F77E35****</RequestId>

JSON格式

{
    "Result":[
        {
            "name":"aliws_ext_dict.txt",
            "fileSize":6243,
            "sourceType":"OSS",
            "type":"ALI_WS"
        }
    ],
    "RequestId":"6A185DDB-3E87-448B-8932-8F77E35****"
}

错误码

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