調用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"
    }
]

正常返回示例

JSON格式 

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。