Referenční informace k rozhraní REST API Search Azure AI
Azure AI Search (dříve označovaná jako Azure Cognitive Search) je plně spravovaná cloudová vyhledávací služba, která poskytuje načítání informací z obsahu vlastněného uživatelem.
Rozhraní REST API roviny dat se používají k indexování a dotazování pracovních postupů a jsou zdokumentována v této části.
K operacím řídicí roviny se přistupuje prostřednictvím samostatného rozhraní REST API pro správu.
Dokumentace k rozhraní API s verzemi
Dokumentace k rozhraní REST API je teď ve verzích. Když otevřete stránku s referenčními informacemi k rozhraní API, zobrazí se nad obsahem selektor verzí. Ujistěte se, že odkaz na rozhraní API pochází ze složky Referenční > rovina dat .
Klíčové koncepty
Azure AI Search má koncepty vyhledávacích služeb, indexů, dokumentů, indexerů, zdrojů dat, sad dovedností a map synonym.
- Vyhledávací služba hostuje indexy, indexery, zdroje dat, sady dovedností a mapy synonym jako objekty nejvyšší úrovně.
- Index vyhledávání poskytuje trvalé úložiště dokumentů hledání. Search dokumenty jsou vaše data, artikulovaná jako kolekce polí, načtená z externích zdrojů a vložená do indexu, aby byla prohledávatelná.
- Indexer vyhledávání přidává automatizaci, čte data v nativních formátech a serializuje je do formátu JSON.
- Indexer má zdroj dat a odkazuje na index.
- Indexer může mít také sadu dovedností, která do kanálu indexování přidává rozšiřování AI a integrovanou vektorizaci . Sady dovedností jsou vždy připojeny k indexeru. Volají strojové učení, aby extrahovali nebo blokovali text, vektorizovali obsah, odvozovali funkce nebo přidávali strukturu k obsahu, aby ho bylo možné indexovat vyhledávací službou.
Celkem můžete ve vyhledávací službě vytvořit následující objekty:
| Objekty | Description |
|---|---|
| Zdroje dat | Připojení ke zdroji dat používané indexerem k načtení a aktualizaci dokumentů pro indexování. Zdroje dat mají type. Můžete použít připojení poskytovaná Microsoftem pro Azure nebo konektory třetích stran prostřednictvím partnerů. Úplný seznam najdete v galerii zdrojů dat . |
| dokumenty. | Koncepčně je dokument entitou v indexu. Mapování tohoto konceptu na známější ekvivalenty databáze: vyhledávací index odpovídá tabulce a dokumenty jsou zhruba ekvivalentní řádkům v tabulce. Dokumenty existují pouze v indexu a načítají se pouze prostřednictvím dotazů, které cílí na kolekci dokumentů (/docs) indexu. Všechny operace prováděné s kolekcí, jako je nahrávání, slučování, odstraňování nebo dotazování dokumentů, probíhají v kontextu jednoho indexu, takže operace s dokumentem formátu adresy URL budou vždy zahrnovat /indexes/[index name]/docs daný název indexu. |
| Indexy | Index je uložený ve vyhledávací službě a naplněný dokumenty JSON, které jsou indexovány a tokenizovány pro načtení informací. Kolekce polí indexu definuje strukturu hledaného dokumentu. Pole mají název, datové typy a atributy, které určují, jak se používají. Například searchable pole se používají při fulltextové vyhledávání, a proto se tokenizují během indexování. Index také definuje další konstrukce, jako jsou profily hodnocení pro ladění relevance, návrhy, sémantické konfigurace a vlastní analyzátory. |
| Indexery | Indexery zajišťují automatizaci indexování. Indexer se připojí ke zdroji dat, načte data a předá je vyhledávacímu webu pro indexování do cílového vyhledávacího indexu. Indexery čtou z externího zdroje pomocí informací o připojení ve zdroji dat a serializují příchozí data do dokumentů vyhledávání JSON. Kromě zdroje dat vyžaduje index také index. Index určuje pole a atributy dokumentů hledání. |
| Sady dovedností | Sada dovedností přidává kroky externího zpracování ke spuštění indexeru a obvykle se používá k přidání modelů AI nebo hlubokého učení, které analyzují nebo transformují obsah, aby bylo možné ho prohledávat v indexu. Obsahem sady dovedností je jedna nebo více dovedností, které můžou být předdefinované dovednosti vytvořené Microsoftem, vlastní dovednosti nebo kombinace obou dovedností. Existují integrované dovednosti pro analýzu obrázků, včetně OCR, a zpracování přirozeného jazyka. Mezi další příklady integrovaných dovedností patří rozpoznávání entit, extrakce klíčových frází, dělení textu na logické stránky a další. Sada dovedností je samostatný objekt vysoké úrovně, který existuje na úrovni ekvivalentní indexům, indexerům a zdrojům dat, ale je funkční pouze v rámci zpracování indexeru. Jako objekt vysoké úrovně můžete jednou navrhnout sadu dovedností a pak na ni odkazovat ve více indexerech. |
| Mapy synonym | Mapa synonym je objekt na úrovni služby, který obsahuje uživatelem definovaná synonyma. Tento objekt se udržuje nezávisle na indexech vyhledávání. Po nahrání můžete na mapu synonym nasměrovat libovolné prohledávatelné pole (jedno na každé pole). |
Oprávnění a řízení přístupu
Pomocí Microsoft Entra ID můžete použít ověřování založené na klíčích nebo na rolích.
Ověřování na základě klíčů závisí na klíčích rozhraní API vygenerovaných pro vyhledávací službu. Platný klíč vytváří na základě žádosti vztah důvěryhodnosti mezi aplikací, která žádost odeslala, a službou, která ji zpracovává. Pro operace čtení a zápisu můžete použít klíč rozhraní API Správa nebo klíč rozhraní API pro dotazy pro přístup pro čtení ke kolekci dokumentů indexu vyhledávání.
Microsoft Entra ID ověřování a řízení přístupu na základě role vyžaduje, abyste měli v Microsoft Entra ID vytvořeného tenanta s objekty zabezpečení a přiřazeními rolí. Členové následujících rolí mají přístup k rovině dat. Pokud předdefinované role nejsou dostatečné, můžete vytvořit vlastní role.
Role Access Přispěvatel služby Search Přístup k objektům, ale bez přístupu k obsahu indexu Tato role nemůže dotazovat vyhledávací index ani přidávat, odebírat nebo aktualizovat dokumenty ve vyhledávacím indexu. Tato role je určená správcům, kteří potřebují spravovat objekty, ale nemají možnost zobrazovat nebo přistupovat k datům objektů. Search Přispěvatel indexu dat Přístup pro čtení a zápis k obsahu indexu. Tato role je určená pro vývojáře nebo vlastníky indexů, kteří potřebují importovat, aktualizovat nebo dotazovat kolekci dokumentů indexu. Search čtečka indexů dat Přístup pro čtení obsahu indexu. Tato role je určená pro aplikace a uživatele, kteří spouštějí dotazy.
Při použití rolí pro připojení klientská aplikace zobrazí v autorizační hlavičce nosný token. Nápovědu k tomuto nastavení najdete v tématu Autorizace přístupu k vyhledávací aplikaci pomocí Microsoft Entra ID.
Můžete zakázat ověřování na základě klíčů nebo ověřování na základě rolí. Pokud zakážete ověřování na základě rolí, budou mít některé předdefinované role stále přístup. Podrobnosti najdete v tématu ověřování Microsoft Entra ID a řízení přístupu na základě role pro Search Azure AI.
Volání rozhraní API
Rozhraní API zdokumentovaná v této části poskytují přístup k operacím s daty vyhledávání, jako je vytváření indexů a populace, nahrávání dokumentů a dotazy. Při volání rozhraní API mějte na paměti následující body:
Požadavky musí být vydávány přes HTTPS (na výchozím portu 443).
Identifikátory URI požadavků musí obsahovat api-version. Hodnota musí být nastavená na podporovanou verzi ve formátu, jak je znázorněno v tomto příkladu:
GET https://[search service name].search.windows.net/indexes?api-version=2020-06-30Hlavičky požadavků musí obsahovat klíč rozhraní API nebo nosný token pro ověřená připojení. Volitelně můžete nastavit hlavičku Přijmout HTTP. Pokud hlavička typu obsahu není nastavená, předpokládá se, že výchozí hodnota je
application/json.