Anpassad webb-API-vektoriserare

Med custom web API vectorizer kan du konfigurera sökfrågor för att anropa en webb-API-slutpunkt som genererar inbäddningar vid frågetillfället. Den nödvändiga JSON-nyttolaststrukturen för slutpunkten beskrivs senare i den här artikeln. Dina data bearbetas i geography där din modell distribueras.

Även om vektoriserare används vid frågetillfället anger du dem i indexdefinitioner och refererar till dem i vektorfält via en vektorprofil. Mer information finns i Konfigurera en vektoriserare i ett sökindex.

Den anpassade webb-API-vektoriseraren anropas WebApiVectorizer i REST-API:et. Använd den senaste stabila versionen av Indexes – Skapa (REST API) eller ett Azure SDKs-paket som tillhandahåller funktionen.

Vectorizer-parametrar

Parametrar är skiftlägeskänsliga.

Parameternamn beskrivning
uri URI:n för webb-API:et som JSON-nyttolasten skickas till. Endast https-URI-schemat tillåts.
httpMethod Den metod som används för att skicka nyttolasten. Tillåtna metoder är PUT eller POST.
httpHeaders En samling nyckel/värde-par där nycklar representerar rubriknamn och värden representerar huvudvärden som skickas till webb-API:et med nyttolasten. Följande rubriker är förbjudna i den här samlingen: Accept, Accept-Charset, Accept-Encoding, Content-Length, Content-Type, Cookie, , Host, TE, Upgrade, Via.
authResourceId (Valfritt) En sträng som, om den anges, anger att den här vektoriseraren använder en hanterad identitet för anslutningen till funktionen eller appen som är värd för koden. Den här egenskapen tar ett applikations-ID (klient-ID) eller appregistrering i Microsoft Entra ID i ett av följande format: api://<appId>, <appId>/.default, api://<appId>/.default. Det här värdet omfattar den autentiseringstoken som hämtas av frågepipelinen och skickas med den anpassade webb-API-begäran till funktionen eller appen. Om du anger den här egenskapen måste din söktjänst vara konfigurerad för hanterad identitet och din Azure-funktionsapp vara konfigurerad för Microsoft Entra-inloggning.
authIdentity (Valfritt) En användarhanterad identitet som används av search service för att ansluta till funktionen eller appen som är värd för koden. Du kan använda antingen en systemhanterad eller användarhanterad identitet. Lämna authIdentity tom om du vill använda en systemhanterad identitet.
timeout (Valfritt) Tidsgränsen för HTTP-klienten som gör API-anropet. Det måste formateras som ett XSD-värde dayTimeDuration (en begränsad delmängd av ett ISO 8601-varaktighetsvärde ). Det innebär till exempel PT60S 60 sekunder. Om det inte anges är standardvärdet 30 sekunder. Tidsgränsen kan vara mellan 1 och 230 sekunder.

Frågetyper för vektorer som stöds

Custom Web API-vektoriseraren stöder text, imageUrloch imageBinary vektorfrågor.

Exempeldefinition

"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-nyttolaststruktur

Den nödvändiga JSON-nyttolaststrukturen för en slutpunkt som används med Custom Web API-vektoriseraren är densamma som den struktur som används av den anpassade webb-API-färdigheten, som beskrivs mer detaljerat i kunskapsdokumentationen.

Tänk på följande när du implementerar en webb-API-slutpunkt för den anpassade webb-API-vektoriseraren.

  • Vektoriseraren skickar bara en post i taget i matrisen values när en begäran skickas till slutpunkten.

  • Vektoriseraren skickar data som ska vektoriseras i en specifik nyckel i data JSON-objektet i nyttolasten för begäran. Nyckeln är text, imageUrl, eller imageBinary, beroende på vilken typ av vektorfråga som begärdes.

  • Vektoriseraren förväntar sig att den resulterande inbäddningen ska vara under vector nyckeln i data JSON-objektet i svarsnyttolasten.

  • Eventuella fel eller varningar som returneras av slutpunkten ignoreras av vektorisatorn och är inte tillgängliga för felsökning under frågans tidpunkt.

  • Om en imageBinary vektorfråga har gjorts är nyttolasten som skickas till slutpunkten följande:

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

Se även

  • Last updated on