REST-API-Versionen (Azure AI Search)

Artikel
04/24/2024

In diesem Artikel werden die aktuellen und früheren Versionen der Search REST-APIs für Azure AI Search aufgeführt.

Versionsierte API-Dokumentation

REST-API-Dokumente verfügen jetzt über eine Versionsangabe. Wenn Sie eine API-Referenzseite öffnen, wird über dem Inhaltsverzeichnis eine Versionsauswahl angezeigt.

Erweitern Sie Verweisdatenebene>.
Wählen Sie eine API-Referenzseite aus.
Wählen Sie oben links im Dropdownfilter eine API-Version aus.

Stabile Versionen

API-Version	Spezifikation	API-Updates
`2023-11-01` (Neueste)	Swagger-Spezifikation	Versionshinweis
`2020-06-30`	Swagger-Spezifikation	Versionshinweis
`2019-05-06`	Swagger-Spezifikation	Fügt komplexe Typen hinzu.
`2017-11-11`	Swagger-Spezifikation	Fügt Skillsets und KI-Anreicherung hinzu.
`2016-09-01`	Swagger-Spezifikation	Fügt Indexer hinzu.
`2015-02-28`	Nicht mehr unterstützt ab dem 10. 10. 2020	Erstes allgemein verfügbares Release.

Vorschauversionen

Vorschauversionen werden veröffentlicht, um neue Funktionen zu testen, Feedback zu sammeln sowie Probleme zu ermitteln und zu beheben. Vorschau-APIs sind unter Zusätzliche Nutzungsbedingungen für Microsoft Azure Previews verfügbar.

API-Version	Spezifikation	API-Updates
`2024-03-01-Preview` (Neueste)	Swagger-Spezifikation	Versionshinweis
`2023-10-01-Preview`	Swagger-Spezifikation	Versionshinweis
`2023-07-01-Preview` (veraltet)	Swagger-Spezifikation	Versionshinweis
`2021-04-30-Preview`	Swagger-Spezifikation	Versionshinweis
`2020-06-30-Preview`	Swagger-Spezifikation	Versionshinweis
`2019-05-06-Preview`	Swagger-Spezifikation	Versionshinweis
`2017-11-11-Preview`	Swagger-Spezifikation	Mit der stabilen Version verknüpfte Vorschauversion.
`2016-09-01-Preview`	Swagger-Spezifikation	Mit der stabilen Version verknüpfte Vorschauversion.
`2015-02-28-Preview` (eingestellt)	Nicht mehr unterstützt ab dem 10. 10. 2020	Mit der stabilen Version verknüpfte Vorschauversion.
`2014-10-20-Preview` (eingestellt)	Nicht mehr unterstützt ab dem 10. 10. 2020	Zweite öffentliche Vorschauversion.
`2014-07-31-Preview` (eingestellt)	Nicht mehr unterstützt ab dem 10. 10. 2020	Erste öffentliche Vorschauversion.

Versionshinweise

2024-03-01-Preview

Diese Vorschauversion baut auf auf, 2023-10-01-preview indem die folgenden Vorschau-APIs hinzugefügt werden, mit denen Sie Speicherplatz sparen können:

Neue schmale Datentypen für Vektorfelder , wenn Sie über Einbettungsmodelle verfügen, die diese unterstützen, oder Quantisierungslogik, die kleinere Vektoren ausgibt.
Neue Vektorquantisierungseigenschaften für die integrierte Vektorkomprimierung in einem Suchindex.
Neue boolesche gespeicherte Eigenschaft für ein Vektorfeld , das bestimmt, ob eine zusätzliche Kopie des Felds gespeichert wird. Die zusätzliche Kopie ist der abrufbare Inhalt dieses Felds. Wenn Sie es nicht speichern, wird das Feld weiterhin in Abfragen verwendet, kann aber nicht in einem Suchergebnis zurückgegeben werden. Sie können diese Eigenschaft festlegen, um Platz in Ihrem Suchdienst oder Vektorkontingent in einem Suchindex zu sparen.

2023-11-01

Diese Version bietet allgemein verfügbare Features, einschließlich:

Semantische Rangfolge in Search Post-Anforderungen.
Vektorsuchindizierung in Create- oder Indexaktualisierungsanforderungen und Vektorabfragen in Search Post-Anforderungen.

2023-10-01-Preview

Diese Version enthält alle Features, die in früheren Vorschauversionen eingeführt wurden, sowie Ergänzungen und Änderungen an Vektorsuch-APIs. Updates zu den Vektorsuche-APIs sind eine Breaking Change gegenüber 2023-07-01-Preview. Hilfe zur Migration finden Sie unter Hinzufügen von Vektorfeldern und Create einer Vektorabfrage.

Wenn Sie die neue Vorfilterfunktion verwenden möchten, müssen Sie einen Index verwenden, der nach dem 01.10.2023 erstellt wurde.

Create oder Index aktualisieren:

vectorSearch verfügt über Definitionen für algorithms, profilesund vectorizers:
- algorithms unterstützt hnsw weiterhin und unterstützt eknnjetzt auch , in Bezug auf Hierarchisch navigable Small World (HNSW) und vollständige k-nearest neighbors (eKNN). Im Abschnitt algorithmus können Sie mehrere benannte Kombinationen von HNSW- und eKNN-Parametern definieren. Dadurch wird innerhalb der vectorSearch -Eigenschaft in 2023-07-01-Preview ersetztalgorithmConfigurations.
- profiles ist eine neue Definition, die die Algorithmuskonfiguration angibt. Angenommen, Sie verfügen über Algorithmuskonfigurationen mit den Namen HNSW-1, HSNW-2, eKNN-1. Ein Profil kann HNSW-1 angeben.
- vectorizers wird in einem Index definiert, aber zur Abfragezeit zum Einbetten einer Textabfragezeichenfolge verwendet. Ein Vektorisierer verweist auf ein Einbettungsmodell. Der Suchdienst ruft das Einbettungsmodell auf, um die Textabfragezeichenfolge zu vektorisieren, und übergibt dann das Ergebnis für eine Vektorabfrage an die Suchmaschine.
Ersetzt vectorSearchConfigurationin Vektorfeldern vectorSearchProfile . Die vectorSearchProfile -Eigenschaft gibt an, welches Vektorsuchprofil für das Feld verwendet werden soll.
Bei Indizes, die vor dieser API-Version erstellt wurden, müssen Sie beim Aufrufen der 2023-10-01-Preview-API in Ihrer Anforderung das Feld ändern, soweit vectorSearchProfile das Profil den genauen Algorithmus angibt, der zuvor in vectorSearchConfigurationangegeben wurde. Wenn die vorhandene Felddefinition beispielsweise angibt "vectorSearchConfiguration": "myHnsw", müssen Sie sie durch "vectorSearchProfile": "your profile name"ersetzen, und das Profil muss definiert werden, um auf dasselbe "algorithm": "myHnsw"zu verweisen.

Search Dokumente:

vectorQueriesvectors ersetzt in 2023-07-01-Preview
vectorQueries.vectorsvectors.values ersetzt in 2023-07-01-Preview.
Die Vektorabfrage ist jetzt eine polymorphe Struktur. kind muss angegeben werden, um den Typ der angeforderten Vektorabfrage anzugeben.
- "kind": "vector" bedeutet, dass die Abfrage ein Vektor ist, sodass der Aufrufer die Suchabfragezeichenfolge bereits in eine Vektoreinbettung vektorisiert haben sollte.
"exhaustive": "true" ist eine neue Eigenschaft, die angibt, ob eine vollständige (Brute-Force) k-nächstgelegene Nachbarsuche für alle Vektoren innerhalb des Vektorindexes durchgeführt werden soll.
vectorFilterMode ist ein neuer Parameter zum Angeben des Vorfilterns (Standard für Indizes, die nach dem 01.10.2023 erstellt wurden) oder zum Nachfiltern (Standard für vorherige Indizes) in der Abfrage.

2023-07-01-Preview

Wichtig

Die Veraltetkeit dieser Vorschauversion wurde am 15. April 2024 angekündigt und wird am 8. Juli 2024 eingestellt. Hilfe bei der Migration finden Sie unter Upgrade VON REST-APIs in Azure AI Search.

Diese Version bietet Features aus früheren Vorschauversionen sowie Unterstützung für die Vektorsuche:

Weisen Sie Collection(Edm.Single) im Suchindex den Datentyp für Felder zu, die ein Array von Gleitkommazahlen mit einfacher Genauigkeit enthalten. Dies ist der Datentyp für die neue Vektorsuchfunktion, die zum Speichern einer generierten Einbettung pro Dokumentfeld verwendet wird. Geben Sie auch im Suchindex Vektorkonfigurationseigenschaften an. Siehe Create oder Index aktualisieren für diese APIs.
Indizierungsworkloads werden aktualisiert, um Vektordaten zu akzeptieren. Weitere Informationen finden Sie unter Hinzufügen, Aktualisieren oder Löschen von Dokumenten.
Abfrageparameter für die Vektorsuche. Diese Parameter finden Sie unter Search Dokumente.
Dienststatistik abrufen: Gibt das Vektorindexkontingent und die Nutzung für den Dienst zurück.
Indexstatistik abrufen: Gibt das Vektorindexkontingent und die Verwendung für den Suchindex zurück.

2021-04-30-Preview

Diese Vorschauversion enthält alle Features, die in 2020-06-30-Preview eingeführt wurden, sowie Ergänzungen zu den folgenden APIs:

Indexalias fügt einen sekundären Namen hinzu, der zum Verweisen auf Indizes in Abfrage- und Indizierungsanforderungen verwendet wird. Aliasvorgänge umfassen Erstellen, Aktualisieren, Löschen, Abrufen und Listen.
Verwaltete Identitäten für ausgehende Verbindungen. Neue Werte für Verbindungszeichenfolgen in Create oder Datenquelle aktualisieren unterstützen Verbindungen mithilfe von Microsoft Entra ID Authentifizierung und Rollen anstelle von hartcodierten Datenbankanmeldeinformationen oder -schlüsseln.
Die Unterstützung verwalteter Identitäten wird auch für Schlüsseltresorverbindungen unterstützt, für Suchlösungen, die die Standardverschlüsselung um die kundenseitig verwaltete Verschlüsselung ergänzen.
Weitere Sprachen für die kognitive Fähigkeit Textübersetzung.
Weitere queryLanguages für semantische Suche und Rechtschreibprüfung in Search Dokumente (Vorschau).
Ein Captions-Parameter zum optionalen Anfordern von Untertiteln aus der semantischen Suche in Search Documents (Vorschau).
Semantikkonfigurationen werden in Create oder Index aktualisieren angegeben. Eine semantische Konfiguration bestimmt, welche Felder für semantische Rangfolge, Beschriftungen, Hervorhebungen und Antworten verwendet werden sollen.
Ein semanticConfiguration-Parameter, der für semantische Abfragen in Search Documents (Vorschau) erforderlich ist.

2020-06-30