Versions de l’API REST (Recherche Azure AI)
Cet article répertorie les versions actuelles et passées des API REST de recherche pour Recherche Azure AI Search.
Documentation de l’API avec version
Les documents de l’API REST sont désormais versionnés. Lorsque vous ouvrez une page de référence d’API, un sélecteur de version apparaît au-dessus de la table des matières. Assurez-vous que la référence de l’API provient du dossier
Versions stables
Version de l’API | Spécification | Mises à jour d’API |
---|---|---|
2024-07-01 (Dernière version) |
spécification Swagger | note de publication |
2023-11-01 |
spécification Swagger | note de publication |
2020-06-30 |
spécification Swagger | note de publication |
2019-05-06 |
spécification Swagger | Ajoute des types complexes. |
Préversion des versions
Les versions en préversion sont publiées pour tester de nouvelles fonctionnalités, recueillir des commentaires et détecter et résoudre les problèmes. Les API en préversion sont disponibles sous conditions d’utilisation supplémentaires pour les préversions Microsoft Azure.
Version de l’API | Spécification | Mises à jour d’API |
---|---|---|
2024-11-01-preview (Dernière version) |
spécification Swagger | note de publication |
2024-09-01-preview |
spécification Swagger | note de publication |
2024-05-01-preview |
spécification Swagger | note de publication |
2024-03-01-preview |
spécification Swagger | note de publication |
2023-10-01-preview |
spécification Swagger | note de publication |
2023-07-01-preview (déconseillé) |
spécification Swagger | note de publication |
2021-04-30-preview |
spécification Swagger | note de publication |
2020-06-30-preview |
spécification Swagger | note de publication |
2019-05-06-preview |
spécification Swagger | note de publication |
Notes de publication
2024-11-01-preview
Cette préversion s’appuie sur la 2024-09-01-preview
et inclut toutes les fonctionnalités actuellement en préversion. Vous pouvez effectuer une mise à niveau de 2024-09-01-preview
vers 2024-11-01-preview
avec des modifications de code minimales. Pour plus d’informations, consultez Mettre à niveau les API REST.
Mettre à jour | Applicable REST API |
---|---|
réécriture de requête dans le réécriture sémantique, utilisée pour affiner les requêtes envoyées au ranker L2. | Rechercher des documents, nouvelle propriété QueryRewritesType dans la requête. |
compétence Disposition de document utilisée pour analyser un document pour la structure. | Créer ou mettre à jour un ensemble de compétences, nouvelle compétence DocumentIntelligenceLayoutSkill. |
Identité managée pour attacher une ressource multiservice Azure AI. | Créer ou mettre à jour un ensemble de compétences, nouvelle propriété AIServicesAccountIdentity. |
mode d’analyse Markdown, utilisé pour l’indexation de fichiers Markdown dans Stockage Azure. | créer ou mettre à jour un indexeur, nouveau mode d’analyse markdown. |
options de rescoring pour les vecteurs compressés, utilisées pour rescoring avec des vecteurs d’origine au lieu de vecteurs compressés. S’applique à HNSW et aux algorithmes de vecteur KNN exhaustifs, à l’aide de la compression binaire et scalaire. |
créer ou mettre à jour und’index , de nouvelles propriétés rescoringOptions. Une nouvelle propriété enableRescoring est mappée à rerankWithOriginalVectors introduite en 2024-03-01-preview. |
2024-09-01-preview
Cette préversion s’appuie sur la 2024-05-01-preview
et inclut toutes les fonctionnalités actuellement en préversion. Vous pouvez effectuer une mise à niveau de 2024-05-01-preview
vers 2024-09-01-preview
sans aucune modification du code requise. Pour plus d’informations, consultez Mettre à niveau les API REST.
Mettre à jour | Applicable REST API |
---|---|
dimensions tronquées pour la quantisation MRL (Text-Embedding-3-small) et text-embedding-3-larges. | créer ou mettre à jour und’index , nouveau paramètre troncationDimension |
Sous-scores ou détails de scoring pour décompresser les résultats de recherche hybride marqués par fusion de classement réciproque (RRF). | Rechercher des documents, de nouveaux déboguer paramètres et des définitions de sous-score de requête dans la réponse. |
Filtrage cible sur la partie vectorielle d’une requête de recherche hybride . | Search Documents, nouveau paramètre de filterOverride dans RawVectorQuery, VectorizableTextQuery, VectorizableImageUrlQuery, VectorizableImageBinaryQuery. |
Segmentation des jetons dans compétence Fractionnement de texte, au lieu de caractères. | Créer ou mettre à jour un ensemble de compétences, un nouveau paramètre d’unité et d’autres propriétés liées aux jetons. |
2024-07-01
Cette version fournit des mises à jour généralement disponibles pour la vectorisation intégrée (compétences et vectoriseurs), la quantisation scalaire et la quantisation binaire. Pour plus d’informations, consultez Nouveautés d’Azure AI Search.
Mettre à jour | Applicable REST API |
---|---|
Disponibilité générale : types de données vectorielles | créer ou mettre à jour des d’index |
Généralement disponible : propriétés de quantisation vectorielle pour la quantisation scalaire ou binaire intégrée dans un index de recherche. | créer ou mettre à jour des d’index |
Généralement disponible : propriété stockée sur un champ vectoriel qui détermine si une copie supplémentaire du champ est stockée. La copie supplémentaire est le contenu récupérable de ce champ. Si vous ne le stockez pas, le champ est toujours utilisé dans les requêtes, mais ne peut pas être retourné dans un résultat de recherche. Vous pouvez définir cette propriété pour conserver de l’espace sur votre service de recherche ou quota de vecteurs dans un index de recherche. | créer ou mettre à jour des d’index |
Généralement disponible : paramètres VectorizableTextQuery pour le réglage de pertinence. Les paramètres de requête hybride (MaxTextSizeRecall) sont toujours en préversion. | rechercher des documents |
Généralement disponible - Compétence AzureOpenAIEmbedding pour prendre en charge plus de modèles que simplement l’incorporation de texte-ada-002 pour la vectorisation intégrée pendant l’indexation. Définissez les propriétés de nom et de dimensions du modèle pour cibler un modèle spécifique. | créer ou mettre à jour un ensemble de compétences |
En disponibilité générale : vectoriseur d’incorporation Azure OpenAI pour la vectorisation intégrée pendant les requêtes. Les propriétés vectoriseurs prennent en charge d’autres modèles. | créer ou mettre à jour des d’index |
À compter du 29 mars 2024 : les réponses GET ne retournent plus de chaînes de connexion ou de clés. Consultez changement cassant pour le code client qui lit les informations de connexion pour plus d’informations. | Toutes les versions |
2024-05-01-preview
Cette préversion ajoute la prise en charge de l’indexation OneLake, du réglage de la pertinence et de l’intégration plus approfondie avec des modèles d’incorporation supplémentaires lors de l’indexation et des requêtes. Il s’appuie sur la 2024-03-01-preview
et inclut toutes les fonctionnalités actuellement en préversion.
Pour effectuer une mise à niveau à partir de 2024-03-01-preview
ou de 2023-10-01-preview
, mettez à jour la compétence ou le vectoriseur AzureOpenAIEmbedding pour inclure le nom et les dimensions du modèle. Pour effectuer une mise à niveau à partir de 2023-07-01-preview
(déconseillé) ou pour obtenir des instructions pas à pas, consultez Mettre à niveau les API REST.
Voici les mises à jour de cette préversion. Nous vous recommandons également d'nouveautés d’Azure AI Search.
Mettre à jour | Applicable REST API |
---|---|
Source de données de l’indexeur pour les fichiers OneLake et les raccourcis. | créer ou mettre à jour des de source de données |
Collection(Edm.Byte) , type de données binaires pour l’incorporation de modèles qui les prennent en charge. Les définitions de champ vectoriel prennent en charge ce type de données. |
créer ou mettre à jour des d’index |
Paramètres de requête vectorielles et hybrides multiples pour le réglage de la pertinence. Définissez des seuils pour exclure les résultats de score faible. Requêtes vectorielles de poids. Pour les requêtes hybrides, définissez le nombre maximal de documents à récupérer dans la partie texte d’une requête hybride. | rechercher des documents |
Nouvelle compétence Azure AI Vision pour la vectorisation intégrée modale lors de l’indexation. Cette compétence appelle l’API modale d’Azure AI Vision. | créer ou mettre à jour un ensemble de compétences |
Nouveau vectoriseur Azure AI Vision pour les requêtes modales. Un vectoriseur est spécifié dans les définitions d’index, mais utilisé pendant l’exécution de la requête. | créer ou mettre à jour des d’index |
Mise à jour de la compétence AzureOpenAIEmbedding pour prendre en charge plus de modèles que simplement l’incorporation de texte-ada-002 pour la vectorisation intégrée pendant l’indexation. Définissez les propriétés de nom et de dimensions du modèle pour cibler un modèle spécifique. | créer ou mettre à jour un ensemble de compétences |
Mise à jour du vectoriseur d’incorporation Azure OpenAI pour la vectorisation intégrée pendant les requêtes. Les propriétés vectoriseurs prennent en charge d’autres modèles. | créer ou mettre à jour des d’index |
À compter du 29 mars 2024 : les réponses GET ne retournent plus de chaînes de connexion ou de clés. Consultez changement cassant pour le code client qui lit les informations de connexion pour plus d’informations. | Toutes les versions |
2024-03-01-preview
Cette préversion s’appuie sur 2023-10-01-preview
en ajoutant des API d’aperçu qui améliorent le stockage vectoriel. Pour plus d’informations, consultez Nouveautés d’Azure AI Search.
Mettre à jour | Applicable REST API |
---|---|
De nouveaux types de données étroits pour les champs vectoriels si vous avez incorporé des modèles qui les prennent en charge ou une logique de quantisation qui génère des vecteurs plus petits. | créer ou mettre à jour des d’index |
Nouvelles propriétés de quantisation de vecteurs pour la compression vectorielle intégrée dans un index de recherche. | créer ou mettre à jour des d’index |
Nouvelle propriété booléenne propriété stockée sur un champ vectoriel qui détermine si une copie supplémentaire du champ est stockée. La copie supplémentaire est le contenu récupérable de ce champ. Si vous ne le stockez pas, le champ est toujours utilisé dans les requêtes, mais ne peut pas être retourné dans un résultat de recherche. Vous pouvez définir cette propriété pour conserver de l’espace sur votre service de recherche ou quota de vecteurs dans un index de recherche. | créer ou mettre à jour des d’index |
À compter du 29 mars 2024 : les réponses GET ne retournent plus de chaînes de connexion ou de clés. Consultez changement cassant pour le code client qui lit les informations de connexion pour plus d’informations. | Toutes les versions |
2023-11-01
Cette version fournit des fonctionnalités en disponibilité générale. Pour plus d’informations, consultez Nouveautés d’Azure AI Search.
Mettre à jour | Applicable REST API |
---|---|
Classement sémantique dans les demandes de publication de recherche. | rechercher des documents |
Configuration de la recherche vectorielle pour l’indexation des champs vectoriels | créer ou mettre à jour des d’index |
Requêtes vectorielles dans les requêtes de publication de recherche. | rechercher des documents |
À compter du 29 mars 2024 : les réponses GET ne retournent plus de chaînes de connexion ou de clés. Consultez changement cassant pour le code client qui lit les informations de connexion pour plus d’informations. | Toutes les versions |
2023-10-01-preview
Cette version inclut toutes les fonctionnalités introduites dans les préversions précédentes, ainsi que les ajouts et modifications apportés aux API de recherche vectorielle. Les mises à jour apportées aux API de recherche vectorielle sont un changement cassant de 2023-07-01-Preview. Consultez Ajouter des champs vectoriels et Créer un de requête vectorielle pour obtenir de l’aide sur la migration.
Si vous envisagez d’utiliser la nouvelle fonctionnalité de préfiltrage, vous devez utiliser un index créé après 2023-10-01.
créer ou mettre à jour und’index :
vectorSearch
a des définitions pouralgorithms
,profiles
etvectorizers
:algorithms
continue de prendre en chargehnsw
et prend désormais également en chargeeknn
, en référence à l’HNSW (Hierarchical Navigable Small World) et aux voisins les plus proches de K (eKNN). Dans la section algorithme, vous pouvez définir plusieurs combinaisons nommées de paramètres HNSW et eKNN. Cela remplacealgorithmConfigurations
dans la propriétévectorSearch
en 2023-07-01-Preview.profiles
est une nouvelle définition qui spécifie la configuration de l’algorithme. Par exemple, supposons que vous ayez des configurations d’algorithmes nommées HNSW-1, HSNW-2, eKNN-1. Un profil peut spécifier HNSW-1.vectorizers
est défini dans un index, mais utilisé au moment de la requête pour incorporer une chaîne de requête de texte. Un vectoriseur fait référence à un modèle d’incorporation. Le service de recherche effectue un appel au modèle d’incorporation pour vectoriser la chaîne de requête de texte, puis transmet le résultat au moteur de recherche pour une requête vectorielle.
Sur les champs vectoriels,
vectorSearchProfile
remplacevectorSearchConfiguration
. La propriétévectorSearchProfile
spécifie le profil de recherche vectorielle à utiliser sur le champ.Sur les index créés avant cette version de l’API, lors de l’appel de l’API 2023-10-01-Preview, dans votre demande, vous devez modifier le champ pour spécifier une
vectorSearchProfile
tant que le profil spécifie exactement le même algorithme précédemment spécifié dansvectorSearchConfiguration
. Par exemple, si la définition de champ existante spécifie"vectorSearchConfiguration": "myHnsw"
, vous devez la remplacer par"vectorSearchProfile": "your profile name"
et que le profil doit être défini pour référencer la même"algorithm": "myHnsw"
.
-
vectorQueries
remplacevectors
en 2023-07-01-Preview -
vectorQueries.vectors
remplacevectors.values
en 2023-07-01-Preview. - La requête vectorielle est désormais une structure polymorphe.
kind
devez être spécifié pour indiquer le type de requête vectorielle demandée."kind": "vector"
signifie que la requête est un vecteur. L’appelant doit donc déjà vectoriser la chaîne de requête de recherche dans un vecteur incorporé. -
"exhaustive": "true"
est une nouvelle propriété spécifie s’il faut effectuer une recherche exhaustive (brute-force) k-near voisin sur tous les vecteurs de l’index vectoriel. -
vectorFilterMode
est un nouveau paramètre pour spécifier le préfiltrage (valeur par défaut pour les index créés après 2023-10-01) ou le post-filtrage (par défaut sur les index précédents) dans la requête.
À compter du 29 mars 2024 : les réponses GET ne retournent plus de chaînes de connexion ou de clés. Consultez changement cassant pour le code client qui lit les informations de connexion pour plus d’informations.
2023-07-01-preview
Important
N’utilisez pas cette version de l’API. La dépréciation de cette préversion a été annoncée le 15 avril 2024 et n’est plus prise en charge après le 8 juillet 2024. Pour obtenir de l’aide sur la migration, consultez Mettre à niveau les API REST dans azure AI Search.
Cette version a introduit la prise en charge des vecteurs et utilise une configuration vectorielle incompatible avec les versions d’API plus récentes.
- Ajout d’un type de données
Collection(Edm.Single)
sur les champs qui contiennent un tableau de nombres à virgule flottante simple précision. Il s’agit du type de données pour les vecteurs, utilisé pour stocker un incorporation généré par champ de document. L’index de recherche spécifie également les propriétés de configuration vectorielle. Consultez créer ou mettre à jour des d’index pour ces API. - Mise à jour des charges de travail d’indexation pour accepter les données vectorielles. Consultez ajouter, mettre à jour ou supprimer des documents.
- Ajout de paramètres de requête pour la recherche vectorielle. Consultez recherche de documents pour ces paramètres.
- Obtenir des statistiques de service: retourne le quota et l’utilisation de l’index vectoriel pour le service.
- Obtenir des statistiques d’index: retourne le quota d’index vectoriel et l’utilisation de l’index de recherche.
- À compter du 29 mars 2024 : les réponses GET ne retournent plus de chaînes de connexion ou de clés. Consultez changement cassant pour le code client qui lit les informations de connexion pour plus d’informations.
2021-04-30-preview
Cette préversion inclut toutes les fonctionnalités introduites en 2020-06-30-Preview, ainsi que les ajouts aux API suivantes :
- 'alias d’index ajoute un nom secondaire utilisé pour référencer les index dans les requêtes et les requêtes d’indexation. Les opérations d’alias incluent la création, la mise à jour, la suppression, l’obtention et la liste.
- identités managées pour les connexions sortantes. De nouvelles valeurs pour les chaînes de connexion dans Créer ou mettre à jour la source de données prennent en charge les connexions à l’aide de l’authentification et des rôles Microsoft Entra ID au lieu d’informations d’identification ou de clés de base de données codées en dur.
- La prise en charge des identités managées est également prise en charge pour les connexions key vault, pour les solutions de recherche qui complètent le chiffrement par défaut avec chiffrement géré par le client.
- Plus de langues pour la compétence cognitive traduction de texte.
- Autres requêtesLanguages pour la recherche sémantique et l’orthographe dans Recherche de documents (préversion).
- Paramètre de sous-titres pour demander éventuellement des légendes de la recherche sémantique dans recherche de documents (préversion).
- configurations sémantiques sont spécifiées dans Créer ou mettre à jour un index. Une configuration sémantique détermine les champs à utiliser pour le classement sémantique, les légendes, les mises en surbrillance et les réponses.
- Paramètre semanticConfiguration requis pour les requêtes sémantiques dans Recherche de documents (préversion).
- À compter du 29 mars 2024 : les réponses GET ne retournent plus de chaînes de connexion ou de clés. Consultez changement cassant pour le code client qui lit les informations de connexion pour plus d’informations.
2020-06-30
Cette version fournit des fonctionnalités généralement disponibles, notamment :
- Contrôle d’accès en fonction du rôle Azure pour les opérations de plan de données
- Score de pertinence (BM25)
- Magasins de connaissances
- Source de données de l’indexeur pour Azure Data Lake Storage (ADLS) Gen2
- Compétence de recherche d’entité personnalisée
- Indexeurs s’exécutant sous une identité système ou gérée par l’utilisateur via l’ID Microsoft Entra
- À compter du 29 mars 2024 : les réponses GET ne retournent plus de chaînes de connexion ou de clés. Consultez changement cassant pour le code client qui lit les informations de connexion pour plus d’informations.
2020-06-30-preview
Cette préversion inclut toutes les fonctionnalités introduites en 2019-05-06-Preview, ainsi que les ajouts suivants :
- Recherche sémantique, fonctionnalité Premium qui s’exécute sur les services de niveau Standard et qui appelle le classement sémantique.
- Source de données de l’indexeur pour les connecteurs Power Query
- Source de données de l’indexeur pour MySQL
- Source de données de l’indexeur pour l’API Gremlin Cosmos DB
- Source de données de l’indexeur pour SharePoint Online
- Propriété normaliseur pour la normalisation du texte, pour le filtrage sans respect de la casse, la facette et le tri
- Réinitialiser les documents pour l’indexation basée sur l’indexeur afin d’actualiser spécifiquement des documents spécifiques par ID
- Compétence cognitive de liaison d’entités (v3)
- Compétence cognitive De reconnaissance d’entité (v3)
- Compétence cognitive Analyse des sentiments (v3)
- À compter du 29 mars 2024 : les réponses GET ne retournent plus de chaînes de connexion ou de clés. Consultez changement cassant pour le code client qui lit les informations de connexion pour plus d’informations.
2019-05-06-preview
- Prise en charge des sources de données de l’indexeur pour l’API MongoDB Cosmos DB
- Source de données de l’indexeur pour la suppression réversible dans le stockage Blob
- paramètre featuresMode qui retourne des informations détaillées sur un score de pertinence
- Compétence cognitive Azure Machine Learning (AML)
- Compétence cognitive de détection d’identification personnelle
- Mettre en cache des documents enrichis pour préserver et réutiliser le traitement des images (et d’autres enrichissements par IA)
- À compter du 29 mars 2024 : les réponses GET ne retournent plus de chaînes de connexion ou de clés. Consultez changement cassant pour le code client qui lit les informations de connexion pour plus d’informations.