UpdateHotIkDicts - Elasticsearch - Alibaba Cloud ドキュメントセンター

UpdateHotIkDicts を呼び出して、Alibaba Cloud Elasticsearch インスタンスの IK 分詞プラグイン (IK メイン分詞シソーラスと IK ストップワードシソーラスを含む) を更新します。

この操作を呼び出す前に、以下の点にご注意ください。

辞書ファイルが Object Storage Service (OSS) バケットに保存されている場合は、バケットのアクセス制御リスト (ACL) がパブリック読み取りになっていることを確認する必要があります。
アップロードされた辞書ファイルの sourceType を ORIGIN に設定しない場合、この操作の呼び出し後にファイルは削除されます。

デバッグ

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

リクエストヘッダー

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

リクエスト構文

PUT /openapi/instances/{InstanceId}/ik-hot-dict HTTP/1.1

リクエストパラメーター

パラメーター	タイプ	位置	必須	例	詳細
InstanceId	String	Path	Yes	es-cn-oew1q8bev0002****	インスタンス ID。
clientToken	String	Query	No	5A2CFF0E-5718-45B5-9D4D-70B3FF****	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。
	String	Body	No	RequestBody の例を参照	RequestBody

RequestBody

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

フィールド	パラメーター	必須	例	説明
name	String	Yes	dic_0.dic	アップロードする辞書ファイルの名前。
ossObject	Array	Yes		辞書ファイルに関する情報。 sourceType を OSS に設定した場合、このパラメーターは必須です。
└bucketName	String	Yes	search-cloud-test-cn-****	辞書ファイルを保存する OSS バケットの名前。
└key	String	Yes	oss/dic_0.dic	OSS バケット内の辞書ファイルのパス。
sourceType	String	Yes	OSS	辞書ファイルのソースタイプ。有効な値: OSS および ORIGIN。使用上の注意: ローカルファイルを OSS にアップロードしてから、OSS を使用してローカルファイルを参照する必要があります。アップロードされた辞書に ORIGIN を追加しない場合、システムはアップロードされた辞書を削除します。
type	String	Yes	MAIN	更新する辞書のタイプ。有効な値: MAIN および STOP。

└ は子パラメーターを示します。
すべての API パラメーターを RequestBody パラメーターに追加する必要があります。たとえば、ストップワードを追加する場合、デフォルトまたはインストールされているシソーラス内のすべての辞書ファイルを RequestBody に書き込む必要があります。次の例では、"sourceType":"ORIGIN" は既存の辞書ファイルです。

[
    {
        "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	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****	リクエスト ID。
Result	DictList の配列		レスポンスパラメーター。
fileSize	Long	6	辞書ファイルのサイズ。単位: バイト。
sourceType	String	OSS	辞書ファイルのソースタイプ。有効な値: OSS ORIGIN
name	String	deploy_0.dic	辞書ファイルの名前。
type	String	MAIN	辞書タイプ。有効な値: MAIN: IK メイン辞書 STOP: IK ストップワードリスト

例

リクエストの例

PUT /openapi/instances/es-cn-oew1q8bev0002****/ik-hot-dict HTTP/1.1
共通リクエストパラメーター
[
    {
        "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 形式

HTTP/1.1 200 OK
Content-Type:application/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****"
}

一般的なエラーコード

エラーコードの一覧については、サービスエラーコードをご参照ください。