REST API-versioner (Azure AI Search)
I den här artikeln visas de aktuella och tidigare versionerna av SEARCH REST API:er för Azure AI Search.
Versionshanterade API-dokument
REST API-dokument är nu versionshanterade. När du öppnar en API-referenssida visas en versionsväljare ovanför innehållsförteckningen. Kontrollera att API-referensen kommer från mappen Reference>Data Plane.
Stabila versioner
API-version | Specifikation | API-uppdateringar |
---|---|---|
2024-07-01 (senaste) |
Swagger-specifikation | Viktig |
2023-11-01 |
Swagger-specifikation | Viktig |
2020-06-30 |
Swagger-specifikation | Viktig |
2019-05-06 |
Swagger-specifikation | Lägger till komplexa typer. |
Förhandsversioner
Förhandsversioner släpps för att testa nya funktioner, samla in feedback och identifiera och åtgärda problem. Förhandsversions-API:er finns tillgängliga under kompletterande användningsvillkor för Microsoft Azure Previews.
API-version | Specifikation | API-uppdateringar |
---|---|---|
2024-05-01-preview (senaste) |
Swagger-specifikation | Viktig |
2024-03-01-preview |
Swagger-specifikation | Viktig |
2023-10-01-preview |
Swagger-specifikation | Viktig |
2023-07-01-preview (inaktuell) |
Swagger-specifikation | Viktig |
2021-04-30-preview |
Swagger-specifikation | Viktig |
2020-06-30-preview |
Swagger-specifikation | Viktig |
2019-05-06-preview |
Swagger-specifikation | Viktig |
Utgåvan
2024-07-01
Den här versionen innehåller allmänt tillgängliga uppdateringar för integrerad vektorisering (färdigheter och vektoriserare), skalära kvantiseringar och binär kvantisering. Mer information finns i Nyheter i Azure AI Search.
Uppdatera | Tillämpligt REST API |
---|---|
Allmänt tillgänglig – vektordatatyper | Skapa eller uppdatera index |
Allmänt tillgänglig – egenskaper för kvantisering av vektorer för inbyggd skalär eller binär kvantisering i ett sökindex. | Skapa eller uppdatera index |
Allmänt tillgänglig – lagrad egenskap på ett vektorfält som avgör om en extra kopia av fältet lagras. Den extra kopian är det hämtningsbara innehållet i fältet. Om du inte lagrar det används fältet fortfarande i frågor, men kan inte returneras i ett sökresultat. Du kan ange den här egenskapen för att spara utrymme på söktjänsten eller vektorkvoten i ett sökindex. | Skapa eller uppdatera index |
Allmänt tillgänglig – VectorizableTextQuery parametrar för relevansjustering. Hybridfrågeparametrar (MaxTextSizeRecall) är fortfarande i förhandsversion. | sök dokument |
Allmänt tillgänglig – AzureOpenAIEmbedding-kunskaper för att stödja fler modeller än bara textinbäddning-ada-002 för integrerad vektorisering under indexering. Ange modellnamn och dimensionsegenskaper som mål för en specifik modell. | Skapa eller uppdatera kunskapsuppsättningen |
Allmänt tillgänglig – Azure OpenAI-inbäddningsvektoriserare för integrerad vektorisering under frågor. Vectorizer-egenskaper stöder fler modeller. | Skapa eller uppdatera index |
Från och med 29 mars 2024: GET-svar returnerar inte längre anslutningssträngar eller nycklar. Mer information finns i Icke-bakåtkompatibel ändring för klientkod som läser anslutningsinformation. | Alla versioner |
Förhandsversion 2024-05-01
Den här förhandsversionen lägger till stöd för OneLake-indexering, relevansjustering och djupare integrering med fler inbäddningsmodeller under indexering och frågor. Den bygger på 2024-03-01-preview
, så den har även skalarkvantisering, smala datatyper och lagringsalternativ som introduceras i den versionen.
Om du vill uppgradera från 2024-03-01-preview
eller 2023-10-01-preview
uppdaterar du kunskapen eller vektoriseraren AzureOpenAIEmbedding så att modellnamnet och dimensionerna inkluderas. Information om hur du uppgraderar från 2023-07-01-preview
(inaktuell) eller stegvisa instruktioner finns i Uppgradera REST-API:er.
Här är uppdateringarna i den här förhandsversionen. Vi rekommenderar också Nyheter i Azure AI Search.
Uppdatera | Tillämpligt REST API |
---|---|
Indexerarens datakälla för OneLake-filer och genvägar. | Skapa eller uppdatera datakälla |
Collection(Edm.Byte) , en binär datatyp för inbäddning av modeller som stöder dem. Vektorfältdefinitioner stöder den här datatypen. |
Skapa eller uppdatera index |
Flera vektor- och hybridfrågeparametrar för relevansjustering. Ange tröskelvärden för att exkludera resultat med låg poängsättning. Viktvektorfrågor. För hybridfrågor anger du maximalt antal dokument som ska hämtas i textdelen av en hybridfråga. | sök dokument |
Ny Azure AI Vision-färdighet för multimodal integrerad vektorisering under indexering. Den här färdigheten anropar det multimodala API:et för Azure AI Vision. | Skapa eller uppdatera kunskapsuppsättningen |
Ny Azure AI Vision-vektoriserare för multimodala frågor. En vektoriserare anges i indexdefinitioner, men används vid frågekörning. | Skapa eller uppdatera index |
AzureOpenAIEmbedding-kunskapen har uppdaterats för att stödja fler modeller än bara textinbäddning-ada-002 för integrerad vektorisering under indexering. Ange modellnamn och dimensionsegenskaper som mål för en specifik modell. | Skapa eller uppdatera kunskapsuppsättningen |
Azure OpenAI-inbäddningsvektoriseraren har uppdaterats för integrerad vektorisering under frågor. Vectorizer-egenskaper stöder fler modeller. | Skapa eller uppdatera index |
Från och med 29 mars 2024: GET-svar returnerar inte längre anslutningssträngar eller nycklar. Mer information finns i Icke-bakåtkompatibel ändring för klientkod som läser anslutningsinformation. | Alla versioner |
2024-03-01-preview
Den här förhandsversionen bygger på 2023-10-01-preview
genom att lägga till förhandsversions-API:er som förbättrar vektorlagringen. Mer information finns i Nyheter i Azure AI Search.
Uppdatera | Tillämpligt REST API |
---|---|
Ny smala datatyper för vektorfält om du har inbäddningsmodeller som stöder dem eller kvantiseringslogik som matar ut mindre vektorer. | Skapa eller uppdatera index |
Nya egenskaper för vektorkvantisering för inbyggd vektorkomprimering i ett sökindex. | Skapa eller uppdatera index |
Ny boolesk lagrad egenskap på ett vektorfält som avgör om en extra kopia av fältet lagras. Den extra kopian är det hämtningsbara innehållet i fältet. Om du inte lagrar det används fältet fortfarande i frågor, men kan inte returneras i ett sökresultat. Du kan ange den här egenskapen för att spara utrymme på söktjänsten eller vektorkvoten i ett sökindex. | Skapa eller uppdatera index |
Från och med 29 mars 2024: GET-svar returnerar inte längre anslutningssträngar eller nycklar. Mer information finns i Icke-bakåtkompatibel ändring för klientkod som läser anslutningsinformation. | Alla versioner |
2023-11-01
Den här versionen innehåller allmänt tillgängliga funktioner. Mer information finns i Nyheter i Azure AI Search.
Uppdatera | Tillämpligt REST API |
---|---|
Semantisk rangordning i Sök efter begäranden. | sök dokument |
Vektorsökningskonfiguration för indexeringsvektorfält | Skapa eller uppdatera index |
Vektorfrågor i Search Post-begäranden. | sök dokument |
Från och med 29 mars 2024: GET-svar returnerar inte längre anslutningssträngar eller nycklar. Mer information finns i Icke-bakåtkompatibel ändring för klientkod som läser anslutningsinformation. | Alla versioner |
Förhandsversion 2023-10-01
Den här versionen innehåller alla funktioner som introducerades i tidigare förhandsversioner, plus tillägg och ändringar av API:er för vektorsökning. Uppdateringar av API:er för vektorsökning är en icke-bakåtkompatibel ändring från 2023-07-01-Preview. Se Lägg till vektorfält och Skapa en vektorfråga för migreringshjälp.
Om du planerar att använda den nya förfilterfunktionen måste du använda ett index som skapats efter 2023-10-01.
vectorSearch
har definitioner föralgorithms
,profiles
ochvectorizers
:algorithms
fortsätter att stödjahnsw
och stöder nu äveneknn
, med hänvisning till HNSW (Hierarchical Navigable Small World) och uttömmande K-närmaste grannar (eKNN). I algoritmavsnittet kan du definiera flera namngivna kombinationer av HNSW- och eKNN-parametrar. Detta ersätteralgorithmConfigurations
i egenskapenvectorSearch
i 2023-07-01-Preview.profiles
är en ny definition som anger algoritmkonfigurationen. Anta till exempel att du har algoritmkonfigurationer med namnet HNSW-1, HSNW-2, eKNN-1. En profil kan ange HNSW-1.vectorizers
definieras i ett index men används vid frågetillfället för att bädda in en textfrågesträng. En vektoriserare refererar till en inbäddningsmodell. Söktjänsten anropar inbäddningsmodellen för att vektorisera textfrågesträngen och skickar sedan resultatet till sökmotorn för en vektorfråga.
I vektorfält ersätter
vectorSearchProfile
vectorSearchConfiguration
. EgenskapenvectorSearchProfile
anger vilken vektorsökningsprofil som ska användas i fältet.När du anropar API:et 2023-10-01-Preview måste du i din begäran ändra fältet för att ange en
vectorSearchProfile
så länge profilen anger exakt samma algoritm som tidigare angetts ivectorSearchConfiguration
. Om den befintliga fältdefinitionen till exempel anger"vectorSearchConfiguration": "myHnsw"
måste du ersätta den med"vectorSearchProfile": "your profile name"
och profilen måste definieras för att referera till samma"algorithm": "myHnsw"
.
-
vectorQueries
ersättervectors
i förhandsversionen 2023-07-01 -
vectorQueries.vectors
ersättervectors.values
i förhandsversionen 2023-07-01. - Vektorfrågan är nu en polymorf struktur.
kind
måste anges för att ange vilken typ av vektorfråga som begärs."kind": "vector"
innebär att frågan är en vektor, så anroparen bör redan ha vektoriserat sökfrågesträngen till en vektorinbäddning. -
"exhaustive": "true"
är en ny egenskap anger om du vill göra en fullständig (brute-force) k-närmaste grannsökning över alla vektorer i vektorindexet. -
vectorFilterMode
är en ny parameter för att ange förfiltrering (standard för index som skapats efter 2023-10-01) eller postfiltering (standard för tidigare index) i frågan.
Från och med 29 mars 2024: GET-svar returnerar inte längre anslutningssträngar eller nycklar. Mer information finns i Icke-bakåtkompatibel ändring för klientkod som läser anslutningsinformation.
Förhandsversion 2023-07-01
Viktig
Använd inte den här API-versionen. Utfasningen av den här förhandsversionen tillkännagavs den 15 april 2024 och stöds inte längre efter den 8 juli 2024. Hjälp med migrering finns i Uppgradera REST API:er i Azure AI Search.
Den här versionen introducerade vektorstöd och använder en vektorkonfiguration som är inkompatibel med nyare API-versioner.
- Lade till en
Collection(Edm.Single)
datatyp i fält som innehåller en matris med flyttal med enkel precision. Det här är datatypen för vektorer som används för att lagra en genererad inbäddning per dokumentfält. Sökindexet anger även vektorkonfigurationsegenskaper. Se Skapa eller uppdatera index för dessa API:er. - Indexeringsarbetsbelastningar har uppdaterats för att acceptera vektordata. Se Lägg till, uppdatera eller ta bort dokument.
- Frågeparametrar har lagts till för vektorsökning. Se Sök dokument för dessa parametrar.
- Hämta tjänststatistik: returnerar vektorindexkvot och användning för tjänsten.
- Hämta indexstatistik: returnerar vektorindexkvot och användning för sökindexet.
- Från och med 29 mars 2024: GET-svar returnerar inte längre anslutningssträngar eller nycklar. Mer information finns i Icke-bakåtkompatibel ändring för klientkod som läser anslutningsinformation.
Förhandsversion 2021-04-30
Den här förhandsversionen innehåller alla funktioner som introducerades i 2020-06-30-Preview, plus tillägg till följande API:er:
- Indexalias lägger till ett sekundärt namn som används för att referera till index i fråge- och indexeringsbegäranden. Aliasåtgärder inkluderar skapa, uppdatera, ta bort, hämta och lista.
- Hanterade identiteter för utgående anslutningar. Nya värden för anslutningssträngar i Skapa eller uppdatera datakälla stöder anslutningar med Microsoft Entra ID-autentisering och roller i stället för hårdkodade databasautentiseringsuppgifter eller nycklar.
- Stöd för hanterad identitet stöds också för Key Vault-anslutningar, för söklösningar som kompletterar standardkryptering med kundhanterad kryptering.
- Fler språk för den kognitiva kunskapen för textöversättning.
- Fler queryLanguages för semantisk sökning och stavning i Sök dokument (förhandsversion).
- En undertextparameter för att eventuellt begära undertexter från semantisk sökning i sökdokument (förhandsversion).
- semantiska konfigurationer anges i Skapa eller uppdatera index. En semantisk konfiguration avgör vilka fält som ska användas för semantisk rangordning, undertexter, markeringar och svar.
- En semanticConfiguration-parameter som krävs för semantiska frågor i Sökdokument (förhandsversion).
- Från och med 29 mars 2024: GET-svar returnerar inte längre anslutningssträngar eller nycklar. Mer information finns i Icke-bakåtkompatibel ändring för klientkod som läser anslutningsinformation.
2020-06-30
Den här versionen innehåller allmänt tillgängliga funktioner, inklusive:
- Rollbaserad åtkomstkontroll i Azure för dataplansåtgärder
- Relevansbedömning (BM25)
- Kunskapslager
- Indexerarens datakälla för Azure Data Lake Storage (ADLS) Gen2
- Anpassad entitetssökningsfärdighet
- Indexerare som körs under en system- eller användarhanterad identitet via Microsoft Entra-ID
- Från och med 29 mars 2024: GET-svar returnerar inte längre anslutningssträngar eller nycklar. Mer information finns i Icke-bakåtkompatibel ändring för klientkod som läser anslutningsinformation.
Förhandsversion 2020-06-30
Den här förhandsversionen innehåller alla funktioner som introducerades i 2019-05-06-Preview, plus följande tillägg:
- Semantisk sökning, en premiumfunktion som körs på standardnivåtjänster och som anropar semantisk rangordning.
- Indexerarens datakälla för Power Query-anslutningsappar
- Indexerarens datakälla för MySQL
- Indexerarens datakälla för Cosmos DB Gremlin API
- Indexerarens datakälla för SharePoint Online
- Normalizer-egenskap för textnormalisering för skiftlägesokänslig filtrering, fasettering och sortering
- Återställa dokument för indexerarbaserad indexering för att specifikt uppdatera specifika dokument efter ID
- Entitetslänkning av kognitiv skicklighet (v3)
- Kognitiv färdighet för entitetsigenkänning (v3)
- Kognitiv färdighet för attitydanalys (v3)
- Från och med 29 mars 2024: GET-svar returnerar inte längre anslutningssträngar eller nycklar. Mer information finns i Icke-bakåtkompatibel ändring för klientkod som läser anslutningsinformation.
2019-05-06-preview
- Stöd för Indexer-datakälla för Cosmos DB MongoDB API
- Indexerarens datakälla för mjuk borttagning i Blob Storage
- featuresMode-parameter som returnerar detaljerad information om en relevanspoäng
- Kognitiv kunskap om Azure Machine Learning (AML)
- Kognitiv kunskap om identifiering av personlig identifiering
- Cachelagrar berikade dokument för att bevara och återanvända bildbearbetning (och andra AI-berikanden)
- Från och med 29 mars 2024: GET-svar returnerar inte längre anslutningssträngar eller nycklar. Mer information finns i Icke-bakåtkompatibel ändring för klientkod som läser anslutningsinformation.