Partager via


Mettre à jour la carte de synonymes (API REST Recherche Azure AI)

Remplace une définition de carte de synonymes existante par une version révisée.

PUT https://[service name].search.windows.net/synonymmaps/[synonymmap name]?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin key]  

Paramètres URI

Paramètre Description
nom du service Obligatoire. Définissez cette valeur sur le nom unique défini par l’utilisateur de votre service de recherche.
nom de la carte de synonymes Obligatoire. L’URI de requête spécifie le nom du mappage de synonymes à mettre à jour.
api-version Obligatoire. La version stable actuelle est api-version=2020-06-30. Pour plus d’informations, consultez Versions de l’API .

En-têtes de requête

Le tableau suivant décrit les en-têtes de demande obligatoires et facultatifs.

Champs Description
Content-Type Obligatoire. À définir avec la valeur application/json
api-key Facultatif si vous utilisez des rôles Azure et qu’un jeton de porteur est fourni sur la demande, sinon une clé est requise. Une clé API est une chaîne unique générée par le système qui authentifie la demande auprès de votre service de recherche. Les demandes de mise à jour doivent inclure un api-key en-tête défini sur votre clé d’administration (par opposition à une clé de requête). Pour plus d’informations, consultez Se connecter à Azure AI Search à l’aide de l’authentification par clé .

Corps de la demande

La syntaxe du corps de la requête est la même que pour Créer un mappage de synonymes.

Lors de la mise à jour d’une carte de synonymes existante, la définition entière est remplacée par le contenu du corps de la demande. En général, le meilleur modèle à utiliser pour les mises à jour consiste à récupérer la définition avec un GET, à la modifier, puis à la mettre à jour avec PUT.

response

Pour une demande réussie, « 201 Créé » si une nouvelle carte de synonymes a été créée et « 204 Aucun contenu » si une carte de synonymes existante a été mise à jour

Par défaut, le corps de la réponse est vide. Toutefois, si l’en-tête Prefer de requête est défini sur return=representation, le corps de la réponse contiendra le JSON pour le mappage de synonymes qui a été mis à jour ou créé. Dans ce cas, la réussite status code sera « 201 Créé » si une nouvelle carte de synonymes a été créée et « 200 OK » si une carte de synonymes existante a été mise à jour.

Voir aussi