Megosztás a következőn keresztül:

Egyéni webes API-vektorizáló

  • Cikk

Fontos

Ez a funkció nyilvános előzetes verzióban érhető el a kiegészítő használati feltételek alatt. A 2023-10-01-Preview REST API és az összes újabb előzetes REST API támogatja ezt a funkciót.

Az egyéni webes API-vektorizálóval konfigurálhatja a keresési lekérdezéseket úgy, hogy egy webes API-végpontra hívjanak fel beágyazásokat a lekérdezési időpontban. A JSON-hasznos adatoknak a megadott végponton való implementálásához szükséges struktúráját ebben a dokumentumban részletesebben ismertetjük. Az adatok feldolgozása a Geo-ban történik, ahol a modell üzembe van helyezve.

Vektorizáló paraméterek

A paraméterek megkülönböztetik a kis- és nagybetűket.

Paraméter neve Leírás
uri Annak a webes API-nak az URI-ja, amelyre a JSON hasznos adatokat küldi. Csak a https URI-séma engedélyezett.
httpMethod A hasznos adatok küldése során használandó módszer. Az engedélyezett metódusok PUTPOST
httpHeaders Kulcs-érték párok gyűjteménye, ahol a kulcsok fejlécneveket, az értékeket pedig a webes API-nak küldött fejlécértékeket és a hasznos adatokat jelölik. A következő fejlécek nem szerepelnek ebben a gyűjteményben: Accept, , Accept-CharsetAccept-Encoding, Content-Length, Content-Type, Cookie, HostTEUpgradeVia.
authResourceId (Nem kötelező) Egy sztring, amely ha be van állítva, azt jelzi, hogy ennek a vektorizálónak felügyelt identitást kell használnia a kódot üzemeltető függvényhez vagy alkalmazáshoz való kapcsolaton. Ez a tulajdonság az alkalmazás (ügyfél) azonosítóját vagy az alkalmazás Microsoft Entra-azonosítóban való regisztrációját használja támogatott formátumban: api://<appId>. Ez az érték az indexelő által lekért hitelesítési jogkivonat hatókörére szolgál, és az egyéni webes API-kéréssel együtt elküldi a függvénynek vagy alkalmazásnak. A tulajdonság beállításához a keresési szolgáltatásnak konfigurálnia kell a felügyelt identitást , az Azure-függvényalkalmazás pedig a Microsoft Entra-bejelentkezéshez van konfigurálva.
authIdentity (Nem kötelező) A keresőszolgáltatás által a kódot üzemeltető függvényhez vagy alkalmazáshoz való csatlakozáshoz használt, felhasználó által felügyelt identitás. Rendszer- vagy felhasználó által felügyelt identitást is használhat. Rendszerszintű identitás használatához hagyja authIdentity üresen.
timeout (Nem kötelező) Ha meg van adva, az API-hívást kezdeményező HTTP-ügyfél időtúllépését jelzi. XSD "dayTimeDuration" értékként kell formázni (az ISO 8601 időtartamérték korlátozott részhalmaza). Például PT60S 60 másodpercig. Ha nincs beállítva, a rendszer 30 másodperces alapértelmezett értéket választ. Az időtúllépés legfeljebb 230 másodpercre és legalább 1 másodpercre állítható be.

Támogatott vektoros lekérdezéstípusok

A Custom Web API vektorosítója támogatja texta imageBinary vektoros imageUrllekérdezéseket.

Mintadefiníció

"vectorizers": [
    {
        "name": "my-custom-web-api-vectorizer",
        "kind": "customWebApi",
        "customWebApiParameters": {
            "uri": "https://contoso.embeddings.com",
            "httpMethod": "POST",
            "httpHeaders": {
                "api-key": "0000000000000000000000000000000000000"
            },
            "timeout": "PT60S",
            "authResourceId": null,
            "authIdentity": null
        },
    }
]

JSON hasznos adatstruktúra

A végpontok számára az egyéni webes API-vektorizálóval való használathoz szükséges JSON hasznos adatstruktúra megegyezik az egyéni webes API-képességével, amelyet a képesség dokumentációjában részletesebben is bemutatunk.

A webes API-végpontok egyéni webes API-vektorizálóval való használatához az alábbi egyéb szempontokat kell figyelembe venni.

  • A vektorizáló egyszerre csak egy rekordot küld a tömbben, values amikor kérést küld a végpontnak.

  • A vektorizáló átadja a vektorizálandó adatokat a kérelem hasznos adategységében lévő data JSON-objektum egy adott kulcsában. Ez a kulcs , textimageUrlvagy imageBinaryattól függően, hogy milyen típusú vektoros lekérdezést kértek.

  • A vektorizáló elvárja, hogy az eredményként kapott beágyazás a vectordata JSON-objektum kulcsában legyen a válasz hasznos adatában.

  • A végpont által visszaadott hibákat és figyelmeztetéseket a vektorizáló figyelmen kívül hagyja, és nem érhető el hibakeresési célokra a lekérdezési időpontban.

  • imageBinary Ha vektoros lekérdezést kértek, a végpontnak küldött kérelem hasznos adatai a következők:

    {
    "values": [
        {
            "recordId": "0",
            "data":
            {
                "imageBinary": {
                    "data": "<base 64 encoded image binary data>"
                }
            }
        }
    ]
}

Lásd még