Partager via

Créer ou mettre à jour un alias (API REST en préversion)

  • Article

s’applique à: 2023-07-01-Preview. Cette version n’est plus prise en charge. mettre à niveau immédiatement vers une version plus récente.

Important

2023-07-01-Preview (aucune modification).

2021-04-30-Preview ajoute l’API.

Dans Recherche IA Azure, un alias est un nom secondaire qui peut être utilisé pour faire référence à un index pour l’interrogation, l’indexation et d’autres opérations.

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

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

Pour les demandes de mise à jour, utilisez PUT et spécifiez le nom de l’alias sur l’URI.

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

HTTPS est requis pour toutes les demandes de service. Dans le cas de PUT, si l’alias n’existe pas, il est créé. S’il existe déjà, il est mis à jour vers la nouvelle définition.

Création d’un alias établit un mappage entre un nom d’alias et un nom d’index. Si la requête réussit, l’alias peut être utilisé pour l’indexation, l’interrogation et d’autres opérations.

Mise à jour d’un alias vous permet de mapper cet alias à un autre index de recherche. Lorsque vous mettez à jour un alias existant, la définition entière est remplacée par le contenu du corps de la requête. En général, le meilleur modèle à utiliser pour les mises à jour consiste à récupérer la définition d’alias avec un GET, à le modifier, puis à le mettre à jour avec PUT.

Note

Une mise à jour d’un alias peut prendre jusqu’à 10 secondes pour se propager via le système. Vous devez donc attendre au moins 10 secondes avant de supprimer l’index auquel l’alias a été précédemment mappé.

Note

Le nombre maximal d’alias que vous pouvez créer varie selon le niveau tarifaire. Pour plus d’informations, consultez Limites du service.

Paramètres d’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 l’alias Obligatoire sur l’URI si vous utilisez PUT. Le nom doit être en minuscules, commencer par une lettre ou un nombre, n’avoir aucune barre oblique ni point, et être inférieur à 128 caractères. Une fois que vous avez commencé le nom avec une lettre ou un nombre, le reste du nom peut inclure n’importe quelle lettre, nombre et tirets, tant que les tirets ne sont pas consécutifs.
api-version Obligatoire. Consultez versions de l’API pour plus de versions.

En-têtes de requête

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

Champs Description
Type de contenu Obligatoire. Définissez cette valeur sur application/json
api-key Facultatif si vous utilisez rôles Azure et qu’un jeton du 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 requête auprès de votre service de recherche. Les demandes de création doivent inclure un en-tête api-key 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

Le corps de la requête contient une définition d’alias, qui inclut le nom d’un alias et un tableau avec le nom d’un seul index.

Le code JSON suivant est une représentation générale des parties principales de la définition.

{   
    "name" : (optional on PUT; required on POST) "The name of the alias",  
    "indexes" : (required) ["The name of the index the alias is mapped to"]
}

La requête contient les propriétés suivantes :

Propriété Description
nom Obligatoire. Nom de l’alias. Un nom d’alias ne doit contenir que des lettres minuscules, des chiffres ou des tirets, ne peut pas commencer ou se terminer par des tirets et est limité à 128 caractères.
Index Obligatoire. Nom de l’index auquel l’alias est mappé. Un seul nom d’index peut être inclus dans le tableau.

Réponse

Pour une demande de création réussie, vous devez voir le code d’état « 201 Créé ».

Pour une demande de mise à jour réussie, vous devez voir « 204 Aucun contenu ».

Exemples

exemple : alias d’index

{   
  "name" : "my-alias",  
  "indexes" : ["my-index"]
}

Voir aussi