REST API-versies (Azure AI Search)

  • Artikel

In dit artikel vindt u 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-verwijzingspagina opent, wordt er een versiekiezer weergegeven boven de inhoudsopgave.

  1. Vouw verwijzingsgegevensvlak > uit.

  2. Selecteer een API-verwijzingspagina.

  3. Kies een API-versie in de vervolgkeuzelijst linksboven.

    Schermopname van de versiekiezer.

Stabiele versies

API-versie Specificatie API-updates
2023-11-01 (Meest recente) Swagger-specificatie Releaseopmerking
2020-06-30 Swagger-specificatie Releaseopmerking
2019-05-06 Swagger-specificatie Voegt complexe typen toe.
2017-11-11 Swagger-specificatie Voegt vaardighedensets en AI-verrijking toe.
2016-09-01 Swagger-specificatie Hiermee worden indexeerfuncties toegevoegd.
2015-02-28 Niet ondersteund na 10-10-2020 Eerste algemeen beschikbare release.

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-03-01-Preview (Meest recente) Swagger-specificatie Releaseopmerking
2023-10-01-Preview Swagger-specificatie Releaseopmerking
2023-07-01-Preview (afgeschaft) Swagger-specificatie Releaseopmerking
2021-04-30-Preview Swagger-specificatie Releaseopmerking
2020-06-30-Preview Swagger-specificatie Releaseopmerking
2019-05-06-Preview Swagger-specificatie Releaseopmerking
2017-11-11-Preview Swagger-specificatie Preview-versie gekoppeld aan stabiele versie.
2016-09-01-Preview Swagger-specificatie Preview-versie gekoppeld aan stabiele versie.
2015-02-28-Preview (buiten gebruik gesteld) Niet ondersteund na 10-10-2020 Preview-versie gekoppeld aan stabiele versie.
2014-10-20-Preview (buiten gebruik gesteld) Niet ondersteund na 10-10-2020 Tweede openbare preview.
2014-07-31-Preview (buiten gebruik gesteld) Niet ondersteund na 10-10-2020 Eerste openbare preview.

Opmerkingen bij de release

2024-03-01-Preview

Deze preview-versie bouwt voort door 2023-10-01-preview de volgende preview-API's toe te voegen waarmee u ruimte kunt besparen:

  • Nieuwe smalle gegevenstypen voor vectorvelden als u ingesloten modellen hebt die deze ondersteunen of kwantisatielogica die kleinere vectoren uitvoert.
  • Nieuwe vector kwantisatie-eigenschappen voor ingebouwde vectorcompressie in een zoekindex.
  • Nieuwe booleaanse opgeslagen eigenschap in een vectorveld dat bepaalt of er een extra kopie van het veld wordt opgeslagen. De extra kopie is de inhoud van dat veld dat kan worden opgehaald. Als u het veld 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.

2023-11-01

Deze versie biedt algemeen beschikbare functies, waaronder:

  • Semantische rangschikking in Search Post-aanvragen.
  • Vectorzoekindexering in Creatie- of update-indexaanvragen en vectorquery's in Search Post-aanvragen.

2023-10-01-Preview

Deze versie bevat alle functies die in eerdere previews zijn geïntroduceerd, plus toevoegingen en wijzigingen aan vectorzoek-API's. Updates van de vectorzoek-API's is een belangrijke wijziging ten opzichte van 2023-07-01-Preview. Zie Vectorvelden toevoegen en Creatie een vectorquery voor hulp bij migratie.

Als u van plan bent om de nieuwe voorfilterfunctie te gebruiken, moet u een index gebruiken die is gemaakt na 01-10-2023.

Creatie of index bijwerken:

  • vectorSearch heeft definities voor algorithms, profilesen vectorizers:

    • algorithms blijft ondersteunen hnsw en ondersteunt eknnnu ook , met betrekking tot Hierarchical Navigable Small World (HNSW) en volledige K-dichtstbijzijnde buren (eKNN). In de sectie algoritme kunt u meerdere benoemde combinaties van HNSW- en eKNN-parameters definiëren. Dit vervangt algorithmConfigurations in de vectorSearch eigenschap in 2023-07-01-Preview.

    • profiles is een nieuwe definitie waarmee de algoritmeconfiguratie wordt opgegeven. Stel dat u algoritmeconfiguraties hebt met de naam HNSW-1, HSNW-2, eKNN-1. In een profiel kan HNSW-1 worden opgegeven.

    • vectorizers is gedefinieerd in een index, maar wordt tijdens de query gebruikt om een tekstquerytekenreeks in te sluiten. Een vectorizer verwijst naar een insluitmodel. De zoekservice roept het insluitmodel aan om de tekenreeks van de tekstquery te vectoriseren en geeft het resultaat vervolgens door aan de zoekmachine voor een vectorquery.

  • Vervangt op vectorvelden vectorSearchProfilevectorSearchConfiguration. De vectorSearchProfile eigenschap geeft aan welk vectorzoekprofiel voor het veld moet worden gebruikt.

  • In indexen die vóór deze API-versie zijn gemaakt, moet u bij het aanroepen van de API 2023-10-01-Preview in uw aanvraag het veld wijzigen om een vectorSearchProfile op te geven zolang het profiel exact hetzelfde algoritme opgeeft dat eerder is opgegeven in vectorSearchConfiguration. Als de bestaande velddefinitie bijvoorbeeld opgeeft "vectorSearchConfiguration": "myHnsw", moet u deze "vectorSearchProfile": "your profile name"vervangen door en moet het profiel worden gedefinieerd om naar dezelfde "algorithm": "myHnsw"te verwijzen.

Search documenten:

  • vectorQueries wordt vectors vervangen in 2023-07-01-Preview

  • vectorQueries.vectors vervangt vectors.values in 2023-07-01-Preview.

  • De vectorquery is nu een polymorfe structuur. kind moet 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 ingesloten vector.

  • "exhaustive": "true" is een nieuwe eigenschap geeft aan of een volledige (brute-force) k-dichtstbijzijnde burenzoekopdracht moet worden uitgevoerd voor alle vectoren binnen de vectorindex.

  • vectorFilterMode is een nieuwe parameter voor het opgeven van voorfiltering (standaard voor indexen die zijn gemaakt na 2023-10-01) of postfiltering (standaard op eerdere indexen) in de query.

2023-07-01-Preview

Belangrijk

Afschaffing van deze preview-versie is aangekondigd op 15 april 2024 en wordt op 8 juli 2024 buiten gebruik gesteld. Zie REST API's upgraden in Azure AI Search voor hulp bij migratie.

Deze versie bevat functies uit eerdere previews, plus ondersteuning voor vectorzoekopdrachten:

  • Wijs in de zoekindex het gegevenstype toe Collection(Edm.Single) aan velden die een matrix met drijvendekommanummers met één precisie bevatten. Dit is het gegevenstype voor de nieuwe vectorzoekfunctie, dat wordt gebruikt om één gegenereerde insluiting per documentveld op te slaan. Geef ook vectorconfiguratie-eigenschappen op in de zoekindex. Zie Creatie of Index bijwerken voor deze API's.

  • Indexeringsworkloads worden bijgewerkt om vectorgegevens te accepteren. Zie Documenten toevoegen, bijwerken of verwijderen.

  • Queryparameters voor vectorzoekopdrachten. Zie Search Documenten voor deze parameters.

  • Servicestatistieken ophalen: retourneert het quotum en het gebruik van de vectorindex voor de service.

  • Indexstatistieken ophalen: retourneert het quotum en het gebruik van de vectorindex voor de zoekindex.

30-04-2021 Preview

Deze preview-versie bevat alle functies die zijn geïntroduceerd in 30-06-2020, plus toevoegingen aan de volgende API's:

2020-06-30

Deze versie biedt algemeen beschikbare functies, waaronder:

  • Op rollen gebaseerd toegangsbeheer van Azure voor gegevensvlakbewerkingen
  • Relevantiescore (BM25)
  • Knowledge Stores
  • Indexeerfunctiegegevensbron voor Azure Data Lake Storage (ADLS) Gen2
  • Vaardigheid Aangepaste entiteit opzoeken
  • Indexeerfuncties die worden uitgevoerd onder een systeem of door de gebruiker beheerde identiteit via Microsoft Entra ID

2020-06-30-Preview

Deze preview-versie bevat alle functies die zijn geïntroduceerd in 2019-05-06-Preview, plus de volgende toevoegingen:

  • Semantisch zoeken, een premium-functie die wordt uitgevoerd op services in 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, faceten en sorteren
  • Documenten opnieuw instellen voor indexering op basis van indexeerfunctie om specifieke documenten specifiek te vernieuwen op id
  • Cognitieve vaardigheid Entity Linking (v3)
  • Cognitieve vaardigheid entiteitsherkenning (v3)
  • Cognitieve vaardigheid sentimentanalyse (v3)

2019-05-06-Preview

  • Ondersteuning voor indexeerfunctiegegevensbron voor Cosmos DB MongoDB-API
  • Indexeerfunctiegegevensbron voor systeemeigen blob voorlopig verwijderen in Blob Storage
  • featuresMode-parameter die gedetailleerde informatie over een relevantiescore retourneert
  • Cognitieve vaardigheden van Azure Machine Learning (AML)
  • Cognitieve vaardigheid voor persoonlijke identificatiedetectie
  • Verrijkte documenten in cache opslaan om afbeeldingsverwerking (en andere AI-verrijkingen) te behouden en opnieuw te gebruiken

Zie ook