REST-API-Versionen (Azure AI Search)
In diesem Artikel werden die aktuellen und früheren Versionen der Search-REST-APIs für Azure AI Search aufgeführt.
Versionsierte API-Dokumente
REST-API-Dokumente sind jetzt versionsiert. Wenn Sie eine API-Referenzseite öffnen, wird oberhalb des Inhaltsverzeichnisses eine Versionsauswahl angezeigt. Stellen Sie sicher, dass die API-Referenz aus dem Ordner "Reference>Data Plane" stammt.
Stabile Versionen
| API-Version | Spezifikation | API-Updates |
|---|---|---|
2024-07-01 (neueste) |
Swagger Spezifikation | Versionshinweise |
2023-11-01 |
Swagger Spezifikation | Versionshinweise |
2020-06-30 |
Swagger Spezifikation | Versionshinweise |
2019-05-06 |
Swagger Spezifikation | Fügt komplexe Typen hinzu. |
Vorschauversionen
Vorschauversionen werden veröffentlicht, um neue Funktionen zu testen, Feedback zu sammeln und Probleme zu ermitteln und zu beheben. Vorschau-APIs sind unter Ergänzende Nutzungsbedingungen für Microsoft Azure Previewsverfügbar.
| API-Version | Spezifikation | API-Updates |
|---|---|---|
2024-11-01-preview (neueste) |
Swagger Spezifikation | Versionshinweise |
2024-09-01-preview |
Swagger Spezifikation | Versionshinweise |
2024-05-01-preview |
Swagger Spezifikation | Versionshinweise |
2024-03-01-preview |
Swagger Spezifikation | Versionshinweise |
2023-10-01-preview |
Swagger Spezifikation | Versionshinweise |
2023-07-01-preview (veraltet) |
Swagger Spezifikation | Versionshinweise |
2021-04-30-preview |
Swagger Spezifikation | Versionshinweise |
2020-06-30-preview |
Swagger Spezifikation | Versionshinweise |
2019-05-06-preview |
Swagger Spezifikation | Versionshinweise |
Anmerkungen zur Version
2024-11-01-Vorschau
Diese Vorschau baut auf der 2024-09-01-preview auf und umfasst alle Features, die derzeit in der Vorschauversionsind. Sie können ein Upgrade von 2024-09-01-preview auf 2024-11-01-preview mit minimalen Codeänderungen durchführen. Weitere Informationen finden Sie unter Upgrade der REST-APIs.
| Aktualisieren | Anwendbare REST-API |
|---|---|
| Abfrage im semantischen Rerankerumschreiben, verwendet, um Abfragen zu verfeinern, die an den L2-Rangierer gesendet werden. | Search Documents, new QueryRewritesType Property in der Anforderung. |
| Dokumentlayoutfähigkeit verwendet, um ein Dokument für die Struktur zu analysieren. | Erstellen oder Aktualisieren von Skillset, neue DocumentIntelligenceLayoutSkill Fähigkeiten. |
| Verwaltete Identität für Anfügen einer Azure AI Multiservice-Ressource. | Create or Update Skillset, neue AIServicesAccountIdentity-Eigenschaft. |
| Markdown-Analysemodus, der zum Indizieren von Markdown-Dateien in Azure Storage verwendet wird. | Erstellen oder Aktualisieren des Indexers, neue Markdown- Analysemodus. |
| Optionen für die Rescoring-Optionen für komprimierte Vektoren, die für die Rescoring mit ursprünglichen Vektoren anstelle von komprimierten Vektoren verwendet werden. Gilt für HNSW und erschöpfende KNN-Vektoralgorithmen mit binärer und skalarer Komprimierung. |
Create or Update Index, neue rescoringOptions Eigenschaften. Eine neue enableRescoring-Eigenschaft ist rerankWithOriginalVectors zugeordnet, die in 2024-03-01-Preview eingeführt wurde. |
2024-09-01-Vorschau
Diese Vorschau baut auf der 2024-05-01-preview auf und umfasst alle Features, die derzeit in der Vorschauversionsind. Sie können ein Upgrade von 2024-05-01-preview auf 2024-09-01-preview durchführen, ohne dass Codeänderungen erforderlich sind. Weitere Informationen finden Sie unter Upgrade der REST-APIs.
| Aktualisieren | Anwendbare REST-API |
|---|---|
| Abgeschnittene Dimensionen für die Quantisierung von Matryoshka Representation Learning (MRL) für texteinbettung-3-kleine und Texteinbettungsmodelle neu trainiert. | Create or Update Index, new truncationDimension Parameter |
| Subscores oder Bewertungsdetails für das Entpacken von Hybridsuchergebnissen, die von Kehrbewertungsfusion (RRF)bewertet wurden. | Suchdokumente, neue Debuggen Parameter- und Abfrageunterscoredefinitionen in der Antwort. |
| Zielfilterung auf den Vektorteil einer hybriden Suchabfrage. | Search Documents, new filterOverride Parameter in RawVectorQuery, VectorizableTextQuery, VectorizableImageUrlQuery, VectorizableImageBinaryQuery. |
| Tokenblocking in TextTeilungsfertigkeit, statt nur Zeichen. | Create or Update Skillset, neue Unit Parameter und andere tokenbezogene Eigenschaften. |
2024-07-01
Diese Version bietet allgemein verfügbare Updates für integrierte Vektorisierung (Fähigkeiten und Vektorisierer), skalare Quantisierung und binäre Quantisierung. Weitere Informationen finden Sie unter Neuerungen in Azure AI Search.
| Aktualisieren | Anwendbare REST-API |
|---|---|
| Allgemein verfügbar – Vektordatentypen | erstellen oder aktualisieren |
| Allgemein verfügbar – Vektorquantisierungseigenschaften für integrierte skalare oder binäre Quantisierung in einem Suchindex. | erstellen oder aktualisieren |
| Allgemein verfügbar – gespeicherte Eigenschaft für ein Vektorfeld, das bestimmt, ob eine zusätzliche Kopie des Felds gespeichert ist. 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 für Ihren Suchdienst oder Vektorkontingent in einem Suchindex zu sparen. | erstellen oder aktualisieren |
| Allgemein verfügbar – VectorizableTextQuery Parameter für die Relevanzoptimierung. Hybridabfrageparameter (MaxTextSizeRecall) befinden sich noch in der Vorschau. | suchen |
| Allgemein verfügbar – AzureOpenAIEmbedding-Fähigkeit, mehr Modelle zu unterstützen als nur text-embedding-ada-002 für die integrierte Vektorisierung während der Indizierung. Legen Sie den Modellnamen und die Dimensionseigenschaften auf ein bestimmtes Modell fest. | Erstellen oder Aktualisieren von Skillset- |
| Allgemein verfügbar : Azure OpenAI embedding vectorizer for integrated vectorization during queries. Vectorizer-Eigenschaften unterstützen weitere Modelle. | erstellen oder aktualisieren |
| Ab dem 29. März 2024 geben GET-Antworten keine Verbindungszeichenfolgen oder Schlüssel mehr zurück. Weitere Informationen finden Sie unter Grundlegende Änderung für Clientcode, der Verbindungsinformationen liest. | Alle Versionen |
2024-05-01-Vorschau
Diese Vorschau bietet Unterstützung für oneLake-Indizierung, Relevanzoptimierung und tiefere Integration mit mehr Einbettungsmodellen während der Indizierung und Abfragen. Es baut auf dem 2024-03-01-preview auf und umfasst alle Features, die derzeit in der Vorschauversion.
Um ein Upgrade von 2024-03-01-preview oder 2023-10-01-previewdurchzuführen, aktualisieren Sie die AzureOpenAIEmbedding-Fähigkeit oder den Vektorizer, um den Modellnamen und die Dimensionen einzuschließen. Informationen zum Upgrade von 2023-07-01-preview (veraltet) oder schrittweise Anleitungen finden Sie unter Upgrade-REST-APIs.
Hier sind die Updates in dieser Vorschau. Wir empfehlen auch Neuerungen in Azure AI Search.
| Aktualisieren | Anwendbare REST-API |
|---|---|
| Indexer-Datenquelle für OneLake-Dateien und Verknüpfungen. | Erstellen oder Aktualisieren von Datenquellen- |
Collection(Edm.Byte), ein binärer Datentyp für einbettende Modelle, die diese unterstützen. Vektorfelddefinitionen unterstützen diesen Datentyp. |
erstellen oder aktualisieren |
| Mehrere Vektor- und Hybridabfrageparameter für die Relevanzoptimierung. Legen Sie Schwellenwerte fest, um niedrige Bewertungsergebnisse auszuschließen. Gewichtungsvektorabfragen. Legen Sie für Hybridabfragen die maximale Anzahl von Dokumenten fest, die im Textbereich einer Hybridabfrage abgerufen werden sollen. | suchen |
| Neue Azure AI Vision-Fähigkeit zur multimodalen integrierten Vektorisierung während der Indizierung. Diese Fähigkeit ruft die multimodale API von Azure AI Vision auf. | Erstellen oder Aktualisieren von Skillset- |
| Neuer Azure AI Vision-Vektorizer für multimodale Abfragen. Ein Vektorizer wird in Indexdefinitionen angegeben, wird jedoch während der Abfrageausführung verwendet. | erstellen oder aktualisieren |
| AzureOpenAIEmbedding-Fähigkeit wurde aktualisiert, um mehr Modelle zu unterstützen als nur text-embedding-ada-002 für die integrierte Vektorisierung während der Indizierung. Legen Sie den Modellnamen und die Dimensionseigenschaften auf ein bestimmtes Modell fest. | Erstellen oder Aktualisieren von Skillset- |
| Azure OpenAI embedding vectorizer for integrated vectorization during queries aktualisiert. Vectorizer-Eigenschaften unterstützen weitere Modelle. | erstellen oder aktualisieren |
| Ab dem 29. März 2024 geben GET-Antworten keine Verbindungszeichenfolgen oder Schlüssel mehr zurück. Weitere Informationen finden Sie unter Grundlegende Änderung für Clientcode, der Verbindungsinformationen liest. | Alle Versionen |
2024-03-01-Vorschau
Diese Vorschauversion baut auf 2023-10-01-preview auf, indem Vorschau-APIs hinzugefügt werden, die den Vektorspeicher verbessern. Weitere Informationen finden Sie unter Neuerungen in Azure AI Search.
| Aktualisieren | Anwendbare REST-API |
|---|---|
| Neue schmale Datentypen für Vektorfelder, wenn Sie Modelle einbetten, die sie unterstützen, oder quantisierungslogik, die kleinere Vektoren ausgibt. | erstellen oder aktualisieren |
| Neue Vektorquantisierungseigenschaften für die integrierte Vektorkomprimierung in einem Suchindex. | erstellen oder aktualisieren |
| 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 für Ihren Suchdienst oder Vektorkontingent in einem Suchindex zu sparen. | erstellen oder aktualisieren |
| Ab dem 29. März 2024 geben GET-Antworten keine Verbindungszeichenfolgen oder Schlüssel mehr zurück. Weitere Informationen finden Sie unter Grundlegende Änderung für Clientcode, der Verbindungsinformationen liest. | Alle Versionen |
2023-11-01
Diese Version bietet allgemein verfügbare Features. Weitere Informationen finden Sie unter Neuerungen in Azure AI Search.
| Aktualisieren | Anwendbare REST-API |
|---|---|
| Semantische Rangfolge in Search Post-Anforderungen. | suchen |
| Vektorsuchkonfiguration für Indizierungsvektorfelder | erstellen oder aktualisieren |
| Vektorabfragen in Search Post-Anforderungen. | suchen |
| Ab dem 29. März 2024 geben GET-Antworten keine Verbindungszeichenfolgen oder Schlüssel mehr zurück. Weitere Informationen finden Sie unter Grundlegende Änderung für Clientcode, der Verbindungsinformationen liest. | Alle Versionen |
2023-10-01-Vorschau
Diese Version enthält alle Features, die in früheren Vorschauen eingeführt wurden, sowie Ergänzungen und Änderungen an Vektorsuch-APIs. Aktualisierungen der Vektorsuch-APIs sind eine bahnbrechende Änderung von 2023-07-01-Preview. Informationen zur Migrationshilfe finden Sie unter Hinzufügen von Vektorfeldern und Erstellen einer Vektorabfrage.
Wenn Sie die neue Vorfilterfunktion verwenden möchten, müssen Sie einen Index verwenden, der nach 2023-10-01 erstellt wurde.
vectorSearchenthält Definitionen füralgorithms,profilesundvectorizers:algorithmsunterstützt weiterhinhnswund unterstützt jetzt aucheknn, in Bezug auf hierarchische Navigable Small World (HNSW) und erschöpfende K-nächste Nachbarn (eKNN). Im Abschnitt "Algorithmus" können Sie mehrere benannte Kombinationen von HNSW- und eKNN-Parametern definieren. Dadurch wirdalgorithmConfigurationsinnerhalb der eigenschaftvectorSearchin 2023-07-01-Preview ersetzt.profilesist eine neue Definition, die die Algorithmuskonfiguration angibt. Angenommen, Sie haben Algorithmuskonfigurationen namens HNSW-1, HSNW-2, eKNN-1. Ein Profil kann HNSW-1 angeben.vectorizerswird 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 das Ergebnis dann an die Suchmaschine für eine Vektorabfrage.
Bei Vektorfeldern ersetzt
vectorSearchProfilevectorSearchConfiguration. Die eigenschaftvectorSearchProfilegibt 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 API 2023-10-01-Preview in Ihrer Anforderung das Feld ändern, um eine
vectorSearchProfileanzugeben, solange das Profil den genauen Algorithmus angibt, der zuvor invectorSearchConfigurationangegeben wurde. Wenn beispielsweise die vorhandene Felddefinition"vectorSearchConfiguration": "myHnsw"angibt, müssen Sie sie durch"vectorSearchProfile": "your profile name"ersetzen, und das Profil muss definiert werden, um auf dasselbe"algorithm": "myHnsw"zu verweisen.
Dokumentedurchsuchen:
-
vectorQueriesersetztvectorsin 2023-07-01-Preview -
vectorQueries.vectorsersetztvectors.valuesin 2023-07-01-Preview. - Die Vektorabfrage ist jetzt eine polymorphe Struktur.
kindmuss 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 gibt an, ob eine vollständige (brute-force) k-nächste Nachbarsuche über alle Vektoren im Vektorindex hinweg erfolgen soll. -
vectorFilterModeist ein neuer Parameter zum Angeben der Vorfilterung (Standard für Indizes, die nach 2023-10-01 erstellt wurden) oder das Postfiltern (Standard für vorherige Indizes) in der Abfrage.
Ab dem 29. März 2024 geben GET-Antworten keine Verbindungszeichenfolgen oder Schlüssel mehr zurück. Weitere Informationen finden Sie unter Grundlegende Änderung für Clientcode, der Verbindungsinformationen liest.
2023-07-01-Vorschau
Wichtig
Verwenden Sie diese API-Version nicht. Die Einstellung dieser Vorschauversion wurde am 15. April 2024 angekündigt und wird nach dem 8. Juli 2024 nicht mehr unterstützt. Hilfe zur Migration finden Sie unter Upgrade REST-APIs in Azure AI Search.
Diese Version hat die Vektorunterstützung eingeführt und eine Vektorkonfiguration verwendet, die mit neueren API-Versionen nicht kompatibel ist.
- Ein
Collection(Edm.Single)Datentyp für Felder hinzugefügt, die ein Array mit Gleitkommazahlen mit einfacher Genauigkeit enthalten. Dies ist der Datentyp für Vektoren, der zum Speichern einer generierten Einbettung pro Dokumentfeld verwendet wird. Der Suchindex gibt auch Vektorkonfigurationseigenschaften an. Informationen zu diesen APIs finden Sie unter Erstellen oder Aktualisieren des Index-. - Die Indizierung von Workloads wurde aktualisiert, um Vektordaten zu akzeptieren. Siehe Hinzufügen, Aktualisieren oder Löschen von Dokumenten.
- Abfrageparameter für die Vektorsuche hinzugefügt. Diese Parameter finden Sie unter "Dokumente durchsuchen".
- Abrufen von Dienststatistiken: Gibt das Vektorindexkontingent und die Verwendung für den Dienst zurück.
- Indexstatistik abrufen: Gibt das Vektorindexkontingent und die Verwendung für den Suchindex zurück.
- Ab dem 29. März 2024 geben GET-Antworten keine Verbindungszeichenfolgen oder Schlüssel mehr zurück. Weitere Informationen finden Sie unter Grundlegende Änderung für Clientcode, der Verbindungsinformationen liest.
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 für das Verweisen auf Indizes in Abfrage- und Indizierungsanforderungen verwendet wird. Aliasvorgänge umfassen "Erstellen", "Aktualisieren", "Löschen", "Abrufen" und "Liste".
- Verwaltete Identitäten für ausgehende Verbindungen. Neue Werte für Verbindungszeichenfolgen in Erstellen oder Aktualisieren der Datenquelle Verbindungen mithilfe der Microsoft Entra ID-Authentifizierung und -Rollen anstelle von hartcodierten Datenbankanmeldeinformationen oder Schlüsseln unterstützen.
- Die Unterstützung für verwaltete Identitäten wird auch für Schlüsseltresorverbindungen unterstützt, für Suchlösungen, die die Standardverschlüsselung mit vom Kunden verwalteten Verschlüsselungergänzen.
- Weitere Sprachen für die kognitive Fähigkeit zur Textübersetzung.
- Weitere queryLanguages for semantic search and speller in Search Documents (preview).
- Ein Captions-Parameter zum optionalen Anfordern von Beschriftungen aus der semantischen Suche in Suchdokumente (Vorschau).
- Semantikkonfigurationen werden in Create or Update Indexangegeben. 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 Suchdokumente (Vorschau)erforderlich ist.
- Ab dem 29. März 2024 geben GET-Antworten keine Verbindungszeichenfolgen oder Schlüssel mehr zurück. Weitere Informationen finden Sie unter Grundlegende Änderung für Clientcode, der Verbindungsinformationen liest.
2020-06-30
Diese Version bietet allgemein verfügbare Features, einschließlich:
- Azure-rollenbasierte Zugriffssteuerung für Datenebenenvorgänge
- Relevanzbewertung (BM25)
- Wissensspeicher
- Indexer-Datenquelle für Azure Data Lake Storage (ADLS) Gen2
- Benutzerdefinierte Entitäts-Nachschlagefähigkeit
- Indexer, die unter einem System oder einer vom Benutzer verwalteten Identität über die Microsoft Entra-ID ausgeführt werden
- Ab dem 29. März 2024 geben GET-Antworten keine Verbindungszeichenfolgen oder Schlüssel mehr zurück. Weitere Informationen finden Sie unter Grundlegende Änderung für Clientcode, der Verbindungsinformationen liest.
2020-06-30-Preview
Diese Vorschauversion enthält alle Features, die in 2019-05-06-Preview eingeführt wurden, sowie die folgenden Ergänzungen:
- Semantische Suche, ein Premium-Feature, das auf Standardebenendiensten ausgeführt wird und die semantische Rangfolge aufruft.
- Indexer-Datenquelle für Power Query-Connectors
- Indexer-Datenquelle für MySQL
- Indexer-Datenquelle für Cosmos DB Gremlin-API
- Indexer-Datenquelle für SharePoint Online
- Normalizer-Eigenschaft für die Textnormalisierung, für Filterung, Faceting und Sortierung zwischen Groß- und Kleinschreibung
- Zurücksetzen von Dokumenten für indexerbasierte Indizierung, um bestimmte Dokumente anhand der ID speziell zu aktualisieren
- Entity Linking cognitive skill (v3)
- Kognitive Fähigkeiten der Entitätserkennung (v3)
- Kognitive Fähigkeiten der Stimmungsanalyse (v3)
- Ab dem 29. März 2024 geben GET-Antworten keine Verbindungszeichenfolgen oder Schlüssel mehr zurück. Weitere Informationen finden Sie unter Grundlegende Änderung für Clientcode, der Verbindungsinformationen liest.
2019-05-06-Preview
- Unterstützung der Indexer-Datenquelle für Cosmos DB MongoDB-API
- Indexer-Datenquelle für vorläufiges Löschen im Blob Storage
- featuresMode-Parameter, der detaillierte Informationen zu einer Relevanzbewertung zurückgibt
- Kognitive Fähigkeiten von Azure Machine Learning (AML)
- Erkennung kognitiver Fähigkeiten
- Zwischenspeichern von erweiterten Dokumenten zum Beibehalten und Wiederverwenden der Bildverarbeitung (und anderer KI-Anreicherungen)
- Ab dem 29. März 2024 geben GET-Antworten keine Verbindungszeichenfolgen oder Schlüssel mehr zurück. Weitere Informationen finden Sie unter Grundlegende Änderung für Clientcode, der Verbindungsinformationen liest.