すべてのプロダクト
Search

このプロダクト

    Elasticsearch:UpdateDict

    ドキュメントセンター

    Elasticsearch:UpdateDict

    最終更新日:Mar 17, 2025

    UpdateDict を呼び出して、Alibaba Cloud Elasticsearch インスタンスの IK ワードセグメンテーション プラグイン（IK メインワードセグメンテーション シソーラスおよび IK ストップワード ライブラリを含む）をコールドアップデートします。

    このインターフェイスを呼び出すときは、次の点に注意してください。

    • 辞書ファイルが OSS からのものである場合は、OSS ストレージスペースがパブリックに読み取り可能であることを確認してください。
    • アップロードされた辞書が ORIGIN で設定されていない場合、このインターフェイスが呼び出された後に辞書ファイルは削除されます。

    デバッグ

    OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

    リクエストヘッダー

    この操作では、共通のリクエストヘッダーのみを使用します。 詳細については、「共通リクエストパラメーター」をご参照ください。

    リクエスト構文

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

    リクエストパラメーター

    パラメーター タイプ 位置 必須 例 説明
    InstanceId 文字列 パス はい es-cn-nif1q9o8r0008****

    インスタンスの ID です。

    clientToken 文字列 クエリ いいえ 5A2CFF0E-5718-45B5-9D4D-70B3FF****

    このパラメーターは、リクエストのべき等性を確保するために使用されます。クライアントで値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。

    リクエスト本文

    リクエスト本文には、次のパラメーターを入力する必要があります。

    パラメーター

    タイプ

    必須

    例

    説明

    name

    文字列

    はい

    dic_0.dic

    アップロードされた辞書ファイルの名前。

    ossObject

    配列

    はい

    OSS のオープンストレージファイルの説明。 sourceType が OSS の場合に必須です。

    └bucketName

    文字列

    はい

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

    OSS バケットの名前。

    └key

    文字列

    はい

    oss/dic_0.dic

    OSS バケットに辞書ファイルが格納されているパス。

    sourceType

    文字列

    はい

    OSS

    辞書ファイルのソースタイプ。オプション値：OSS（OSS オープンストレージ）および ORIGIN（以前にアップロードされた辞書を保持）。

    注：

    ローカルファイルは、OSS によって参照される前に OSS にアップロードする必要があります。

    以前にアップロードされた辞書が ORIGIN で設定されていない場合、システムによって削除されます。

    type

    文字列

    はい

    MAIN

    更新する辞書タイプ。オプション値：MAIN（IK メインセグメンテーション シソーラス）または STOP（IK 非アクティブ化シソーラス）。

    説明 └ は子パラメーターを示します。

    次のサンプル文は参考用です。 

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

    レスポンスパラメーター

    パラメーター タイプ 例 説明
    RequestId 文字列 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****

    リクエストの ID です。

    Result DictList の配列

    戻り結果。

    fileSize 長整数 2782602

    辞書ファイルサイズ、単位：バイト。

    name 文字列 SYSTEM_MAIN.dic

    辞書ファイル名。

    sourceType 文字列 ORIGIN

    辞書ファイルのソースタイプ、サポートされているもの：

    • OSS：OSS オープンストレージ
    • ORIGIN：以前にアップロードされた辞書を保持
    type 文字列 MAIN

    辞書タイプ、サポートされているもの：

    • MAIN：IK メイン participle シソーラス
    • STOP：IK ストップワード ライブラリ

    例

    サンプルリクエスト

    
     PUT /openapi/instances/es-cn-oew1q8bev0002 ****/dict HTTP/1.1 public request header [ { "name":"deploy_0.dic", "ossObject":{ "bucketName":"search-cloud-test-cn-****", "key":"user_dict/dict_0.dic" }, "sourceType":"OSS", "type":"MAIN" }, { "name":"deploy_2.dic", "ossObject":{ "bucketName":"search-cloud-test-cn-****", "key":"user_dict/dict_2.dic" }, "sourceType":"OSS", "type":"STOP" }, { "name":"SYSTEM_MAIN.dic", "sourceType":"ORIGIN", "type":"MAIN" }, { "name":"SYSTEM_STOPWORD.dic", "sourceType":"ORIGIN", "type":"STOP" } ]

    サンプルの成功レスポンス

    JSON フォーマット

    
     { "Result": [ { "name": "deploy_0.dic", "ossObject": { "bucketName": "search-cloud-test-cn-****", "key": "user_dict/dict_0.dic" }, "sourceType": "OSS", "type": "MAIN" }, { "name": "deploy_2.dic", "ossObject": { "bucketName": "search-cloud-test-cn-****", "key": "user_dict/dict_2.dic" }, "sourceType": "OSS", "type": "STOP" }, { "name": "SYSTEM_MAIN.dic", "sourceType": "ORIGIN", "type": "MAIN" }, { "name": "SYSTEM_STOPWORD.dic", "sourceType": "ORIGIN", "type": "STOP" } ], "RequestId": "E1F6991B-1F77-47EA-9666-593F11E3****" }

    エラーコード

    エラーコードのリストについては、 API エラーセンター をご覧ください。