Vlastní vektorizátor webového rozhraní API

Vektorizátor Custom Web API umožňuje konfigurovat vyhledávací dotazy pro volání endpointu webového rozhraní API, který generuje embeddingy v době dotazu. Požadovaná struktura datové části JSON pro koncový bod je popsaná dále v tomto článku. Vaše data se zpracovávají v geografii kde je váš model nasazený.

I když se vektorizátory používají v době dotazu, zadáte je v definicích indexu a odkazujete na ně na vektorová pole prostřednictvím vektorového profilu. Další informace naleznete v tématu Konfigurace vektorizátoru v indexu vyhledávání.

Vlastní vektorizátor webového rozhraní API se volá WebApiVectorizer v rozhraní REST API. Použijte nejnovější stabilní verzi Indexes – Create (REST API) nebo balíček sady AZURE SDK, který tuto funkci poskytuje.

Parametry vektorizátoru

Parametry jsou citlivé na velikost písmen.

Podporované typy vektorových dotazů

Vektorizátor vlastního webového rozhraní API podporuje text, imageUrl a imageBinary vektorové dotazy.

Ukázková definice

"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
        }
    }
]

Aktualizace hodnot hlaviček po příkazu GET

Když načtete definici indexu, vrátí služba sentinel <redacted> pro každou httpHeaders hodnotu vektorizátoru vlastního webového rozhraní API. Příklady:

{
    "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
    }
}

Pokud chcete uloženou api-key hodnotu znovu použít, aktualizujte stejný existující vektorizátor stejným name způsobem a kindponechte ho uri beze změny a znovu odešlete sentinel pro odpovídající název hlavičky:

{
    "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
    }
}

Beze změny urimůžete pro zachování hodnot záhlaví kombinovat <redacted> se skutečnými náhradními hodnotami pro ostatní existující hlavičky. Zadejte skutečnou hodnotu pro každou přidanou nebo přejmenovanou hlavičku, protože sentinel se vztahuje pouze na existující hlavičku se stejným názvem na stejném vektorizátoru.

Pokud změníte urihodnotu , zadejte skutečné hodnoty pro každou httpHeaders položku ve stejné aktualizaci. Služba opakovaně nepoužívá uložené hodnoty pro jinou 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
    }
}

Pokud jsou přihlašovací údaje nedostupné a musíte je změnit uri, otočte je nebo znovu vygenerujte na externím koncovém bodu. Pak společně odešlete nové uri hodnoty a hodnoty záhlaví.

Hodnota <redacted> je služba sentinel, nikoli přihlašovací údaje. Nemůže vytvořit vektorizátor ani načíst nebo znovu použít hodnotu hlavičky uloženou pro jiný vektorizátor.

Struktura datové části JSON

Požadovaná struktura datové části JSON pro koncový bod použitý s vektorizátorem vlastního webového rozhraní API je stejná jako struktura používaná dovedností vlastního webového rozhraní API. Další informace najdete v dokumentaci ke dovednostem.

Při implementaci koncového bodu webového rozhraní API pro vektorizátor vlastního webového rozhraní API mějte na paměti následující skutečnosti:

• Vektorizátor odesílá v poli values pouze jeden záznam najednou při požadavku na koncový bod.

• Vektorizátor předává data, která se mají vektorizovat v určitém klíči objektu data JSON v datové části požadavku. Tento klíč je text, imageUrlnebo imageBinary, v závislosti na typu vektorového dotazu byl požadován.

• Vektorizátor očekává, že výsledné vkládání bude pod vector klíčem v objektu data JSON v datové části odpovědi.

• Vektorizátor ignoruje všechny chyby nebo upozornění vrácené koncovým bodem. Tyto chyby a upozornění nejsou k dispozici pro ladění v době dotazu.

• Pokud byl požadován vektorový imageBinary dotaz, datová část požadavku odeslaná do koncového bodu je následující:

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

Viz také

• Integrovaná vektorizace
• Postup konfigurace vektorizátoru v indexu vyhledávání
• Vlastní dovednosti webového rozhraní API