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.

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": "<your-header-value>"
            },
            "timeout": "PT60S",
            "authResourceId": null,
            "authIdentity": null
        }
    }
]

Uppdatera sidhuvudvärden efter GET

När du hämtar en indexdefinition returnerar tjänsten sentinel <redacted> för varje httpHeaders värde i en anpassad webb-API-vektoriserare. Ett exempel:

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

Om du vill återanvända det lagrade api-key värdet uppdaterar du samma befintliga vektoriserare med samma name och kindlämnar dess uri oförändrade och lägger till sentinel igen för det matchande rubriknamnet:

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

Med en oförändrad urikan du blanda <redacted> för behållna rubrikvärden med faktiska ersättningsvärden för andra befintliga rubriker. Ange ett faktiskt värde för varje sidhuvud som har lagts till eller bytt namn eftersom sentinel endast gäller för ett befintligt huvud med samma namn på samma vektoriserare.

Om du ändrar urianger du faktiska värden för varje httpHeaders post i samma uppdatering. Tjänsten återanvänder inte lagrade värden för en annan uri:

{
    "name": "my-custom-web-api-vectorizer",
    "kind": "customWebApi",
    "customWebApiParameters": {
        "uri": "https://new.contoso.embeddings.com",
        "httpMethod": "POST",
        "httpHeaders": {
            "api-key": "<new-header-value>"
        },
        "timeout": "PT60S",
        "authResourceId": null,
        "authIdentity": null
    }
}

Om autentiseringsuppgifterna inte är tillgängliga och du måste ändra uriroterar eller återskapar du dem på den externa slutpunkten. Skicka sedan de nya uri värdena och huvudvärdena tillsammans.

Värdet <redacted> är en tjänst sentinel, inte en autentiseringsuppgift. Det går inte att skapa en vektoriserare eller hämta eller återanvända ett rubrikvärde som lagras för en annan vektoriserare.

JSON-nyttolaststruktur

Den obligatoriska strukturen för JSON-nyttolasten för en slutpunkt som används tillsammans med Custom Web API-vektoriseraren är densamma som den struktur som används av Custom Web API-skill. Mer information finns i kunskapsdokumentationen.

Tänk på följande när du implementerar en webb-API-slutpunkt för Custom Web 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.

• Vektoriseraren ignorerar eventuella fel eller varningar som returneras av slutpunkten. Dessa fel och varningar är inte tillgängliga för felsökning av frågetid.

• 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

• Integrerad vektorisering
• Så här konfigurerar du en vektoriserare i ett sökindex
• Anpassad webb-API-färdighet