全部產品
Search
文件中心

Elasticsearch:UpdateAliwsDict

更新時間:Jan 16, 2025

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

錯誤碼

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