REST API-versies (Azure AI Search)
Dit artikel bevat de huidige en eerdere versies van de Search REST API's voor Azure AI Search.
Api-documenten met versiebeheer
REST API-documenten zijn nu geversied. Wanneer u een API-referentiepagina opent, wordt boven de inhoudsopgave een versiekiezer weergegeven. Zorg ervoor dat de API-verwijzing afkomstig is uit de map Reference>Data Plane.
Stabiele versies
| API-versie | Specificatie | API-updates |
|---|---|---|
2024-07-01 (nieuwste versie) |
Swagger-specificatie | releasenotitie |
2023-11-01 |
Swagger-specificatie | releasenotitie |
2020-06-30 |
Swagger-specificatie | releasenotitie |
2019-05-06 |
Swagger-specificatie | Hiermee worden complexe typen toegevoegd. |
Preview-versies
Preview-versies worden uitgebracht om nieuwe functionaliteit te testen, feedback te verzamelen en problemen op te sporen en op te lossen. Preview-API's zijn beschikbaar onder Aanvullende gebruiksvoorwaarden voor Microsoft Azure Previews.
| API-versie | Specificatie | API-updates |
|---|---|---|
2024-05-01-preview (nieuwste versie) |
Swagger-specificatie | releasenotitie |
2024-03-01-preview |
Swagger-specificatie | releasenotitie |
2023-10-01-preview |
Swagger-specificatie | releasenotitie |
2023-07-01-preview (afgeschaft) |
Swagger-specificatie | releasenotitie |
2021-04-30-preview |
Swagger-specificatie | releasenotitie |
2020-06-30-preview |
Swagger-specificatie | releasenotitie |
2019-05-06-preview |
Swagger-specificatie | releasenotitie |
Opmerkingen bij de release
2024-07-01
Deze versie biedt algemeen beschikbare updates voor geïntegreerde vectorisatie (vaardigheden en vectorizers), scalaire kwantisatie en binaire kwantisatie. Zie Wat is er nieuw in Azure AI Search voor meer informatie.
| Update | Toepasselijke REST API |
|---|---|
| Algemeen beschikbaar - vectorgegevenstypen | index maken of bijwerken |
| Algemeen beschikbaar: vector kwantisatie-eigenschappen voor ingebouwde scalaire of binaire kwantisatie in een zoekindex. | index maken of bijwerken |
| Algemeen beschikbaar: opgeslagen eigenschap op een vectorveld die bepaalt of er een extra kopie van het veld wordt opgeslagen. De extra kopie is de ophaalbare inhoud van dat veld. Als u het niet opslaat, wordt het veld nog steeds gebruikt in query's, maar kan het niet worden geretourneerd in een zoekresultaat. U kunt deze eigenschap instellen om ruimte te besparen op uw zoekservice of vectorquotum in een zoekindex. | index maken of bijwerken |
| Algemeen beschikbaar: VectorizableTextQuery parameters voor het afstemmen van relevantie. Hybride queryparameters (MaxTextSizeRecall) zijn nog in preview. | documenten zoeken |
| Algemeen beschikbaar: AzureOpenAIEmbedding-vaardigheid om meer modellen te ondersteunen dan alleen tekst-embedding-ada-002 voor geïntegreerde vectorisatie tijdens het indexeren. Stel de eigenschappen van de modelnaam en dimensies in op een specifiek model. | vaardighedenset maken of bijwerken |
| Algemeen beschikbaar: Azure OpenAI embedding vectorizer voor geïntegreerde vectorisatie tijdens query's. Vectorizer-eigenschappen ondersteunen meer modellen. | index maken of bijwerken |
| Vanaf 29 maart 2024: GET-antwoorden retourneren geen verbindingsreeksen of sleutels meer. Zie Belangrijke wijziging voor clientcode die verbindingsgegevens leest voor meer informatie. | Alle versies |
2024-05-01-preview
In deze preview wordt ondersteuning toegevoegd voor OneLake-indexering, relevantieafstemming en diepere integratie met meer insluitingsmodellen tijdens het indexeren en uitvoeren van query's. Het bouwt voort op de 2024-03-01-preview, dus het heeft ook de scalaire kwantisatie, smalle gegevenstypen en opslagopties die in die versie zijn geïntroduceerd.
Als u een upgrade wilt uitvoeren van 2024-03-01-preview of 2023-10-01-preview, werkt u de vaardigheid of vectorizer van AzureOpenAIEmbedding bij om de modelnaam en dimensies op te nemen. Als u een upgrade wilt uitvoeren van 2023-07-01-preview (afgeschaft) of voor stapsgewijze instructies, raadpleegt u REST API's upgraden.
Dit zijn de updates in deze preview. U wordt ook aangeraden wat er nieuw is in Azure AI Search.
| Update | Toepasselijke REST API |
|---|---|
| Indexeerfunctiegegevensbron voor OneLake-bestanden en snelkoppelingen. | gegevensbron maken of bijwerken |
Collection(Edm.Byte), een binair gegevenstype voor het insluiten van modellen die deze ondersteunen. Vectorvelddefinities ondersteunen dit gegevenstype. |
index maken of bijwerken |
| Meerdere vector- en hybride queryparameters voor het afstemmen van relevantie. Stel drempelwaarden in om lage scoreresultaten uit te sluiten. Gewichtsvectorquery's. Voor hybride query's stelt u het maximum aantal documenten in dat moet worden opgehaald in het tekstgedeelte van een hybride query. | documenten zoeken |
| Nieuwe Azure AI Vision-vaardigheid voor multimodale geïntegreerde vectorisatie tijdens het indexeren. Deze vaardigheid roept de multimodale API van Azure AI Vision aan. | vaardighedenset maken of bijwerken |
| Nieuwe Azure AI Vision-vectorizer voor multimodale query's. Een vectorizer wordt opgegeven in indexdefinities, maar wordt gebruikt tijdens het uitvoeren van query's. | index maken of bijwerken |
| AzureOpenAIEmbedding-vaardigheid bijgewerkt om meer modellen te ondersteunen dan alleen tekst-embedding-ada-002 voor geïntegreerde vectorisatie tijdens het indexeren. Stel de eigenschappen van de modelnaam en dimensies in op een specifiek model. | vaardighedenset maken of bijwerken |
| Azure OpenAI embedding vectorizer bijgewerkt voor geïntegreerde vectorisatie tijdens query's. Vectorizer-eigenschappen ondersteunen meer modellen. | index maken of bijwerken |
| Vanaf 29 maart 2024: GET-antwoorden retourneren geen verbindingsreeksen of sleutels meer. Zie Belangrijke wijziging voor clientcode die verbindingsgegevens leest voor meer informatie. | Alle versies |
2024-03-01-preview
Deze preview-versie is gebaseerd op 2023-10-01-preview door preview-API's toe te voegen die vectoropslag verbeteren. Zie Wat is er nieuw in Azure AI Search voor meer informatie.
| Update | Toepasselijke REST API |
|---|---|
| Nieuwe smalle gegevenstypen voor vectorvelden als u modellen hebt ingesloten die deze ondersteunen of kwantisatielogica die kleinere vectoren uitvoert. | index maken of bijwerken |
| Nieuwe vector kwantisatie-eigenschappen voor ingebouwde vectorcompressie in een zoekindex. | index maken of bijwerken |
| Nieuwe booleaanse opgeslagen eigenschap op een vectorveld die bepaalt of een extra kopie van het veld wordt opgeslagen. De extra kopie is de ophaalbare inhoud van dat veld. Als u het niet opslaat, wordt het veld nog steeds gebruikt in query's, maar kan het niet worden geretourneerd in een zoekresultaat. U kunt deze eigenschap instellen om ruimte te besparen op uw zoekservice of vectorquotum in een zoekindex. | index maken of bijwerken |
| Vanaf 29 maart 2024: GET-antwoorden retourneren geen verbindingsreeksen of sleutels meer. Zie Belangrijke wijziging voor clientcode die verbindingsgegevens leest voor meer informatie. | Alle versies |
2023-11-01
Deze versie biedt algemeen beschikbare functies. Zie Wat is er nieuw in Azure AI Search voor meer informatie.
| Update | Toepasselijke REST API |
|---|---|
| Semantische rangschikking in Search Post-aanvragen. | documenten zoeken |
| Vectorzoekconfiguratie voor indexeringsvectorvelden | index maken of bijwerken |
| Vectorquery's in Search Post-aanvragen. | documenten zoeken |
| Vanaf 29 maart 2024: GET-antwoorden retourneren geen verbindingsreeksen of sleutels meer. Zie Belangrijke wijziging voor clientcode die verbindingsgegevens leest voor meer informatie. | Alle versies |
2023-10-01-preview
Deze versie bevat alle functies die zijn geïntroduceerd in eerdere previews, plus toevoegingen en wijzigingen aan vectorzoek-API's. Updates voor de vectorzoekopdrachten-API's zijn een belangrijke wijziging van 2023-07-01-Preview. Zie Vectorvelden toevoegen en Een vectorquery maken voor hulp bij migratie.
Als u van plan bent om de nieuwe functie voor voorfiltering te gebruiken, moet u een index gebruiken die is gemaakt na 2023-10-01.
vectorSearchheeft definities vooralgorithms,profilesenvectorizers:algorithmsblijfthnswondersteunen en ondersteunt nu ookeknn, in verwijzing naar Hierarchical Navigable Small World (HNSW) en uitgebreide K-dichtstbijzijnde buren (eKNN). In de sectie algoritme kunt u meerdere benoemde combinaties van HNSW- en eKNN-parameters definiëren. Dit vervangtalgorithmConfigurationsin de eigenschapvectorSearchin 2023-07-01-Preview.profilesis een nieuwe definitie waarmee de algoritmeconfiguratie wordt opgegeven. Stel dat u algoritmeconfiguraties hebt met de naam HNSW-1, HSNW-2, eKNN-1. Een profiel kan HNSW-1 opgeven.vectorizersis gedefinieerd in een index, maar wordt gebruikt tijdens het uitvoeren van query's om een tekenreeks voor tekstquery's in te sluiten. Een vectorizer verwijst naar een insluitmodel. De zoekservice roept het insluitmodel aan om de tekenreeks voor tekstquery's te vectoriseren en geeft vervolgens het resultaat door aan de zoekmachine voor een vectorquery.
In vectorvelden vervangt
vectorSearchProfilevectorSearchConfiguration. De eigenschapvectorSearchProfilegeeft aan welk vectorzoekprofiel voor het veld moet worden gebruikt.Bij indexen die vóór deze API-versie zijn gemaakt, moet u bij het aanroepen van 2023-10-01-Preview-API in uw aanvraag het veld wijzigen om een
vectorSearchProfileop te geven zolang het profiel exact hetzelfde algoritme opgeeft dat eerder invectorSearchConfigurationis opgegeven. Als de bestaande velddefinitie bijvoorbeeld"vectorSearchConfiguration": "myHnsw"opgeeft, moet u deze vervangen door"vectorSearchProfile": "your profile name"en moet het profiel worden gedefinieerd om naar dezelfde"algorithm": "myHnsw"te verwijzen.
-
vectorQueriesvervangtvectorsin 2023-07-01-Preview -
vectorQueries.vectorsvervangtvectors.valuesin 2023-07-01-Preview. - De vectorquery is nu een polymorfe structuur.
kindmoet worden opgegeven om het type vectorquery aan te geven dat wordt aangevraagd."kind": "vector"betekent dat de query een vector is, dus de aanroeper moet de tekenreeks van de zoekquery al hebben gevectoriseerd in een vector insluiten. -
"exhaustive": "true"is een nieuwe eigenschap die aangeeft of er een uitgebreide (brute-force) k-dichtstbijzijnde burenzoekactie moet worden uitgevoerd op alle vectoren binnen de vectorindex. -
vectorFilterModeis een nieuwe parameter voor het opgeven van voorfiltering (standaard voor indexen die zijn gemaakt na 2023-10-01) of postfiltering (standaard voor eerdere indexen) in de query.
Vanaf 29 maart 2024: GET-antwoorden retourneren geen verbindingsreeksen of sleutels meer. Zie Belangrijke wijziging voor clientcode die verbindingsgegevens leest voor meer informatie.
2023-07-01-preview
Belangrijk
gebruik deze API-versie niet. Afschaffing van deze preview-versie is aangekondigd op 15 april 2024 en wordt na 8 juli 2024 niet meer ondersteund. Zie REST API's upgraden in Azure AI Searchvoor hulp bij migratie.
In deze versie is vectorondersteuning geïntroduceerd en wordt een vectorconfiguratie gebruikt die niet compatibel is met nieuwere API-versies.
- Er is een
Collection(Edm.Single)gegevenstype toegevoegd voor velden die een matrix met drijvendekommanummers met één precisie bevatten. Dit is het gegevenstype voor vectoren, dat wordt gebruikt voor het opslaan van één gegenereerde insluiting per documentveld. De zoekindex geeft ook vectorconfiguratie-eigenschappen op. Zie Index maken of bijwerken voor deze API's. - Bijgewerkte indexeringsworkloads om vectorgegevens te accepteren. Zie Documenten toevoegen, bijwerken of verwijderen.
- Queryparameters toegevoegd voor vectorzoekopdrachten. Zie documenten zoeken voor deze parameters.
- Servicestatistieken ophalen: retourneert het quotum en het gebruik van vectorindexen voor de service.
- Indexstatistieken ophalen: retourneert het quotum voor vectorindexen en het gebruik voor de zoekindex.
- Vanaf 29 maart 2024: GET-antwoorden retourneren geen verbindingsreeksen of sleutels meer. Zie Belangrijke wijziging voor clientcode die verbindingsgegevens leest voor meer informatie.
2021-04-30-preview
Deze preview-versie bevat alle functies die zijn geïntroduceerd in 2020-06-30-Preview, plus toevoegingen aan de volgende API's:
- indexalias voegt een secundaire naam toe die wordt gebruikt voor het verwijzen naar indexen in query- en indexeringsaanvragen. Aliasbewerkingen zijn onder andere maken, bijwerken, verwijderen, ophalen en vermelden.
- beheerde identiteiten voor uitgaande verbindingen. Nieuwe waarden voor verbindingsreeksen in Gegevensbron maken of bijwerken ondersteuning bieden voor verbindingen met behulp van Microsoft Entra ID-verificatie en -rollen in plaats van in code vastgelegde databasereferenties of -sleutels.
- Ondersteuning voor beheerde identiteiten wordt ook ondersteund voor key vault-verbindingen, voor zoekoplossingen die standaardversleuteling aanvullen met door de klant beheerde versleuteling.
- Meer talen voor de cognitieve vaardigheid Tekstvertaling.
- Meer queryLanguages voor semantische zoekopdrachten en spellingcontrole in zoekdocumenten (preview).
- Een parameter voor bijschriften om desgewenst bijschriften aan te vragen bij semantische zoekopdrachten in Documenten zoeken (preview).
- Semantische configuraties worden opgegeven in index maken of bijwerken. Een semantische configuratie bepaalt welke velden moeten worden gebruikt voor semantische rangschikking, bijschriften, markeringen en antwoorden.
- Een semanticConfiguration-parameter die is vereist voor semantische query's in zoekdocumenten (preview).
- Vanaf 29 maart 2024: GET-antwoorden retourneren geen verbindingsreeksen of sleutels meer. Zie Belangrijke wijziging voor clientcode die verbindingsgegevens leest voor meer informatie.
2020-06-30
Deze versie biedt algemeen beschikbare functies, waaronder:
- Op rollen gebaseerd toegangsbeheer van Azure voor gegevensvlakbewerkingen
- Relevantiescore (BM25)
- Kennisarchieven
- Indexeerfunctiegegevensbron voor Azure Data Lake Storage (ADLS) Gen2
- Vaardigheid voor opzoeken van aangepaste entiteiten
- Indexeerfuncties die worden uitgevoerd onder een door een systeem of door een gebruiker beheerde identiteit via Microsoft Entra-id
- Vanaf 29 maart 2024: GET-antwoorden retourneren geen verbindingsreeksen of sleutels meer. Zie Belangrijke wijziging voor clientcode die verbindingsgegevens leest voor meer informatie.
2020-06-30-preview
Deze preview-versie bevat alle functies die zijn geïntroduceerd in 2019-05-06-Preview, plus de volgende toevoegingen:
- Semantische zoekopdrachten, een Premium-functie die wordt uitgevoerd op services van de Standard-laag en die semantische rangschikking aanroept.
- Indexeerfunctiegegevensbron voor Power Query-connectors
- Indexeerfunctiegegevensbron voor MySQL
- Indexeerfunctiegegevensbron voor Cosmos DB Gremlin-API
- Indexeerfunctiegegevensbron voor SharePoint Online
- Normalizer-eigenschap voor tekstnormalisatie, voor niet-hoofdlettergevoelig filteren, facet en sorteren
- Documenten opnieuw instellen voor indexering op basis van indexeerfuncties om specifieke documenten specifiek te vernieuwen op id
- Cognitieve vaardigheid Entity Linking (v3)
- Cognitieve vaardigheid voor entiteitsherkenning (v3)
- Cognitieve vaardigheid sentimentanalyse (v3)
- Vanaf 29 maart 2024: GET-antwoorden retourneren geen verbindingsreeksen of sleutels meer. Zie Belangrijke wijziging voor clientcode die verbindingsgegevens leest voor meer informatie.
2019-05-06-preview
- Ondersteuning voor indexeerfunctie voor gegevensbronnen voor Cosmos DB MongoDB-API
- Gegevensbron voor indexeerfunctie voor voorlopig verwijderen in Blob Storage
- parameter featuresMode die gedetailleerde informatie retourneert over een relevantiescore
- Cognitieve vaardigheid van Azure Machine Learning (AML)
- Cognitieve vaardigheid voor persoonlijke identificatiedetectie
- Verrijkte documenten in de cache opslaan en hergebruiken van afbeeldingsverwerking (en andere AI-verrijkingen)
- Vanaf 29 maart 2024: GET-antwoorden retourneren geen verbindingsreeksen of sleutels meer. Zie Belangrijke wijziging voor clientcode die verbindingsgegevens leest voor meer informatie.