Sdílet prostřednictvím

Verze rozhraní REST API (Azure AI Search)

  • Článek

Tento článek obsahuje seznam aktuálních a minulých verzí rozhraní REST API služby Search pro Azure AI Search.

Dokumentace k rozhraní API s verzí

Dokumentace k rozhraní REST API je teď ve verzi. Když otevřete referenční stránku rozhraní API, zobrazí se nad obsahem selektor verze. Ujistěte se, že odkaz na rozhraní API pochází ze složky Reference>Rovina dat.

snímek obrazovky se selektorem verze

Stabilní verze

Verze rozhraní API Specifikace Aktualizace rozhraní API
2024-07-01 (nejnovější) specifikace Swaggeru poznámky k verzi
2023-11-01 specifikace Swaggeru poznámky k verzi
2020-06-30 specifikace Swaggeru poznámky k verzi
2019-05-06 specifikace Swaggeru Přidá komplexní typy.

Verze Preview

Verze Preview se vydávají pro testování nových funkcí, získávání zpětné vazby a zjišťování a odstraňování problémů. Rozhraní API ve verzi Preview jsou k dispozici v dodatečných podmínkách použití pro verze Preview microsoft Azure.

Verze rozhraní API Specifikace Aktualizace rozhraní API
2024-11-01-preview (nejnovější) specifikace Swaggeru poznámky k verzi
2024-09-01-preview specifikace Swaggeru poznámky k verzi
2024-05-01-preview specifikace Swaggeru poznámky k verzi
2024-03-01-preview specifikace Swaggeru poznámky k verzi
2023-10-01-preview specifikace Swaggeru poznámky k verzi
2023-07-01-preview (zastaralé) specifikace Swaggeru poznámky k verzi
2021-04-30-preview specifikace Swaggeru poznámky k verzi
2020-06-30-preview specifikace Swaggeru poznámky k verzi
2019-05-06-preview specifikace Swaggeru poznámky k verzi

Poznámky

2024-11-01-preview

Tato verze Preview vychází z 2024-09-01-preview a zahrnuje všechny funkce , které jsou aktuálně ve verzi Preview. Můžete upgradovat z 2024-09-01-preview na 2024-11-01-preview s minimálními změnami kódu. Další informace najdete v tématu Upgrade rozhraní REST API.

Aktualizace Použitelné rozhraní REST API
Dotaz přepíše do sémantického rerankeru, který slouží ke zpřesnění dotazů odeslaných do rankeru L2. vlastnost Hledat dokumenty, nová vlastnost QueryRewritesType v požadavku.
dovednost rozložení dokumentu použitá k analýze dokumentu pro strukturu. vytvoření nebo aktualizace sady dovedností, nové dovednosti DocumentIntelligenceLayoutSkill.
Spravovaná identita pro připojení prostředku Azure AI s více službami. vytvoření nebo aktualizace sady dovedností, nová vlastnost AIServicesAccountIdentity.
režimu analýzy Markdownu, který se používá k indexování souborů Markdownu ve službě Azure Storage. vytvoření nebo aktualizace indexeru, nový markdown režim analýzy.
možnosti recoringu pro komprimované vektory, které se používají k bodování s původními vektory místo komprimovaných vektorů. Platí pro HNSW a vyčerpávající vektorové algoritmy KNN pomocí binární a skalární komprese. vytvořit nebo aktualizovatindexu , nové vlastnosti rescoringOptions. Nová vlastnost enableRescoring se mapuje na rerankWithOriginalVectors představené v roce 2024-03-01-preview.

2024-09-01-preview

Tato verze Preview vychází z 2024-05-01-preview a zahrnuje všechny funkce , které jsou aktuálně ve verzi Preview. Můžete upgradovat z 2024-05-01-preview na 2024-09-01-preview bez nutnosti změn kódu. Další informace najdete v tématu Upgrade rozhraní REST API.

Aktualizace Použitelné rozhraní REST API
zkrácené rozměry pro kvantování mrL (Text Embedding-3-small) a 3-large models retrained on Matryoshka Representation Learning (MRL). vytvoření nebo aktualizaceindexu , nový parametr truncationDimension
Dílčí jádra nebo podrobnosti bodování pro rozbalení výsledků hybridního hledání skóre podle Reciproční Rank Fusion (RRF). hledání dokumentů, nové ladění definice parametru a podscore dotazu v odpovědi.
Cílení filtrování na vektorovou část hybridního vyhledávacího dotazu. Hledat dokumenty, nový filterOverride parametr v RawVectorQuery, VectorizableTextQuery, VectorizableImageUrlQuery, VectorizableImageBinaryQuery.
Vytváření bloků tokenů v Dovednosti Rozdělit text, místo jen znaků. vytvoření nebo aktualizace sady dovedností, nové jednotky parametr a další vlastnosti související s tokeny.

2024-07-01

Tato verze poskytuje obecně dostupné aktualizace pro integrovanou vektorizaci (dovednosti a vektorizátory), skalární kvantování a binární kvantování. Podrobnosti najdete v tématu Co je nového ve službě Azure AI Search.

Aktualizace Použitelné rozhraní REST API
Obecně dostupné – vektorové datové typy vytvoření nebo aktualizace indexu
Obecně dostupné – vlastnosti kvantování vektoru pro předdefinované skalární nebo binární kvantování v indexu vyhledávání. vytvoření nebo aktualizace indexu
Obecně dostupná – uložená vlastnost v vektorovém poli, která určuje, zda je uložena další kopie pole. Další kopií je obsah tohoto pole, který lze načíst. Pokud ho neukládáte, pole se stále používá v dotazech, ale nejde ho vrátit ve výsledku hledání. Tuto vlastnost můžete nastavit tak, aby se ušetřilo místo ve vyhledávací službě nebo kvótě vektorů v indexu vyhledávání. vytvoření nebo aktualizace indexu
Obecně dostupné – VectorizableTextQuery parametry pro ladění relevance. Parametry hybridního dotazu (MaxTextSizeRecall) jsou stále ve verzi Preview. prohledat dokumenty
Obecně dostupné – schopnost AzureOpenAIEmbedding podporovat více modelů než jen vkládání textu ada-002 pro integrovanou vektorizaci během indexování. Nastavte název modelu a vlastnosti dimenzí tak, aby cílily na konkrétní model. vytvoření nebo aktualizace sady dovedností
Obecně dostupné – vektorizátor vkládání Azure OpenAI pro integrované vektorizace během dotazů. Vektorizační vlastnosti podporují více modelů. vytvoření nebo aktualizace indexu
Platnost od 29. března 2024: Odpovědi GET už nevrací připojovací řetězce ani klíče. Podrobnosti najdete v tématu Zásadní změna kódu klienta, který čte informace o připojení. Všechny verze

2024-05-01-preview

Tato verze Preview přidává podporu indexování OneLake, ladění relevance a hlubší integraci s více vloženými modely během indexování a dotazů. Staví na 2024-03-01-preview a zahrnuje všechny funkce, které jsou aktuálně ve verzi Preview.

Pokud chcete upgradovat z 2024-03-01-preview nebo 2023-10-01-preview, aktualizujte dovednost nebo vektorizátor AzureOpenAIEmbedding tak, aby zahrnoval název a rozměry modelu. Pokud chcete upgradovat z 2023-07-01-preview (zastaralé) nebo podrobné pokyny, přečtěte si článek upgrade rozhraní REST API.

Tady jsou aktualizace v této verzi Preview. Doporučujeme také Novinky ve službě Azure AI Search.

Aktualizace Použitelné rozhraní REST API
Zdroj dat Indexeru pro soubory a klávesové zkratky OneLake vytvoření nebo aktualizace zdroje dat
Collection(Edm.Byte), binární datový typ pro vkládání modelů, které je podporují. Definice vektorových polí podporují tento datový typ. vytvoření nebo aktualizace indexu
Více vektorových a hybridních parametrů dotazu pro ladění relevance Nastavte prahové hodnoty pro vyloučení výsledků s nízkým skóre. Váhový vektorový dotaz. U hybridních dotazů nastavte maximální počet dokumentů, které se mají načíst v textové části hybridního dotazu. prohledat dokumenty
Nová dovednost Azure AI Vision pro multimodální integrovanou vektorizaci během indexování Tato dovednost volá multimodální rozhraní API služby Azure AI Vision. vytvoření nebo aktualizace sady dovedností
Nový vektorizátor Azure AI Vision pro vícemodální dotazy Vektorizátor je určen v definicích indexu, ale používá se během provádění dotazu. vytvoření nebo aktualizace indexu
Aktualizace dovednosti AzureOpenAIEmbedding pro podporu více modelů než jen vkládání textu-ada-002 pro integrovanou vektorizaci během indexování. Nastavte název modelu a vlastnosti dimenzí tak, aby cílily na konkrétní model. vytvoření nebo aktualizace sady dovedností
Aktualizace vektorizátoru vkládání Azure OpenAI pro integrované vektorizace během dotazů Vektorizační vlastnosti podporují více modelů. vytvoření nebo aktualizace indexu
Platnost od 29. března 2024: Odpovědi GET už nevrací připojovací řetězce ani klíče. Podrobnosti najdete v tématu Zásadní změna kódu klienta, který čte informace o připojení. Všechny verze

2024-03-01-preview

Tato verze Preview vychází z 2023-10-01-preview přidáním rozhraní API ve verzi Preview, která vylepšují úložiště vektorů. Podrobnosti najdete v tématu Co je nového ve službě Azure AI Search.

Aktualizace Použitelné rozhraní REST API
Nové úzkých datových typů pro vektorová pole, pokud máte vložené modely, které je podporují, nebo logiku kvantování, která vypíše menší vektory. vytvoření nebo aktualizace indexu
Nové vlastnosti kvantování vektorů pro integrovanou kompresi vektorů v indexu vyhledávání. vytvoření nebo aktualizace indexu
Nová logická uložená vlastnost v vektorovém poli, která určuje, zda je uložena další kopie pole. Další kopií je obsah tohoto pole, který lze načíst. Pokud ho neukládáte, pole se stále používá v dotazech, ale nejde ho vrátit ve výsledku hledání. Tuto vlastnost můžete nastavit tak, aby se ušetřilo místo ve vyhledávací službě nebo kvótě vektorů v indexu vyhledávání. vytvoření nebo aktualizace indexu
Platnost od 29. března 2024: Odpovědi GET už nevrací připojovací řetězce ani klíče. Podrobnosti najdete v tématu Zásadní změna kódu klienta, který čte informace o připojení. Všechny verze

2023-11-01

Tato verze poskytuje obecně dostupné funkce. Podrobnosti najdete v tématu Co je nového ve službě Azure AI Search.

Aktualizace Použitelné rozhraní REST API
Sémantické řazení v žádostech vyhledávacího příspěvku prohledat dokumenty
Konfigurace vektoru vyhledávání vektorů pro pole vektoru indexování vytvoření nebo aktualizace indexu
Vektorové dotazy v požadavcích Vyhledávacího příspěvku prohledat dokumenty
Platnost od 29. března 2024: Odpovědi GET už nevrací připojovací řetězce ani klíče. Podrobnosti najdete v tématu Zásadní změna kódu klienta, který čte informace o připojení. Všechny verze

2023-10-01-preview

Tato verze zahrnuje všechny funkce představené v předchozích verzích Preview a navíc doplňky a úpravy rozhraní API pro vektorové vyhledávání. Aktualizace rozhraní API pro vektorové vyhledávání představují zásadní změnu z verze 2023-07-01-Preview. Nápovědu k migraci najdete v tématu Přidání vektorových polí a Vytvoření vektorového dotazu.

Pokud plánujete používat novou funkci předběžného filtrování, musíte použít index vytvořený po 2023-10-01.

vytvoření nebo aktualizaceindexu:

  • vectorSearch obsahuje definice pro algorithms, profilesa vectorizers:

    • algorithms nadále podporuje hnsw a nyní také podporuje eknn, v odkazech na Hierarchical Navigable Small World (HNSW) a vyčerpávající K-nejbližší sousedy (eKNN). V části algoritmu můžete definovat více pojmenovaných kombinací parametrů HNSW a eKNN. Tím se nahradí algorithmConfigurations v vectorSearch vlastnosti v roce 2023-07-01-Preview.

    • profiles je nová definice, která určuje konfiguraci algoritmu. Předpokládejme například, že máte konfigurace algoritmů s názvem HNSW-1, HSNW-2, eKNN-1. Profil může určovat HNSW-1.

    • vectorizers je definována v indexu, ale používá se v době dotazu k vložení textového řetězce dotazu. Vektorizátor odkazuje na vložený model. Vyhledávací služba volá model vkládání, který vektorizuje textový řetězec dotazu, a výsledek pak předá vyhledávacímu stroji pro vektorový dotaz.

  • U vektorových polí vectorSearchProfile nahradí vectorSearchConfiguration. Vlastnost vectorSearchProfile určuje, který profil vektorového vyhledávání se má v poli použít.

  • U indexů vytvořených před touto verzí rozhraní API musíte při volání rozhraní API 2023-10-01-Preview v požadavku změnit pole tak, aby zadalo vectorSearchProfile, pokud profil určuje přesně stejný algoritmus zadaný v vectorSearchConfiguration. Pokud například existující definice pole určuje "vectorSearchConfiguration": "myHnsw", je nutné jej nahradit "vectorSearchProfile": "your profile name"a profil musí být definován tak, aby odkaz na stejný "algorithm": "myHnsw".

prohledat dokumenty:

  • vectorQueries nahrazuje vectors ve verzi 2023-07-01-Preview.
  • vectorQueries.vectors nahradí vectors.values ve verzi 2023-07-01-Preview.
  • Vektorový dotaz je nyní polymorfní struktura. kind musí být zadán, aby bylo možné označit požadovaný typ vektorového dotazu. "kind": "vector" znamená, že dotaz je vektor, takže volající by už měl vektorizovat řetězec vyhledávacího dotazu do vektorového vkládání.
  • "exhaustive": "true" je nová vlastnost určuje, zda provést vyčerpávající (hrubou silou) k-nejbližší soused hledání napříč všemi vektory v indexu vektoru.
  • vectorFilterMode je nový parametr pro určení předběžného filtrování (výchozí nastavení pro indexy vytvořené po 2023-10-01) nebo postfiltering (výchozí nastavení u předchozích indexů) v dotazu.

Platnost od 29. března 2024: Odpovědi GET už nevrací připojovací řetězce ani klíče. Podrobnosti najdete v tématu Zásadní změna kódu klienta, který čte informace o připojení.

2023-07-01-preview

Důležitý

Tuto verzi rozhraní API nepoužívejte. Vyřazení této verze Preview bylo oznámeno 15. dubna 2024 a už není podporováno po 8. červenci 2024. Nápovědu k migraci najdete v tématu Upgrade rozhraní REST API ve službě Azure AI Search.

Tato verze zavedla podporu vektorů a používá konfiguraci vektoru, která není kompatibilní s novějšími verzemi rozhraní API.

2021-04-30-preview

Tato verze Preview obsahuje všechny funkce představené ve verzi 2020-06-30-Preview a navíc k následujícím rozhraním API:

2020-06-30

Tato verze poskytuje obecně dostupné funkce, mezi které patří:

  • Řízení přístupu na základě role v Azure pro operace roviny dat
  • Vyhodnocování relevance (BM25)
  • Úložiště znalostí
  • Zdroj dat indexeru pro Azure Data Lake Storage (ADLS) Gen2
  • Dovednost vlastního vyhledávání entit
  • Indexery spuštěné v rámci systémové nebo uživatelem spravované identity prostřednictvím Microsoft Entra ID
  • Platnost od 29. března 2024: Odpovědi GET už nevrací připojovací řetězce ani klíče. Podrobnosti najdete v tématu Zásadní změna kódu klienta, který čte informace o připojení.

2020-06-30-preview

Tato verze Preview zahrnuje všechny funkce představené v 5. 5. 06. 2019 a následující dodatky:

  • Sémantické vyhledávání, prémiová funkce, která běží na službách úrovně Standard a vyvolává sémantické hodnocení.
  • Zdroj dat indexeru pro konektory Power Query
  • Zdroj dat indexeru pro MySQL
  • Zdroj dat indexeru pro rozhraní Gremlin API služby Cosmos DB
  • Zdroj dat indexeru pro SharePoint Online
  • Normalizační vlastnost pro normalizaci textu, pro filtrování bez rozlišování velkých a malých písmen, fasetování a řazení
  • Resetování dokumentů pro indexerové indexování, aby se konkrétně aktualizovaly konkrétní dokumenty podle ID
  • Kognitivní dovednost Propojování entit (v3)
  • Kognitivní dovednost rozpoznávání entit (v3)
  • Kognitivní dovednost analýzy mínění (v3)
  • Platnost od 29. března 2024: Odpovědi GET už nevrací připojovací řetězce ani klíče. Podrobnosti najdete v tématu Zásadní změna kódu klienta, který čte informace o připojení.

2019-05-06-preview

  • Podpora zdroje dat indexeru pro rozhraní MongoDB API služby Cosmos DB
  • Zdroj dat indexeru pro obnovitelné odstranění ve službě Blob Storage
  • featuresMode – parametr, který vrací podrobné informace o skóre relevance
  • Kognitivní dovednost služby Azure Machine Learning (AML)
  • Kognitivní dovednost rozpoznávání osobní identifikace
  • Ukládání obohacených dokumentů do mezipaměti za účelem zachování a opakovaného použití zpracování obrázků (a dalších obohacení AI)
  • Platnost od 29. března 2024: Odpovědi GET už nevrací připojovací řetězce ani klíče. Podrobnosti najdete v tématu Zásadní změna kódu klienta, který čte informace o připojení.

Viz také