Créer une carte de synonymes (API REST Azure AI Search)

Dans Recherche Azure AI, une carte de synonymes contient une liste de règles permettant d’étendre ou de réécrire une requête de recherche en termes équivalents.

Vous pouvez utiliser POST ou PUT sur la demande. Pour l’une ou l’autre, le document JSON dans le corps de la demande fournit la définition de l’objet.

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

Vous pouvez également utiliser une requête PUT en spécifiant le nom de la carte de synonymes sur l'URI.

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

Le protocole HTTPS est requis pour toutes les requêtes de service. Si la carte de synonymes n’existe pas, elle est créée. S’il existe déjà, il est mis à jour vers la nouvelle définition.

Paramètres URI

En-têtes de requête

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

Corps de la demande

Le corps de la demande contient une définition de carte de synonymes, qui inclut le format de la carte de synonymes et la liste des règles dans le format spécifié.

Le code JSON suivant est une représentation de haut niveau des parties main de la définition.

{   
    "name" : (optional on PUT; required on POST) "Name of the synonym map",  
    "format" : (required) "Only Apache Solr format ('solr') is currently supported.",
    "synonyms" : (required) "Synonym rules separated by the new line ('\n') character.",
    "encryptionKey":(optional) { See below for details } 
}  

La requête peut contenir les propriétés suivantes :

response

Pour une requête réussie : « 201 Créé ».

Exemples

Exemple : Liste de synonymes avec des mappages équivalents et explicites.

Une règle de mappage équivalente répertorie les termes ou expressions équivalents séparés par des virgules (« USA, États-Unis, États-Unis of America »). La règle étend la recherche à tous les termes ou expressions équivalents. Par exemple, un document de recherche qui contient USA correspond aux requêtes qui contiennent le terme USA ou les expressions "United States", ou "United States of America".

Le mappage explicite est indiqué par une flèche => (« USA, U.S.A., U.S.S., États-Unis, États-Unis of America => USA »). Quand elle est spécifiée, une séquence de termes d’une requête de recherche qui correspond au côté gauche de => sera remplacée par les alternatives situées à droite. Étant donné la règle, les requêtes U.S. de recherche ou "United States" seront toutes réécrites en USA. Le mappage explicite s’applique uniquement dans le sens spécifié et ne réécrit pas la requête USA"United States" dans ce cas. Notez que « États-Unis » est une requête d’expressions entre guillemets. Si vous souhaitez une correspondance sur l’ensemble de l’expression, la chaîne de requête doit être placée entre guillemets doubles. Sinon, chaque terme« United » et « States » est évalué séparément.

{   
  "name" : "synonymmap1",  
  "format" : "solr",  
  "synonyms" : "United States, United States of America, USA\n
  Washington, Wash. => WA"
}  

Exemple : clés de chiffrement

Les clés de chiffrement sont des clés gérées par le client utilisées pour un chiffrement supplémentaire. Pour plus d’informations, consultez Chiffrement à l’aide de clés gérées par le client dans Azure Key Vault.

{   
  "name" : "synonymmap1",  
  "format" : "solr",  
  "synonyms" : "United States, United States of America, USA\n
  Washington, Wash. => WA",
  "encryptionKey": (optional) { 
      "keyVaultKeyName": "Name of the Azure Key Vault key used for encryption",
      "keyVaultKeyVersion": "Version of the Azure Key Vault key",
      "keyVaultUri": "URI of Azure Key Vault, also referred to as DNS name, that provides the key. An example URI might be https://my-keyvault-name.vault.azure.net",
      "accessCredentials": (optional, only if not using managed system identity) {
          "applicationId": "Azure AD Application ID that was granted access permissions to your specified Azure Key Vault",
          "applicationSecret": "Authentication key of the specified Azure AD application)"
      }
  }
}  

Voir aussi

• Exemple de code C#
• Tutoriel synonyme C# pour en savoir plus sur les synonymes.
• Synonymes dans Recherche Azure AI