Aracılığıyla paylaş

Özel Web API vektörleştiricisi

  • Makale

Özel web API vektörleştiricisi, arama sorgularınızı bir Web API uç noktasına çağrı yaparak sorgu zamanında eklemeler oluşturacak şekilde yapılandırmanıza olanak tanır. Sağlanan uç noktada uygulanması gereken JSON yükünün yapısı bu belgede daha aşağıda açıklanmıştır. Verileriniz, modelinizin dağıtıldığı Coğrafi bölgede işlenir.

Vektörleştiriciler sorgu zamanında kullanılır, ancak dizin tanımlarında belirtilir ve vektör alanlarında bir vektör profili aracılığıyla başvurulur. Özel web API vektörleştiricisi API'de çağrılır WebApiVectorizer .

  • 2024-07-01 REST API'sini veya özelliği sağlamak üzere güncelleştirilmiş bir Azure SDK paketini kullanın.

  • Arama dizinindevektörleştirici yapılandırma, kullanım yönergeleri sağlar.

Vektörleştirici parametreleri

Parametreler büyük/küçük harfe duyarlıdır.

Parametre adı Açıklama
uri JSON yükünün gönderildiği Web API'sinin URI'sini. Yalnızca https URI düzenine izin verilir.
httpMethod Yükü gönderirken kullanılacak yöntem. İzin verilen yöntemler veya'dır PUTPOST
httpHeaders Anahtarların üst bilgi adlarını, değerlerin de yüküyle birlikte Web API'nize gönderilen üst bilgi değerlerini temsil ettiği anahtar-değer çiftleri koleksiyonu. Aşağıdaki üst bilgilerin bu koleksiyonda olması yasaktır: , , , , , Content-Type, Cookie, Host, TEUpgrade, Via. Content-LengthAccept-EncodingAccept-CharsetAccept
authResourceId (İsteğe bağlı) Ayarlanırsa, bu vektörleştiricinin kodu barındıran işlev veya uygulama bağlantısında yönetilen kimlik kullanması gerektiğini belirten bir dize. Bu özellik, şu biçimlerden herhangi birinde bir uygulama (istemci) kimliği veya Uygulamanın Microsoft Entra Id kaydı alır: api://<appId>, <appId>/.default, api://<appId>/.default. Bu değer, dizin oluşturucu tarafından alınan kimlik doğrulama belirtecinin kapsamını daraltmak için kullanılır ve işleve veya uygulamaya özel Web API isteğiyle birlikte gönderilir. Bu özelliğin ayarlanması, arama hizmetinizin yönetilen kimlik için yapılandırılmasını ve Azure işlev uygulamanızın bir Microsoft Entra oturum açma işlemi için yapılandırılmasını gerektirir.
authIdentity (İsteğe bağlı) Arama hizmeti tarafından kodu barındıran işleve veya uygulamaya bağlanmak için kullanılan kullanıcı tarafından yönetilen kimlik. Sistem veya kullanıcı tarafından yönetilen kimlik kullanabilirsiniz. Sistem tarafından yönetilmemiş bir kimlik kullanmak için boş bırakın authIdentity .
timeout (İsteğe bağlı) Belirtildiğinde, API çağrısı yapan http istemcisinin zaman aşımını gösterir. XSD "dayTimeDuration" değeri (ISO 8601 süre değerinin kısıtlanmış bir alt kümesi) olarak biçimlendirilmelidir. Örneğin, PT60S 60 saniye için. Ayarlanmamışsa, varsayılan değer olarak 30 saniye seçilir. Zaman aşımı en fazla 230 saniye ve en az 1 saniye olarak ayarlanabilir.

Desteklenen vektör sorgu türleri

Özel Web API vektörleştiricisi , imageUrlve imageBinary vektör sorgularını desteklertext.

Örnek tanım

"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 yük yapısı

Özel web API vektörleştiricisi ile kullanırken uç nokta için beklenen gerekli JSON yük yapısı, özel web API'sinin beceri belgelerinde daha ayrıntılı olarak ele alınan beceriyle aynıdır.

Özel web API vektörleştiricisi ile kullanılacak bir web API'si uç noktası uygularken dikkat edilmesi gereken diğer noktalar aşağıda verilmiştir.

  • Vektörleştirici, uç noktaya istekte bulunurken dizide bir kerede values yalnızca bir kayıt gönderir.

  • Vektörleştirici, istek yükündeki JSON nesnesindeki belirli bir anahtarda data vektörleştirilecek verileri geçirir. Bu anahtar text, istenen vektör sorgusu türüne bağlı olarak , imageUrlveya imageBinaryşeklindedir.

  • Vektörleştirici, sonuçta elde edilen ekleme işleminin vector yanıt yükündeki JSON nesnesindeki data anahtarın altında olmasını bekler.

  • Uç nokta tarafından döndürülen hatalar veya uyarılar vektörleştirici tarafından yoksayılır ve sorgu zamanında hata ayıklama amacıyla alınamaz.

  • Bir imageBinary vektör sorgusu istendiyse uç noktaya gönderilen istek yükü aşağıdaki gibidir:

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

Ayrıca bkz.