UpdateHotIkDicts - Elasticsearch - Centre de documentation Alibaba Cloud

Avant d'appeler cette opération, tenez compte des points suivants :

Si le fichier de dictionnaire est stocké dans un bucket Object Storage Service (OSS), assurez-vous que la liste de contrôle d'accès (ACL) du bucket est définie sur « lecture publique ».
Si vous ne définissez pas sourceType sur ORIGIN pour un fichier de dictionnaire téléchargé, ce dernier sera supprimé après l'appel de cette opération.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Par commodité, nous vous recommandons d'appeler cette opération via OpenAPI Explorer. Cet outil génère dynamiquement des exemples de code pour différents SDK.

En-têtes de requête

Cette opération utilise uniquement les en-têtes de requête communs. Pour plus d'informations, consultez la section « Paramètres de requête communs » de la rubrique Paramètres communs.

Syntaxe de la requête

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

Paramètres de requête

Paramètre	Type	Emplacement	Obligatoire	Exemple	Détails
InstanceId	String	Path	Oui	es-cn-oew1q8bev0002****	ID de l'instance.
clientToken	String	Query	Non	5A2CFF0E-5718-45B5-9D4D-70B3FF****	Jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez générer ce jeton via le client, mais vous devez veiller à ce qu'il soit unique pour chaque requête. Le jeton ne peut contenir que des caractères ASCII et sa longueur ne doit pas dépasser 64 caractères.
	String	Body	Non	Voir l'exemple dans RequestBody	RequestBody

RequestBody

Vous devez configurer les paramètres suivants dans le corps de la requête.

Champ	Type	Obligatoire	Exemple	Description
name	String	Oui	dic_0.dic	Nom du fichier de dictionnaire que vous souhaitez télécharger.
ossObject	Array	Oui		Informations relatives au fichier de dictionnaire. Ce paramètre est requis si vous définissez `sourceType` sur `OSS`.
└bucketName	String	Oui	search-cloud-test-cn-****	Nom du bucket OSS contenant le fichier de dictionnaire.
└key	String	Oui	oss/dic_0.dic	Chemin d'accès du fichier de dictionnaire dans le bucket OSS.
sourceType	String	Oui	OSS	Type de source du fichier de dictionnaire. Valeurs valides : `OSS` et `ORIGIN`. Remarques d'utilisation : Vous devez d'abord télécharger un fichier local vers OSS, puis référencer ce fichier via OSS. Si vous n'ajoutez pas `ORIGIN` au dictionnaire téléchargé, le système supprime ce dernier.
type	String	Oui	MAIN	Type des dictionnaires à mettre à jour. Valeurs valides : `MAIN` et `STOP`.

Le symbole └ indique un paramètre enfant.
Vous devez inclure tous les paramètres de l'API dans le paramètre RequestBody. Par exemple, lors de l'ajout de mots vides, tous les fichiers de dictionnaire du thésaurus par défaut ou installé doivent être écrits dans le RequestBody. Dans l'exemple ci-dessous, "sourceType":"ORIGIN" correspond au fichier de dictionnaire existant.

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

Paramètres de réponse

Paramètre	Type	Exemple	Détails
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****	ID de la requête.
Result	Array of DictList		Paramètres de réponse.
fileSize	Long	6	Taille du fichier de dictionnaire. Unité : octets.
sourceType	String	OSS	Type de source du fichier de dictionnaire. Valeurs valides : OSS ORIGIN
name	String	deploy_0.dic	Nom du fichier de dictionnaire.
type	String	MAIN	Type de dictionnaire. Valeurs valides : MAIN : dictionnaire principal IK STOP : liste des mots vides IK

Exemples

Exemple de requête

PUT /openapi/instances/es-cn-oew1q8bev0002****/ik-hot-dict HTTP/1.1
Common request parameters
[
    {
        "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"
    }
]

Exemple de réponse réussie

JSON format

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

Codes d'erreur courants

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur du service.