Azure AI Search REST API-referencia
Azure AI Search (korábbi nevén Azure Cognitive Search) egy teljes körűen felügyelt felhőbeli keresési szolgáltatás, amely a felhasználó tulajdonában lévő tartalmakon keresztül nyújt információt.
Az adatsík REST API-jait indexelési és lekérdezési munkafolyamatokhoz használjuk, és ebben a szakaszban dokumentáljuk.
A szolgáltatásfelügyelet vezérlősík-műveleteit egy külön Felügyeleti REST APIfedi le.
Verziószámozott API-dokumentumok
A REST API-dokumentumok már verziószámozottak. Amikor megnyit egy API-referencialapot, megjelenik egy verzióválasztó a tartalomjegyzék felett. Győződjön meg arról, hogy az API-referencia a Referencia > Adatsík mappából származik.
Főbb fogalmak
Az Azure AI Search keresési szolgáltatások, indexek, dokumentumok, indexelők, adatforrások, képességkészletekés szinonimatérképek.
- A keresési szolgáltatás indexeket, indexelőket, adatforrásokat, képességkészleteket és szinonimákat tárol legfelső szintű objektumokként.
- A keresési index állandó tárterületet biztosít a keresési dokumentumokhoz. A keresési dokumentumok a mezők gyűjteményeként tagolt, külső forrásokból betöltött és indexbe leküldött adatok, hogy kereshetőek legyenek.
- A keresési indexelő automatizálást ad hozzá, natív formátumban olvas adatokat, és szerializálja őket JSON-ra.
- Az indexelő adatforrással rendelkezik, és egy indexre mutat.
- Az indexelők olyan képességkészlettel is rendelkezhetnek, amely MI-bővítési és integrált vektorizációs az indexelési folyamathoz. A képességkészletek mindig indexelőhöz vannak csatolva. Gépi tanulást indítanak szöveg kinyerésére vagy darabolására, tartalom vektorizálására, szolgáltatások következtetésére vagy szerkezet hozzáadására a tartalomhoz a keresési szolgáltatás által történő jobb indexelés érdekében.
Összességében a következő objektumokat hozhatja létre egy keresési szolgáltatásban:
Objektumok | Leírás |
---|---|
Adatforrások | Az indexelő által az indexeléshez használt dokumentumok lekéréséhez és frissítéséhez használt adatforrás-kapcsolat. Az adatforrások type rendelkeznek. Használhatja a Microsoft által biztosított kapcsolatokat az Azure-hoz vagy partnerösszekötőkhöz. A teljes lista Adatforrások gyűjtemény. |
Dokumentumok | A dokumentum elméletileg egy entitás az indexben. Ezt a fogalmat jobban ismert adatbázis-megfelelőkre kell leképeznie: a keresési indexek egy táblával egyenértékűek, a dokumentumok pedig nagyjából egyenértékűek a tábla soraival. A dokumentumok csak egy indexben léteznek, és csak az index dokumentumgyűjteményét (/docs ) megcélzott lekérdezésekkel kérik le. A gyűjteményen végrehajtott összes művelet, például a dokumentumok feltöltése, egyesítése, törlése vagy lekérdezése egyetlen index kontextusában történik, így az URL-formátum dokumentumműveletei mindig tartalmazzák az adott indexnév /indexes/[index name]/docs . |
Indexek | Az indexek a keresési szolgáltatásban vannak tárolva, és JSON-dokumentumokkal vannak feltöltve, amelyek indexeltek és jogkivonatosak az információk lekéréséhez. Az index mezőgyűjteménye határozza meg a keresési dokumentum struktúráját. A mezők névvel, adattípusokkal és attribútumokkal rendelkeznek, amelyek meghatározzák a használatot. A searchable mezők például teljes szöveges keresésben használatosak, és így tokenizálva vannak az indexelés során. Az index más szerkezeteket is meghatároz, például pontozási profilokat a relevanciahangoláshoz, javaslattevőket, szemantikai konfigurációkat és egyéni elemzőket. |
Indexelők | Az indexelők biztosítják az indexelés automatizálását. Az indexelő csatlakozik egy adatforráshoz, beolvassa az adatokat, és átadja azt egy keresőmotornak, hogy indexeljen egy célkeresési indexbe. Az indexelők egy külső forrásból olvasnak egy adatforrás kapcsolati adataival, és szerializálják a bejövő adatokat JSON-keresési dokumentumokba. Az adatforráson kívül az indexelőknek indexre is szükség van. Az index a keresési dokumentumok mezőit és attribútumait határozza meg. |
Készségkészletek | A képességkészlet külső feldolgozási lépéseket ad hozzá az indexelők végrehajtásához, és AI- vagy mélytanulási modellek alkalmazásával elemzi vagy átalakítja a tartalmakat az indexek jobb kereshetősége érdekében. A készségkészlet tartalma egy vagy több készség, amely a Microsoft által létrehozott beépített készségeket, egyéni készségeket vagy mindkettő kombinációját. Beépített képességek léteznek a képelemzéshez, beleértve az OCR-t és a természetes nyelvi feldolgozást. A beépített képességek további példái közé tartozik többek között az entitásfelismerés, a kulcskifejezések kinyerése, a szöveg logikai oldalakba való beírása. A képességkészletek olyan magas szintű önálló objektumok, amelyek indexekkel, indexelőkkel és adatforrásokkal egyenértékű szinten léteznek, de csak az indexelő feldolgozása során működnek. Magas szintű objektumként egyszer tervezhet meg egy készségkészletet, majd hivatkozhat rá több indexelőben. |
Szinonimák térképei | A szinonimák leképezése szolgáltatásszintű objektum, amely felhasználó által definiált szinonimákat tartalmaz. Ez az objektum a keresési indexektől függetlenül marad fenn. A feltöltés után bármely kereshető mezőt a szinonimatérképre irányíthat (mezőnként egyet). |
Engedélyek és hozzáférés-vezérlés
Kulcsalapú hitelesítést vagy szerepköralapú hitelesítést használhat a Microsoft Entra-azonosítón keresztül.
kulcsalapú hitelesítés a keresési szolgáltatáshoz létrehozott API-kulcsokra támaszkodik. Az érvényes kulcs kérésenként megbízhatóságot hoz létre a kérelmet küldő alkalmazás és az azt kezelő szolgáltatás között. A Felügyeleti API-kulcs írási műveletekhez, illetve Lekérdezési API-kulcs használható a keresési index dokumentumgyűjteményéhez való olvasási hozzáféréshez.
Microsoft Entra ID-hitelesítés és szerepköralapú hozzáférés-vezérlési megköveteli, hogy rendelkezik egy létrehozott bérlővel a Microsoft Entra ID-ban, biztonsági tagokkal és szerepkör-hozzárendelésekkel. Az alábbi szerepkörök tagjai adatsík-hozzáféréssel rendelkeznek. Egyéni szerepköröket akkor hozhat létre, ha a beépített szerepkörök nem elegendőek.
Szerep Hozzáférés Keresési szolgáltatás közreműködője Hozzáférés az objektumokhoz, de nincs hozzáférés az index tartalmához. Ez a szerepkör létrehoz egy keresési indexet és más legfelső szintű objektumokat, de nem tud lekérdezni egy keresési indexet, és nem tud dokumentumokat hozzáadni, eltávolítani vagy frissíteni a keresési indexekben. Ez a szerepkör olyan fejlesztőknek szól, akik objektumdefiníciókat hoznak létre, frissítenek és törölnek. Emellett olyan rendszergazdáknak is, akiknek kezelni kell az objektumokat, de nem tudják megtekinteni vagy elérni az objektumadatokat. Keresési adatindex közreműködője Olvasási-írási hozzáférés az indextartalmakhoz. Ez a szerepkör azoknak a fejlesztőknek vagy indextulajdonosoknak szól, akiknek importálni, frissíteniük vagy le kell kérdezniük egy index dokumentumgyűjteményét. Keresési adatindex-olvasó Olvasási hozzáférés az index tartalmához. Ez a szerepkör a lekérdezéseket futtató alkalmazások és felhasználók számára készült.
Amikor szerepköröket használ a kapcsolaton, az ügyfélalkalmazás egy tulajdonosi jogkivonatot jelenít meg az engedélyezési fejlécben. Ha segítségre van szüksége a beállításhoz, tekintse meg Keresési alkalmazáshoz való hozzáférés engedélyezése a Microsoft Entra-azonosítóval.
Letilthatja a kulcsalapú hitelesítést vagy a szerepköralapú hitelesítést. Ha letiltja a szerepköralapú hitelesítést, az csak az adatsík-műveletekre vonatkozik. A vezérlősík-műveletek, például a szolgáltatásfelügyelet, mindig szerepköralapú hitelesítést használnak. Részletekért tekintse meg Microsoft Entra-azonosító hitelesítését és szerepköralapú hozzáférés-vezérlését az Azure AI Search.
Az API-k meghívása
Az ebben a szakaszban dokumentált API-k hozzáférést biztosítanak a keresési adatokon végzett műveletekhez, például az indexek létrehozásához és populációjához, a dokumentumok feltöltéséhez és a lekérdezésekhez. API-k hívásakor tartsa szem előtt a következő szempontokat:
A kérelmeket HTTPS-en keresztül kell kiállítani (az alapértelmezett 443-as porton).
A kérelem URI-jainak tartalmazniuk kell az api-verzió. Az értéket egy támogatott verzióra kell állítani, a példában látható módon formázva:
GET https://[search service name].search.windows.net/indexes?api-version=2023-11-01
kérelemfejléceknek tartalmazniuk kell egy api-kulcsú vagy egy tulajdonosi jogkivonatot a hitelesített kapcsolatokhoz. Tetszés szerint beállíthatja a HTTP-fejléc elfogadása lehetőséget. Ha a tartalomtípus fejléce nincs beállítva, a rendszer feltételezi, hogy az alapértelmezett érték
application/json
.