UpdateSynonymsDicts - Elasticsearch - Centre de documentation Alibaba Cloud

Tenez compte des points suivants lors de l'appel de cette interface :

Si le fichier de dictionnaire provient d'OSS, assurez-vous que le bucket OSS est accessible en lecture publique.
Si la configuration ORIGIN n'est pas ajoutée à un fichier de dictionnaire téléchargé, ce dernier est supprimé après l'exécution de cette opération.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

En-têtes de requête

Cette opération utilise uniquement les paramètres de requête communs et n'implique pas d'en-têtes de requête spéciaux. Pour plus d'informations, consultez la rubrique relative aux paramètres communs.

Syntaxe de la requête

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

Paramètres de requête

Paramètre

Type

Emplacement

Obligatoire

Exemple

Description

InstanceId

String

Path

Oui

es-cn-nif1q9o8r0008****

L'ID de l'instance.

clientToken

String

Query

Non

5A2CFF0E-5718-45B5-9D4D-70B3FF****

Ce paramètre permet de garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer la valeur, mais vous devez vous assurer qu'elle est unique parmi les différentes requêtes. Le jeton ne peut contenir que des caractères ASCII et ne doit pas dépasser 64 caractères.

RequestBody

Saisissez les paramètres suivants dans le corps de la requête (RequestBody).

Paramètre	Type	Obligatoire	Exemple	Description
name	String	Oui	dic_0.txt	Nom du fichier de dictionnaire téléchargé. Il doit s'agir d'un fichier TXT.
ossObject	Array	Non		Description du fichier de stockage ouvert sur OSS. Ce paramètre est obligatoire lorsque sourceType est défini sur OSS.
└bucketName	String	Non	search-cloud-test-cn-****	Nom du bucket OSS.
└key	String	Non	oss/dic_0.txt	Chemin de stockage du fichier de dictionnaire dans le bucket OSS.
sourceType	String	Oui	OSS	Type de source du fichier de dictionnaire. Valeurs valides : OSS (service de stockage ouvert utilisant OSS) et ORIGIN (conservation des dictionnaires précédemment téléchargés). Remarque : Le fichier local doit être téléchargé vers OSS, puis référencé via OSS. Si un dictionnaire téléchargé n'est pas configuré avec ORIGIN, il est supprimé par le système.
type	String	Oui	SYNONYMS	Type de dictionnaire à mettre à jour. La valeur est fixée à SYNONYMS.

Remarque

└ indique un paramètre enfant.

Exemples :

[
    {
        "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"
    }
]

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	7C5622CC-B312-426F-85AA-B0271*******	ID de la requête.
Result	Array of DictList		Résultats renvoyés.
fileSize	Long	220	Taille du fichier de dictionnaire. Unité : octet.
name	String	deploy_0.txt	Nom du fichier de dictionnaire.
sourceType	String	OSS	Type de source du fichier de dictionnaire. Valeurs valides : OSS : stockage ouvert OSS. ORIGIN : conserve les dictionnaires qui ont été téléchargés.
type	String	SYNONYMS	Type de dictionnaire. Valeurs valides : SYNONYMS.

Exemples

Exemples de requêtes

PUT /openapi/instances/es-cn-nif1q9o8r0008****/synonymsDict HTTP/1.1
common request header
[
    {
        "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"
    }
]

Exemples de réponses réussies

JSON format

{
    "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****"
}

Code d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs API.