Créer un alias d’index dans Recherche Azure AI

Important

Les alias d’index sont disponibles en préversion publique et dans le cadre de conditions d’utilisation supplémentaires.

Dans Recherche Azure AI, un alias d’index est un nom secondaire qui peut être utilisé pour faire référence à un index à des fins d’interrogation, d’indexation et d’autres opérations. Vous pouvez créer un alias mappé à un index de recherche et substituer le nom de l’alias là où vous référenceriez un nom d’index. Un alias ajoute une flexibilité si vous devez changer l’index vers lequel pointe votre application. Au lieu de mettre à jour les références dans votre application, vous pouvez simplement mettre à jour le mappage de votre alias.

L’objectif principal des alias d’index est de faciliter la gestion de vos index de production. Par exemple, si vous devez apporter une modification à votre définition d’index, telle que la modification d’un champ ou l’ajout d’un nouvel analyseur, vous devez créer un index de recherche, car tous les index de recherche sont immuables. Cela signifie que vous devez supprimer et reconstruire votre index ou créer un index, puis migrer votre application vers cet index.

Au lieu de supprimer et de reconstruire votre index, vous pouvez utiliser des alias d’index. Un workflow classique consiste à :

1. Créer votre index de recherche
2. Créer un alias mappé à votre index de recherche
3. Faire en sorte que votre application envoie les demandes d’interrogation/d’indexation à l’alias plutôt qu’au nom de l’index
4. Si vous devez apporter une modification à votre index qui nécessite une régénération, créer un index de recherche
5. Quand votre nouvel index est prêt, mettre à jour l’alias pour le mapper au nouvel index afin que les demandes soient automatiquement routées vers le nouvel index

Créer un alias d’index

Vous pouvez créer un alias avec l’API REST en préversion, les SDK en préversion ou par le biais du Portail Azure. Un alias se compose du name de l’alias et du nom de l’index de recherche auquel l’alias est mappé. Un seul nom d’index peut être spécifié dans le tableau indexes.

REST API

Vous pouvez utiliser Créer ou mettre à jour un alias (REST en préversion) pour créer un alias d’index.

POST /aliases?api-version=2024-05-01-preview
{
    "name": "my-alias",
    "indexes": ["hotel-samples-index"]
}

Azure portal

Suivez les étapes ci-dessous pour créer un alias d’index dans le portail Azure.

1. Accédez à votre service de recherche dans le portail Azure.
2. Recherchez et sélectionnez Alias.
3. Sélectionnez + Ajouter un alias.
4. Donnez un nom à votre alias d’index et sélectionnez l’index de recherche auquel vous souhaitez mapper l’alias. Ensuite, cliquez sur Enregistrer.

Kit de développement logiciel (SDK) .NET

À l’aide de l’un des packages bêta du kit de développement logiciel (SDK) Azure pour .NET, vous pouvez utiliser la syntaxe suivante pour créer un alias d’index.

// Create a SearchIndexClient
SearchIndexClient adminClient = new SearchIndexClient(serviceEndpoint, credential);

// Create an index alias
SearchAlias myAlias = new SearchAlias("my-alias", "hotel-quickstart-index");
adminClient.CreateAlias(myAlias);

Les alias d’index sont également pris en charge dans les derniers kits SDK en préversion pour Java, Python et JavaScript.

Envoyer des requêtes à un alias d’index

Une fois votre alias créé, vous pouvez commencer à l’utiliser. Les alias peuvent être utilisés pour toutes les opérations de document, y compris l’interrogation, l’indexation, les suggestions et l’autocomplétion.

Dans la requête ci-dessous, au lieu d’envoyer la demande à hotel-samples-index, vous pouvez l’envoyer à my-alias et elle sera routée en conséquence.

POST /indexes/my-alias/docs/search?api-version=2024-05-01-preview
{
    "search": "pool spa +airport",
    "searchMode": any,
    "queryType": "simple",
    "select": "HotelId, HotelName, Category, Description",
    "count": true
}

Si vous prévoyez d’effectuer des mises à jour d’un index de production, spécifiez un alias plutôt que le nom de l’index dans votre application côté client. Les scénarios nécessitant une reconstruction d’index sont décrits dans Supprimer et regénérer un index.

Remarque

Vous pouvez utiliser un alias uniquement avec des opérations de document ou pour obtenir et mettre à jour une définition d’index. Les alias ne peuvent pas être utilisés pour supprimer un index, ne peuvent pas être utilisés avec l’API d’analyse de texte et ne peuvent pas être utilisés en tant que targetIndexName sur un indexeur.

La propagation d’une mise à jour d’un alias à travers le système peut prendre jusqu’à dix secondes. Vous devez donc attendre au moins dix secondes avant d’effectuer une opération dans l’index qui a été mappé ou qui étaient récemment mappé à l’alias.

Permuter les index

À présent, pour mettre à jour votre application afin qu’elle pointe vers un nouvel index, il vous suffit de mettre à jour le mappage dans votre alias. PUT est requis pour les mises à jour, comme décrit dans Créer ou mettre à jour un alias (REST en préversion).

PUT /aliases/my-alias?api-version=2024-05-01-preview
{
    "name": "my-alias",
    "indexes": ["hotel-samples-index2"]
}

Une fois la mise à jour de l’alias effectuée, les demandes commencent automatiquement à être routées vers le nouvel index.

Remarque

La propagation d’une mise à jour d’alias dans le système peut prendre jusqu’à 10 secondes. Vous devez donc attendre au moins 10 secondes avant de supprimer l’index auquel l’alias était mappé.

Voir aussi

• Supprimer et regénérer un index dans Recherche Azure AI