すべてのプロダクト
Search

このプロダクト

    Elasticsearch:UpdateSynonymsDicts

    ドキュメントセンター

    Elasticsearch:UpdateSynonymsDicts

    最終更新日:Mar 17, 2025

    UpdateSynonymsDicts を呼び出して、Elasticsearch インスタンスのシノニム辞書を更新します。

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

    • 辞書ファイルが OSS から取得された場合は、OSS バケットが公開読み取り可能であることを確認してください。
    • アップロードされた辞書ファイルに ORIGIN 構成が追加されていない場合、この操作を呼び出した後に辞書ファイルは削除されます。

    デバッグ

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

    リクエストヘッダー

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

    リクエスト構文

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

    リクエストパラメーター

    パラメータータイプ位置必須例説明
    InstanceIdStringPathはいes-cn-nif1q9o8r0008****

    インスタンスの ID。

    clientTokenStringQueryいいえ5A2CFF0E-5718-45B5-9D4D-70B3FF****

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

    RequestBody

    RequestBody に次のパラメーターを入力します。

    パラメーター

    タイプ

    必須

    例

    説明

    name

    String

    はい

    dic_0.txt

    アップロードした辞書ファイルの名前。 TXT ファイルである必要があります。

    ossObject

    Array

    いいえ

    OSS のオープンストレージファイルの説明。 sourceType が OSS に設定されている場合、このパラメーターは必須です。

    └bucketName

    String

    いいえ

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

    OSS バケットの名前。

    └key

    String

    いいえ

    oss/dic_0.txt

    OSS バケット内の辞書ファイルのストレージパス。

    sourceType

    String

    はい

    OSS

    辞書ファイルソースのタイプ。 有効な値：OSS（OSS を使用するオープンストレージサービス）および ORIGIN（以前にアップロードされた辞書を保持）。

    注：

    ローカルファイルは OSS にアップロードしてから、OSS を介して参照する必要があります。

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

    type

    String

    はい

    SYNONYMS

    更新する辞書のタイプ。 値は SYNONYMS に固定されています。

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

    例：

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

    レスポンスパラメーター

    パラメータータイプ例説明
    RequestIdString7C5622CC-B312-426F-85AA-B0271*******

    リクエストの ID。

    ResultDictList の配列

    戻り結果。

    fileSizeLong220

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

    nameStringdeploy_0.txt

    辞書ファイルの名前。

    sourceTypeStringOSS

    辞書ファイルのソースタイプ。有効な値：

    • OSS：OSS オープンストレージ。
    • ORIGIN：アップロードされた辞書を保持します。
    typeStringSYNONYMS

    辞書タイプ。 有効な値：SYNONYMS。

    例

    サンプルリクエスト

    PUT /openapi/instances/es-cn-nif1q9o8r0008****/synonymsDict HTTP/1.1
共通リクエストヘッダー
[
    {
        "name":"deploy_0.txt",
        "ossObject":{
            "bucketName":"search-cloud-test-cn-****",
            "key":"user_dict/dict_0.dic"
        },
        "sourceType":"OSS",
        "type":"SYNONYMS"
    },
    {
        "name":"SYSTEM_STOPWORD.txt",
        "sourceType":"ORIGIN",
        "type":"SYNONYMS"
    }
]

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

    JSON 形式

    {
    "Result": [

        {
            "name":"deploy_0.txt",
            "fileSize":220,
            "sourceType":"OSS",
            "type":"SYNONYMS"
        },
        {
            "name":"SYSTEM_MAIN.txt",
            "fileSize":2782602,
            "sourceType":"ORIGIN",
            "type":"SYNONYMS"
        },
        {
            "name":"SYSTEM_STOPWORD.txt",
            "fileSize":132,
            "sourceType":"ORIGIN",
            "type":"SYNONYMS"
        }
    ],
    "RequestId": "1F7FE662-CCD8-474F-BA9B-A7E0792E****"
}

    エラーコード

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